com.ibm.watson.discovery.v2.model

Class EnrichmentOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.EnrichmentOptions

All Implemented Interfaces:

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

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

An object that contains options for the current enrichment. Starting with version `2020-08-30`, the enrichment options are not included in responses from the List Enrichments method.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	classifierId() Gets the classifierId.
Double	confidenceThreshold() Gets the confidenceThreshold.
String	entityType() Gets the entityType.
WebhookHeader	headers() Gets the headers.
List<String>	languages() Gets the languages.
String	locationEncoding() Gets the locationEncoding.
String	modelId() Gets the modelId.
EnrichmentOptions.Builder	newBuilder() New builder.
String	regularExpression() Gets the regularExpression.
String	resultField() Gets the resultField.
String	secret() Gets the secret.
Long	topK() Gets the topK.
String	url() Gets the url.
String	version() Gets the version.

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 EnrichmentOptions.Builder newBuilder()

New builder.

Returns:

a EnrichmentOptions builder

languages

public List<String> languages()

Gets the languages.

An array of supported languages for this enrichment. When creating an enrichment, only specify a language that is used by the model or in the dictionary. Required when **type** is `dictionary`. Optional when **type** is `rule_based`. Not valid when creating any other type of enrichment.

Returns:

the languages

entityType

public String entityType()

Gets the entityType.

The name of the entity type. This value is used as the field name in the index. Required when **type** is `dictionary` or `regular_expression`. Not valid when creating any other type of enrichment.

Returns:

the entityType

regularExpression

public String regularExpression()

Gets the regularExpression.

The regular expression to apply for this enrichment. Required when **type** is `regular_expression`. Not valid when creating any other type of enrichment.

Returns:

the regularExpression

resultField

public String resultField()

Gets the resultField.

The name of the result document field that this enrichment creates. Required when **type** is `rule_based` or `classifier`. Not valid when creating any other type of enrichment.

Returns:

the resultField

classifierId

public String classifierId()

Gets the classifierId.

A unique identifier of the document classifier. Required when **type** is `classifier`. Not valid when creating any other type of enrichment.

Returns:

the classifierId

modelId

public String modelId()

Gets the modelId.

A unique identifier of the document classifier model. Required when **type** is `classifier`. Not valid when creating any other type of enrichment.

Returns:

the modelId

confidenceThreshold

public Double confidenceThreshold()

Gets the confidenceThreshold.

Specifies a threshold. Only classes with evaluation confidence scores that are higher than the specified threshold are included in the output. Optional when **type** is `classifier`. Not valid when creating any other type of enrichment.

Returns:

the confidenceThreshold

topK

public Long topK()

Gets the topK.

Evaluates only the classes that fall in the top set of results when ranked by confidence. For example, if set to `5`, then the top five classes for each document are evaluated. If set to 0, the **confidence_threshold** is used to determine the predicted classes. Optional when **type** is `classifier`. Not valid when creating any other type of enrichment.

Returns:

the topK

url

public String url()

Gets the url.

A URL that uses the SSL protocol (begins with https) for the webhook. Required when type is `webhook`. Not valid when creating any other type of enrichment.

Returns:

the url

version

public String version()

Gets the version.

The Discovery API version that allows to distinguish the schema. The version is specified in the `yyyy-mm-dd` format. Optional when `type` is `webhook`. Not valid when creating any other type of enrichment.

Returns:

the version

secret

public String secret()

Gets the secret.

A private key can be included in the request to authenticate with the external service. The maximum length is 1,024 characters. Optional when `type` is `webhook`. Not valid when creating any other type of enrichment.

Returns:

the secret

headers

public WebhookHeader headers()

Gets the headers.

An array of headers to pass with the HTTP request. Optional when `type` is `webhook`. Not valid when creating any other type of enrichment.

Returns:

the headers

locationEncoding

public String locationEncoding()

Gets the locationEncoding.

Discovery calculates offsets of the text's location with this encoding type in documents. Use the same location encoding type in both Discovery and external enrichment for a document.

These encoding types are supported: `utf-8`, `utf-16`, and `utf-32`. Optional when `type` is `webhook`. Not valid when creating any other type of enrichment.

Returns:

the locationEncoding