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
EntityTypetype. - Custom- entities that are defined by you that represent
actionable data that is meaningful to your application. For example,
you could define a
pizza.sauceentity for red or white pizza sauce, apizza.cheeseentity for the different types of cheese on a pizza, apizza.toppingentity for different toppings, and so on. A custom entity is represented by theEntityTypetype. - 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 \ V3Methods
__construct
Constructor.
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
↳ 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>
.
string
setName
The unique identifier of the entity type.
Required for EntityTypes.UpdateEntityType
.
Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>
.
var
string
$this
getDisplayName
Required. The human-readable name of the entity type, unique within the agent.
string
setDisplayName
Required. The human-readable name of the entity type, unique within the agent.
var
string
$this
getKind
Required. Indicates the kind of entity type.
int
setKind
Required. Indicates the kind of entity type.
var
int
$this
getAutoExpansionMode
Indicates whether the entity type can be automatically expanded.
int
setAutoExpansionMode
Indicates whether the entity type can be automatically expanded.
var
int
$this
getEntities
The collection of entity entries associated with the entity type.
setEntities
The collection of entity entries associated with the entity type.
$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.
setExcludedPhrases
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.
$this
getEnableFuzzyExtraction
Enables fuzzy entity extraction during classification.
bool
setEnableFuzzyExtraction
Enables fuzzy entity extraction during classification.
var
bool
$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.
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.
var
bool
$this
