Google Cloud Dialogflow Cx V3 Client - Class EntityType (0.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class EntityType.

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on. There are three types of entities:

System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.
Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.
User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type. For more information about entity types, see the Dialogflow documentation.

Generated from protobuf message google.cloud.dialogflow.cx.v3.EntityType

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
`↳ display_name`	`string` Required. The human-readable name of the entity type, unique within the agent.
`↳ kind`	`int` Required. Indicates the kind of entity type.
`↳ auto_expansion_mode`	`int` Indicates whether the entity type can be automatically expanded.
`↳ entities`	`array<EntityType\Entity>` The collection of entity entries associated with the entity type.
`↳ excluded_phrases`	`array<EntityType\ExcludedPhrase>` 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.
`↳ enable_fuzzy_extraction`	`bool` Enables fuzzy entity extraction during classification.
`↳ redact`	`bool` 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.

getName

The unique identifier of the entity type.

Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

Returns
Type	Description
`string`

setName

The unique identifier of the entity type.

Required for EntityTypes.UpdateEntityType. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. The human-readable name of the entity type, unique within the agent.

Returns
Type	Description
`string`

setDisplayName

Required. The human-readable name of the entity type, unique within the agent.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKind

Required. Indicates the kind of entity type.

Returns
Type	Description
`int`

setKind

Required. Indicates the kind of entity type.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAutoExpansionMode

Indicates whether the entity type can be automatically expanded.

Returns
Type	Description
`int`

setAutoExpansionMode

Indicates whether the entity type can be automatically expanded.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEntities

The collection of entity entries associated with the entity type.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setEntities

The collection of entity entries associated with the entity type.

Parameter
Name	Description
`var`	`array<EntityType\Entity>`

Returns
Type	Description
`$this`

getExcludedPhrases

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setExcludedPhrases

Collection of exceptional words and phrases that shouldn't be matched.

Parameter
Name	Description
`var`	`array<EntityType\ExcludedPhrase>`

Returns
Type	Description
`$this`

getEnableFuzzyExtraction

Enables fuzzy entity extraction during classification.

Returns
Type	Description
`bool`

setEnableFuzzyExtraction

Enables fuzzy entity extraction during classification.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`bool`

setRedact

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`