Class NluEnrichmentEntities

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.discovery.v1.model.NluEnrichmentEntities
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel

public class NluEnrichmentEntities
extends com.ibm.cloud.sdk.core.service.model.GenericModel
An object speficying the Entities enrichment and related parameters.
  • Method Details

    • newBuilder

      public NluEnrichmentEntities.Builder newBuilder()
      New builder.
      Returns:
      a NluEnrichmentEntities builder
    • sentiment

      public Boolean sentiment()
      Gets the sentiment.

      When `true`, sentiment analysis of entities will be performed on the specified field.

      Returns:
      the sentiment
    • emotion

      public Boolean emotion()
      Gets the emotion.

      When `true`, emotion detection of entities will be performed on the specified field.

      Returns:
      the emotion
    • limit

      public Long limit()
      Gets the limit.

      The maximum number of entities to extract for each instance of the specified field.

      Returns:
      the limit
    • mentions

      public Boolean mentions()
      Gets the mentions.

      When `true`, the number of mentions of each identified entity is recorded. The default is `false`.

      Returns:
      the mentions
    • mentionTypes

      public Boolean mentionTypes()
      Gets the mentionTypes.

      When `true`, the types of mentions for each idetifieid entity is recorded. The default is `false`.

      Returns:
      the mentionTypes
    • sentenceLocations

      public Boolean sentenceLocations()
      Gets the sentenceLocations.

      When `true`, a list of sentence locations for each instance of each identified entity is recorded. The default is `false`.

      Returns:
      the sentenceLocations
    • model

      public String model()
      Gets the model.

      The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, or the default public model `alchemy`.

      Returns:
      the model