Package com.ibm.watson.assistant.v1.model

Class RuntimeEntity

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.assistant.v1.model.RuntimeEntity
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class RuntimeEntity
extends com.ibm.cloud.sdk.core.service.model.GenericModel
A term from the request that was identified as an entity.

  • Method Details

    • newBuilder

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

    • entity

      public String entity()
      Gets the entity.

      An entity detected in the input.

      Returns:
      the entity

    • location

      public List<Long> location()
      Gets the location.

      An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

      Returns:
      the location

    • value

      public String value()
      Gets the value.

      The entity value that was recognized in the user input.

      Returns:
      the value

    • confidence

      public Double confidence()
      Gets the confidence.

      A decimal percentage that represents Watson's confidence in the recognized entity.

      Returns:
      the confidence

    • metadata

      public Map<String,​Object> metadata()
      Gets the metadata.

      **Deprecated.** Any metadata for the entity.

      Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information about system entities recognized in the user input, see the `interpretation` property.

      Returns:
      the metadata

    • groups

      public List<CaptureGroup> groups()
      Gets the groups.

      The recognized capture groups for the entity, as defined by the entity pattern.

      Returns:
      the groups

    • interpretation

      public RuntimeEntityInterpretation interpretation()
      Gets the interpretation.

      An object containing detailed information about the entity recognized in the user input.

      For more information about how system entities are interpreted, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-system-entities).

      Returns:
      the interpretation

    • alternatives

      public List<RuntimeEntityAlternative> alternatives()
      Gets the alternatives.

      An array of possible alternative values that the user might have intended instead of the value returned in the **value** property. This property is returned only for `@sys-time` and `@sys-date` entities when the user's input is ambiguous.

      This property is included only if the new system entities are enabled for the workspace.

      Returns:
      the alternatives

    • role

      public RuntimeEntityRole role()
      Gets the role.

      An object describing the role played by a system entity that is specifies the beginning or end of a range recognized in the user input. This property is included only if the new system entities are enabled for the workspace.

      Returns:
      the role