Interface EntityTypeOrBuilder (0.58.0) 

public interface EntityTypeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoExpansionMode()

public abstract EntityType.AutoExpansionMode getAutoExpansionMode()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
EntityType.AutoExpansionMode

The autoExpansionMode.

getAutoExpansionModeValue()

public abstract int getAutoExpansionModeValue()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
int

The enum numeric value on the wire for autoExpansionMode.

getDisplayName()

public abstract 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
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract 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
Type Description
ByteString

The bytes for displayName.

getEnableFuzzyExtraction()

public abstract boolean getEnableFuzzyExtraction()

Enables fuzzy entity extraction during classification.

bool enable_fuzzy_extraction = 7;

Returns
Type Description
boolean

The enableFuzzyExtraction.

getEntities(int index)

public abstract EntityType.Entity getEntities(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Entity

getEntitiesCount()

public abstract int getEntitiesCount()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Returns
Type Description
int

getEntitiesList()

public abstract List<EntityType.Entity> getEntitiesList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Returns
Type Description
List<Entity>

getEntitiesOrBuilder(int index)

public abstract EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.EntityOrBuilder

getEntitiesOrBuilderList()

public abstract List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.EntityType.EntityOrBuilder>

getExcludedPhrases(int index)

public abstract 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.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhrase

getExcludedPhrasesCount()

public abstract 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.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
int

getExcludedPhrasesList()

public abstract 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.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<ExcludedPhrase>

getExcludedPhrasesOrBuilder(int index)

public abstract 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.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhraseOrBuilder

getExcludedPhrasesOrBuilderList()

public abstract 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.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhraseOrBuilder>

getKind()

public abstract EntityType.Kind getKind()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityType.Kind

The kind.

getKindValue()

public abstract int getKindValue()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for kind.

getName()

public abstract String getName()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getRedact()

public abstract 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 when logging.

bool redact = 9;

Returns
Type Description
boolean

The redact.