Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class SessionEntityType.
Session entity types are referred to asUserentity types and are
entities that are built for an individual user such as favorites,
preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or
replace acustom entity typeat
the user session level (we refer to the entity types defined at the agent
level as "custom entity types").
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see theDialogflow
documentation.
Generated from protobuf messagegoogle.cloud.dialogflow.cx.v3.SessionEntityType
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The unique identifier of the session entity type. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>. IfEnvironment IDis not specified, we assume default 'draft' environment.
↳ entity_override_mode
int
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
Required. The collection of entities to override or supplement the custom entity type.
getName
Required. The unique identifier of the session entity type.
Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
IfEnvironment IDis not specified, we assume default 'draft'
environment.
Returns
Type
Description
string
setName
Required. The unique identifier of the session entity type.
Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
IfEnvironment IDis not specified, we assume default 'draft'
environment.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEntityOverrideMode
Required. Indicates whether the additional data should override or
supplement the custom entity type definition.
Returns
Type
Description
int
setEntityOverrideMode
Required. Indicates whether the additional data should override or
supplement the custom entity type definition.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getEntities
Required. The collection of entities to override or supplement the custom
entity type.
[[["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 SessionEntityType (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.SessionEntityType)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.SessionEntityType)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.SessionEntityType)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.SessionEntityType)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.SessionEntityType)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.SessionEntityType)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.SessionEntityType)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.SessionEntityType)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.SessionEntityType) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class SessionEntityType.\n\nSession entity types are referred to as **User** entity types and are\nentities that are built for an individual user such as favorites,\npreferences, playlists, and so on.\n\nYou can redefine a session entity type at the session level to extend or\nreplace a [custom entity type](/php/docs/reference/cloud-dialogflow-cx/latest/V3.EntityType) at\nthe user session level (we refer to the entity types defined at the agent\nlevel as \"custom entity types\").\nNote: session entity types apply to all queries, regardless of the language.\nFor more information about entity types, see the [Dialogflow\ndocumentation](https://cloud.google.com/dialogflow/docs/entities-overview).\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.SessionEntityType`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The unique identifier of the session entity type.\n\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/sessions/\u003cSessionID\u003e/entityTypes/\u003cEntityTypeID\u003e`\nor\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/environments/\u003cEnvironmentID\u003e/sessions/\u003cSessionID\u003e/entityTypes/\u003cEntityTypeID\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment.\n\n### setName\n\nRequired. The unique identifier of the session entity type.\n\nFormat:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/sessions/\u003cSessionID\u003e/entityTypes/\u003cEntityTypeID\u003e`\nor\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/environments/\u003cEnvironmentID\u003e/sessions/\u003cSessionID\u003e/entityTypes/\u003cEntityTypeID\u003e`.\nIf `Environment ID` is not specified, we assume default 'draft'\nenvironment.\n\n### getEntityOverrideMode\n\nRequired. Indicates whether the additional data should override or\nsupplement the custom entity type definition.\n\n### setEntityOverrideMode\n\nRequired. Indicates whether the additional data should override or\nsupplement the custom entity type definition.\n\n### getEntities\n\nRequired. The collection of entities to override or supplement the custom\nentity type.\n\n### setEntities\n\nRequired. The collection of entities to override or supplement the custom\nentity type."]]
