Package com.ibm.watson.discovery.v1.model

Class Enrichment

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.discovery.v1.model.Enrichment
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class Enrichment
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Enrichment step to perform on the document. Each enrichment is performed on the specified field in the order that they are listed in the configuration.

  • Method Details

    • newBuilder

      public Enrichment.Builder newBuilder()
      New builder.
      Returns:
      a Enrichment builder

    • description

      public String description()
      Gets the description.

      Describes what the enrichment step does.

      Returns:
      the description

    • destinationField

      public String destinationField()
      Gets the destinationField.

      Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but `text.foo.bar` is not.

      Returns:
      the destinationField

    • sourceField

      public String sourceField()
      Gets the sourceField.

      Field to be enriched.

      Arrays can be specified as the **source_field** if the **enrichment** service for this enrichment is set to `natural_language_undstanding`.

      Returns:
      the sourceField

    • overwrite

      public Boolean overwrite()
      Gets the overwrite.

      Indicates that the enrichments will overwrite the destination_field field if it already exists.

      Returns:
      the overwrite

    • enrichment

      public String enrichment()
      Gets the enrichment.

      Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`.

      When using `natual_language_understanding`, the **options** object must contain Natural Language Understanding options.

      When using `elements` the **options** object must contain Element Classification options. Additionally, when using the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in [the documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification).

      Returns:
      the enrichment

    • ignoreDownstreamErrors

      public Boolean ignoreDownstreamErrors()
      Gets the ignoreDownstreamErrors.

      If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

      Returns:
      the ignoreDownstreamErrors

    • options

      public EnrichmentOptions options()
      Gets the options.

      Options which are specific to a particular enrichment.

      Returns:
      the options