com.ibm.watson.discovery.v2.model

Class CreateEnrichment

java.lang.Object

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

com.ibm.watson.discovery.v2.model.CreateEnrichment

All Implemented Interfaces:

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

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

Information about a specific enrichment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateEnrichment.Builder Builder.
static interface	CreateEnrichment.Type The type of this enrichment.

Method Summary

Modifier and Type	Method and Description
String	description() Gets the description.
String	name() Gets the name.
CreateEnrichment.Builder	newBuilder() New builder.
EnrichmentOptions	options() Gets the options.
String	type() Gets the type.

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

New builder.

Returns:

a CreateEnrichment builder

name

public String name()

Gets the name.

The human readable name for this enrichment.

Returns:

the name

description

public String description()

Gets the description.

The description of this enrichment.

Returns:

the description

type

public String type()

Gets the type.

The type of this enrichment. The following types are supported:

* `classifier`: Creates a document classifier enrichment from a document classifier model that you create by using the [Document classifier API](/apidocs/discovery-data#createdocumentclassifier). **Note**: A text classifier enrichment can be created only from the product user interface.

* `dictionary`: Creates a custom dictionary enrichment that you define in a CSV file.

* `regular_expression`: Creates a custom regular expression enrichment from regex syntax that you specify in the request.

* `rule_based`: Creates an enrichment from an advanced rules model that is created and exported as a ZIP file from Watson Knowledge Studio.

* `uima_annotator`: Creates an enrichment from a custom UIMA text analysis model that is defined in a PEAR file created in one of the following ways:

* Watson Explorer Content Analytics Studio. **Note**: Supported in IBM Cloud Pak for Data instances only.

* Rule-based model that is created in Watson Knowledge Studio.

* `watson_knowledge_studio_model`: Creates an enrichment from a Watson Knowledge Studio machine learning model that is defined in a ZIP file.

* `webhook`: Connects to an external enrichment application by using a webhook. The feature is available from IBM Cloud-managed instances only. The external enrichment feature is beta functionality. Beta features are not supported by the SDKs.

* `sentence_classifier`: Use sentence classifier to classify sentences in your documents. This feature is available in IBM Cloud-managed instances only. The sentence classifier feature is beta functionality. Beta features are not supported by the SDKs.

Returns:

the type

options

public EnrichmentOptions options()

Gets the options.

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.

Returns:

the options