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.
For more information, see the session entity
guide <https://cloud.google.com/dialogflow/docs/entities-session>__.
Attributes
Name
Description
name
str
Required. The unique identifier of this session entity type.
Format:
projects/,
or
projects/.
If Environment ID is not specified, we assume default
'draft' environment. If User ID is not specified, we
assume default '-' user.
must be the display name of
an existing entity type in the same agent that will be
overridden or supplemented.
The types of modifications for a session entity type.
Note: Even in this override mode calls to
`ListSessionEntityTypes`, `GetSessionEntityType`,
`CreateSessionEntityType` and `UpdateSessionEntityType`
only return the additional entities added in this session
entity type. If you want to get the supplemented list,
please call
<xref uid="google.cloud.dialogflow.v2.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>
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-09-04 UTC."],[],[],null,["# Class SessionEntityType (2.41.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.41.2 (latest)](/python/docs/reference/dialogflow/latest/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.41.1](/python/docs/reference/dialogflow/2.41.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.40.0](/python/docs/reference/dialogflow/2.40.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.39.1](/python/docs/reference/dialogflow/2.39.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.38.0](/python/docs/reference/dialogflow/2.38.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.37.0](/python/docs/reference/dialogflow/2.37.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.36.0](/python/docs/reference/dialogflow/2.36.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.35.0](/python/docs/reference/dialogflow/2.35.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.34.0](/python/docs/reference/dialogflow/2.34.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.33.0](/python/docs/reference/dialogflow/2.33.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.32.0](/python/docs/reference/dialogflow/2.32.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.30.2](/python/docs/reference/dialogflow/2.30.2/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.29.0](/python/docs/reference/dialogflow/2.29.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.28.3](/python/docs/reference/dialogflow/2.28.3/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.27.0](/python/docs/reference/dialogflow/2.27.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.26.0](/python/docs/reference/dialogflow/2.26.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.25.0](/python/docs/reference/dialogflow/2.25.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.24.1](/python/docs/reference/dialogflow/2.24.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.23.3](/python/docs/reference/dialogflow/2.23.3/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.22.0](/python/docs/reference/dialogflow/2.22.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.21.0](/python/docs/reference/dialogflow/2.21.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.20.0](/python/docs/reference/dialogflow/2.20.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.19.1](/python/docs/reference/dialogflow/2.19.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.18.0](/python/docs/reference/dialogflow/2.18.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.17.0](/python/docs/reference/dialogflow/2.17.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.16.1](/python/docs/reference/dialogflow/2.16.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.15.2](/python/docs/reference/dialogflow/2.15.2/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.14.1](/python/docs/reference/dialogflow/2.14.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.13.0](/python/docs/reference/dialogflow/2.13.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.12.0](/python/docs/reference/dialogflow/2.12.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.11.0](/python/docs/reference/dialogflow/2.11.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.10.0](/python/docs/reference/dialogflow/2.10.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.9.1](/python/docs/reference/dialogflow/2.9.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.8.1](/python/docs/reference/dialogflow/2.8.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.7.1](/python/docs/reference/dialogflow/2.7.1/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.6.0](/python/docs/reference/dialogflow/2.6.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.5.0](/python/docs/reference/dialogflow/2.5.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.4.0](/python/docs/reference/dialogflow/2.4.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.3.0](/python/docs/reference/dialogflow/2.3.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.2.0](/python/docs/reference/dialogflow/2.2.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.1.2](/python/docs/reference/dialogflow/2.1.2/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [2.0.0](/python/docs/reference/dialogflow/2.0.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [1.1.3](/python/docs/reference/dialogflow/1.1.3/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [1.0.0](/python/docs/reference/dialogflow/1.0.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [0.8.0](/python/docs/reference/dialogflow/0.8.0/google.cloud.dialogflow_v2.types.SessionEntityType)\n- [0.7.2](/python/docs/reference/dialogflow/0.7.2/google.cloud.dialogflow_v2.types.SessionEntityType) \n\n SessionEntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA session represents a conversation between a Dialogflow agent and\nan end-user. You can create special entities, called session\nentities, during a session. Session entities can extend or replace\ncustom entity types and only exist during the session that they were\ncreated for. All session data, including session entities, is stored\nby Dialogflow for 20 minutes.\n\nFor more information, see the `session entity\nguide \u003chttps://cloud.google.com/dialogflow/docs/entities-session\u003e`__.\n\nClasses\n-------\n\n### EntityOverrideMode\n\n EntityOverrideMode(value)\n\nThe types of modifications for a session entity type. \n\n Note: Even in this override mode calls to\n `ListSessionEntityTypes`, `GetSessionEntityType`,\n `CreateSessionEntityType` and `UpdateSessionEntityType`\n only return the additional entities added in this session\n entity type. If you want to get the supplemented list,\n please call\n \u003cxref uid=\"google.cloud.dialogflow.v2.EntityTypes.GetEntityType\"\u003eEntityTypes.GetEntityType\u003c/xref\u003e\n on the custom entity type and merge."]]