Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class Entity.
Anentity entryfor an associated entity type.
Generated from protobuf messagegoogle.cloud.dialogflow.v2.EntityType.Entity
Namespace
Google \ Cloud \ Dialogflow \ V2 \ EntityType
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ value
string
Required. The primary value associated with this entity entry. For example, if the entity type isvegetable, the value could bescallions. ForKIND_MAPentity types: * * A reference value to be used in place of synonyms. ForKIND_LISTentity types: * * A string that can contain references to other entity types (with or without aliases).
↳ synonyms
array
Required. A collection of value synonyms. For example, if the entity type isvegetable, andvalueisscallions, a synonym could begreen onions. ForKIND_LISTentity types: * * This collection must contain exactly one synonym equal tovalue.
getValue
Required. The primary value associated with this entity entry.
For example, if the entity type isvegetable, the value could bescallions.
ForKIND_MAPentity types:
A reference value to be used in place of synonyms.
ForKIND_LISTentity types:
A string that can contain references to other entity types (with or
without aliases).
Returns
Type
Description
string
setValue
Required. The primary value associated with this entity entry.
For example, if the entity type isvegetable, the value could bescallions.
ForKIND_MAPentity types:
A reference value to be used in place of synonyms.
ForKIND_LISTentity types:
A string that can contain references to other entity types (with or
without aliases).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSynonyms
Required. A collection of value synonyms. For example, if the entity type
isvegetable, andvalueisscallions, a synonym could begreen
onions.
ForKIND_LISTentity types:
This collection must contain exactly one synonym equal tovalue.
[[["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 V2 Client - Class Entity (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-dialogflow/latest/V2.EntityType.Entity)\n- [2.1.1](/php/docs/reference/cloud-dialogflow/2.1.1/V2.EntityType.Entity)\n- [2.0.1](/php/docs/reference/cloud-dialogflow/2.0.1/V2.EntityType.Entity)\n- [1.17.2](/php/docs/reference/cloud-dialogflow/1.17.2/V2.EntityType.Entity)\n- [1.16.0](/php/docs/reference/cloud-dialogflow/1.16.0/V2.EntityType.Entity)\n- [1.15.1](/php/docs/reference/cloud-dialogflow/1.15.1/V2.EntityType.Entity)\n- [1.14.0](/php/docs/reference/cloud-dialogflow/1.14.0/V2.EntityType.Entity)\n- [1.13.0](/php/docs/reference/cloud-dialogflow/1.13.0/V2.EntityType.Entity)\n- [1.12.3](/php/docs/reference/cloud-dialogflow/1.12.3/V2.EntityType.Entity)\n- [1.11.0](/php/docs/reference/cloud-dialogflow/1.11.0/V2.EntityType.Entity)\n- [1.10.2](/php/docs/reference/cloud-dialogflow/1.10.2/V2.EntityType.Entity)\n- [1.9.0](/php/docs/reference/cloud-dialogflow/1.9.0/V2.EntityType.Entity)\n- [1.8.0](/php/docs/reference/cloud-dialogflow/1.8.0/V2.EntityType.Entity)\n- [1.7.2](/php/docs/reference/cloud-dialogflow/1.7.2/V2.EntityType.Entity)\n- [1.6.0](/php/docs/reference/cloud-dialogflow/1.6.0/V2.EntityType.Entity)\n- [1.5.0](/php/docs/reference/cloud-dialogflow/1.5.0/V2.EntityType.Entity)\n- [1.4.0](/php/docs/reference/cloud-dialogflow/1.4.0/V2.EntityType.Entity)\n- [1.3.2](/php/docs/reference/cloud-dialogflow/1.3.2/V2.EntityType.Entity)\n- [1.2.0](/php/docs/reference/cloud-dialogflow/1.2.0/V2.EntityType.Entity)\n- [1.1.1](/php/docs/reference/cloud-dialogflow/1.1.1/V2.EntityType.Entity)\n- [1.0.1](/php/docs/reference/cloud-dialogflow/1.0.1/V2.EntityType.Entity) \nReference documentation and code samples for the Google Cloud Dialogflow V2 Client class Entity.\n\nAn **entity entry** for an associated entity type.\n\nGenerated from protobuf message `google.cloud.dialogflow.v2.EntityType.Entity`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ V2 \\\\ EntityType\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getValue\n\nRequired. The primary value associated with this entity entry.\n\nFor example, if the entity type is *vegetable* , the value could be\n*scallions* .\nFor `KIND_MAP` entity types:\n\n- A reference value to be used in place of synonyms. For `KIND_LIST` entity types:\n- A string that can contain references to other entity types (with or without aliases).\n\n### setValue\n\nRequired. The primary value associated with this entity entry.\n\nFor example, if the entity type is *vegetable* , the value could be\n*scallions* .\nFor `KIND_MAP` entity types:\n\n- A reference value to be used in place of synonyms. For `KIND_LIST` entity types:\n- A string that can contain references to other entity types (with or without aliases).\n\n### getSynonyms\n\nRequired. A collection of value synonyms. For example, if the entity type\nis *vegetable* , and `value` is *scallions* , a synonym could be *green\nonions*.\n\nFor `KIND_LIST` entity types:\n\n- This collection must contain exactly one synonym equal to `value`.\n\n### setSynonyms\n\nRequired. A collection of value synonyms. For example, if the entity type\nis *vegetable* , and `value` is *scallions* , a synonym could be *green\nonions*.\n\nFor `KIND_LIST` entity types:\n\n- This collection must contain exactly one synonym equal to `value`."]]