public class EnrichmentOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
EnrichmentOptions.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
String |
classifierId()
Gets the classifierId.
|
Double |
confidenceThreshold()
Gets the confidenceThreshold.
|
String |
entityType()
Gets the entityType.
|
List<String> |
languages()
Gets the languages.
|
String |
modelId()
Gets the modelId.
|
EnrichmentOptions.Builder |
newBuilder()
New builder.
|
String |
regularExpression()
Gets the regularExpression.
|
String |
resultField()
Gets the resultField.
|
Long |
topK()
Gets the topK.
|
public EnrichmentOptions.Builder newBuilder()
public List<String> 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.
public String 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.
public String regularExpression()
The regular expression to apply for this enrichment. Required when **type** is `regular_expression`. Not valid when creating any other type of enrichment.
public String 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.
public String classifierId()
A unique identifier of the document classifier. Required when **type** is `classifier`. Not valid when creating any other type of enrichment.
public String modelId()
A unique identifier of the document classifier model. Required when **type** is `classifier`. Not valid when creating any other type of enrichment.
public Double 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.
public Long 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.
Copyright © 2023 IBM Cloud. All rights reserved.