Package com.google.cloud.dialogflow.cx.v3beta1

Interface EntityTypeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EntityType, EntityType.Builder
@Generated public interface EntityTypeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The unique identifier of the entity type.
 Required for
 [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3beta1.EntityTypes.UpdateEntityType].
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The unique identifier of the entity type.
 Required for
 [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3beta1.EntityTypes.UpdateEntityType].
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The human-readable name of the entity type, unique within the
 agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The human-readable name of the entity type, unique within the
 agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • getKindValue

      int getKindValue()
       Required. Indicates the kind of entity type.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for kind.

    • getKind

      EntityType.Kind getKind()
       Required. Indicates the kind of entity type.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The kind.

    • getAutoExpansionModeValue

      int getAutoExpansionModeValue()
       Indicates whether the entity type can be automatically expanded.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;
      Returns:
      The enum numeric value on the wire for autoExpansionMode.

    • getAutoExpansionMode

      EntityType.AutoExpansionMode getAutoExpansionMode()
       Indicates whether the entity type can be automatically expanded.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;
      Returns:
      The autoExpansionMode.

    • getEntitiesList

      List<EntityType.Entity> getEntitiesList()
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

    • getEntities

      EntityType.Entity getEntities(int index)
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

    • getEntitiesCount

      int getEntitiesCount()
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

    • getEntitiesOrBuilderList

      List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

    • getEntitiesOrBuilder

      EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;

    • getExcludedPhrasesList

      List<EntityType.ExcludedPhrase> getExcludedPhrasesList()
       Collection of exceptional words and phrases that shouldn't be matched.
 For example, if you have a size entity type with entry `giant`(an
 adjective), you might consider adding `giants`(a noun) as an exclusion.
 If the kind of entity type is `KIND_MAP`, then the phrases specified by
 entities and excluded phrases should be mutually exclusive.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

    • getExcludedPhrases

      EntityType.ExcludedPhrase getExcludedPhrases(int index)
       Collection of exceptional words and phrases that shouldn't be matched.
 For example, if you have a size entity type with entry `giant`(an
 adjective), you might consider adding `giants`(a noun) as an exclusion.
 If the kind of entity type is `KIND_MAP`, then the phrases specified by
 entities and excluded phrases should be mutually exclusive.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

    • getExcludedPhrasesCount

      int getExcludedPhrasesCount()
       Collection of exceptional words and phrases that shouldn't be matched.
 For example, if you have a size entity type with entry `giant`(an
 adjective), you might consider adding `giants`(a noun) as an exclusion.
 If the kind of entity type is `KIND_MAP`, then the phrases specified by
 entities and excluded phrases should be mutually exclusive.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

    • getExcludedPhrasesOrBuilderList

      List<? extends EntityType.ExcludedPhraseOrBuilder> getExcludedPhrasesOrBuilderList()
       Collection of exceptional words and phrases that shouldn't be matched.
 For example, if you have a size entity type with entry `giant`(an
 adjective), you might consider adding `giants`(a noun) as an exclusion.
 If the kind of entity type is `KIND_MAP`, then the phrases specified by
 entities and excluded phrases should be mutually exclusive.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

    • getExcludedPhrasesOrBuilder

      EntityType.ExcludedPhraseOrBuilder getExcludedPhrasesOrBuilder(int index)
       Collection of exceptional words and phrases that shouldn't be matched.
 For example, if you have a size entity type with entry `giant`(an
 adjective), you might consider adding `giants`(a noun) as an exclusion.
 If the kind of entity type is `KIND_MAP`, then the phrases specified by
 entities and excluded phrases should be mutually exclusive.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;

    • getEnableFuzzyExtraction

      boolean getEnableFuzzyExtraction()
       Enables fuzzy entity extraction during classification.
      bool enable_fuzzy_extraction = 7;
      Returns:
      The enableFuzzyExtraction.

    • getRedact

      boolean getRedact()
       Indicates whether parameters of the entity type should be redacted in log.
 If redaction is enabled, page parameters and intent parameters referring to
 the entity type will be replaced by parameter name during logging.
      bool redact = 9;
      Returns:
      The redact.