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 theEntityTypetype.
Custom- entities that are defined by you that represent
actionable data that is meaningful to your application. For example,
you could define apizza.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 theSessionEntityTypetype.
For more information about entity types, see theDialogflow
documentation.
Generated from protobuf messagegoogle.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 forEntityTypes.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.
Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entrygiant(an adjective), you might consider addinggiants(a noun) as an exclusion. If the kind of entity type isKIND_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.
Collection of exceptional words and phrases that shouldn't be matched.
For example, if you have a size entity type with entrygiant(an
adjective), you might consider addinggiants(a noun) as an exclusion.
If the kind of entity type isKIND_MAP, then the phrases specified by
entities and excluded phrases should be mutually exclusive.
Collection of exceptional words and phrases that shouldn't be matched.
For example, if you have a size entity type with entrygiant(an
adjective), you might consider addinggiants(a noun) as an exclusion.
If the kind of entity type isKIND_MAP, then the phrases specified by
entities and excluded phrases should be mutually exclusive.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow Cx V3 Client - Class EntityType (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.EntityType)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.EntityType)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.EntityType)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.EntityType)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.EntityType)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.EntityType)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.EntityType)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.EntityType)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.EntityType) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class EntityType.\n\nEntities are extracted from user input and represent parameters that are\nmeaningful to your application. For example, a date range, a proper name\nsuch as a geographic location or landmark, and so on. Entities represent\nactionable data for your application.\n\nWhen you define an entity, you can also include synonyms that all map to\nthat entity. For example, \"soft drink\", \"soda\", \"pop\", and so on.\nThere are three types of entities:\n\n- **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.\n- **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.\n- **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](/php/docs/reference/cloud-dialogflow-cx/latest/V3.SessionEntityType) type. For more information about entity types, see the [Dialogflow\n documentation](https://cloud.google.com/dialogflow/docs/entities-overview).\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.EntityType`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique identifier of the entity type.\n\nRequired for\n[EntityTypes.UpdateEntityType](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.EntityTypesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_EntityTypesClient__updateEntityType__).\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/entityTypes/\u003cEntityTypeID\u003e`.\n\n### setName\n\nThe unique identifier of the entity type.\n\nRequired for\n[EntityTypes.UpdateEntityType](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.EntityTypesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_EntityTypesClient__updateEntityType__).\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/entityTypes/\u003cEntityTypeID\u003e`.\n\n### getDisplayName\n\nRequired. The human-readable name of the entity type, unique within the\nagent.\n\n### setDisplayName\n\nRequired. The human-readable name of the entity type, unique within the\nagent.\n\n### getKind\n\nRequired. Indicates the kind of entity type.\n\n### setKind\n\nRequired. Indicates the kind of entity type.\n\n### getAutoExpansionMode\n\nIndicates whether the entity type can be automatically expanded.\n\n### setAutoExpansionMode\n\nIndicates whether the entity type can be automatically expanded.\n\n### getEntities\n\nThe collection of entity entries associated with the entity type.\n\n### setEntities\n\nThe collection of entity entries associated with the entity type.\n\n### getExcludedPhrases\n\nCollection of exceptional words and phrases that shouldn't be matched.\n\nFor example, if you have a size entity type with entry `giant`(an\nadjective), you might consider adding `giants`(a noun) as an exclusion.\nIf the kind of entity type is `KIND_MAP`, then the phrases specified by\nentities and excluded phrases should be mutually exclusive.\n\n### setExcludedPhrases\n\nCollection of exceptional words and phrases that shouldn't be matched.\n\nFor example, if you have a size entity type with entry `giant`(an\nadjective), you might consider adding `giants`(a noun) as an exclusion.\nIf the kind of entity type is `KIND_MAP`, then the phrases specified by\nentities and excluded phrases should be mutually exclusive.\n\n### getEnableFuzzyExtraction\n\nEnables fuzzy entity extraction during classification.\n\n### setEnableFuzzyExtraction\n\nEnables fuzzy entity extraction during classification.\n\n### getRedact\n\nIndicates whether parameters of the entity type should be redacted in log.\n\nIf redaction is enabled, page parameters and intent parameters referring to\nthe entity type will be replaced by parameter name when logging.\n\n### setRedact\n\nIndicates whether parameters of the entity type should be redacted in log.\n\nIf redaction is enabled, page parameters and intent parameters referring to\nthe entity type will be replaced by parameter name when logging."]]
