A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.
Required. The unique identifier of this session entity type. Supported formats: - projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity
Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name> - projects/<Project ID>/locations/<Location ID>/agent/environments/
<Environment ID>/users/<User ID>/sessions/<Session
ID>/entityTypes/<Entity Type Display Name>
If Location ID is not specified we assume default 'us' location. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
Required. The collection of entities associated with this session entity type.
EntityOverrideMode
The types of modifications for a session entity type.
Enums
ENTITY_OVERRIDE_MODE_UNSPECIFIED
Not specified. This value should be never used.
ENTITY_OVERRIDE_MODE_OVERRIDE
The collection of session entities overrides the collection of entities in the corresponding custom entity type.
ENTITY_OVERRIDE_MODE_SUPPLEMENT
The collection of session entities extends the collection of entities in the corresponding custom entity type.
Note: Even in this override mode calls to entityTypes.list, entityTypes.get, entityTypes.create and entityTypes.patch only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge.
[[["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-03-05 UTC."],[[["Session entities are special entities created during a conversation between a Dialogflow agent and an end-user, which can extend or replace custom entity types but only exist during that specific session."],["Session entity data, including all entities, is retained by Dialogflow for a duration of 20 minutes."],["The `entityOverrideMode` field specifies whether session entities should override or supplement custom entity types, with options for `ENTITY_OVERRIDE_MODE_OVERRIDE` or `ENTITY_OVERRIDE_MODE_SUPPLEMENT`."],["Session entity types can be managed using various methods such as `create`, `delete`, `get`, `list`, and `patch`, which allow for the creation, deletion, retrieval, listing, and updating of these entities within a specific session."],["The `name` field in the JSON representation is a unique identifier for each session entity type, following specific formatting rules for projects, locations, environments, users, and sessions, including defaults if certain values are not specified."]]],[]]