com.ibm.watson.assistant.v2.model

Class SearchSettingsDiscovery

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v2.model.SearchSettingsDiscovery

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SearchSettingsDiscovery
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Configuration settings for the Watson Discovery service instance used by the search integration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchSettingsDiscovery.Builder Builder.

Method Summary

Modifier and Type	Method and Description
SearchSettingsDiscoveryAuthentication	authentication() Gets the authentication.
Double	confidenceThreshold() Gets the confidenceThreshold.
Boolean	findAnswers() Gets the findAnswers.
Boolean	highlight() Gets the highlight.
String	instanceId() Gets the instanceId.
Long	maxPrimaryResults() Gets the maxPrimaryResults.
Long	maxTotalResults() Gets the maxTotalResults.
SearchSettingsDiscovery.Builder	newBuilder() New builder.
String	projectId() Gets the projectId.
String	url() Gets the url.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public SearchSettingsDiscovery.Builder newBuilder()

New builder.

Returns:

a SearchSettingsDiscovery builder

instanceId

public String instanceId()

Gets the instanceId.

The ID for the Watson Discovery service instance.

Returns:

the instanceId

projectId

public String projectId()

Gets the projectId.

The ID for the Watson Discovery project.

Returns:

the projectId

url

public String url()

Gets the url.

The URL for the Watson Discovery service instance.

Returns:

the url

maxPrimaryResults

public Long maxPrimaryResults()

Gets the maxPrimaryResults.

The maximum number of primary results to include in the response.

Returns:

the maxPrimaryResults

maxTotalResults

public Long maxTotalResults()

Gets the maxTotalResults.

The maximum total number of primary and additional results to include in the response.

Returns:

the maxTotalResults

confidenceThreshold

public Double confidenceThreshold()

Gets the confidenceThreshold.

The minimum confidence threshold for included results. Any results with a confidence below this threshold will be discarded.

Returns:

the confidenceThreshold

highlight

public Boolean highlight()

Gets the highlight.

Whether to include the most relevant passages of text in the **highlight** property of each result.

Returns:

the highlight

findAnswers

public Boolean findAnswers()

Gets the findAnswers.

Whether to use the answer finding feature to emphasize answers within highlighted passages. This property is ignored if **highlight**=`false`.

**Notes:** - Answer finding is available only if the search skill is connected to a Discovery v2 service instance. - Answer finding is not supported on IBM Cloud Pak for Data.

Returns:

the findAnswers

authentication

public SearchSettingsDiscoveryAuthentication authentication()

Gets the authentication.

Authentication information for the Watson Discovery service. For more information, see the [Watson Discovery documentation](https://cloud.ibm.com/apidocs/discovery-data#authentication).

**Note:** You must specify either **basic** or **bearer**, but not both.

Returns:

the authentication