Session entity types are referred to as User entity 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 a [custom entity
type][google.cloud.dialogflow.cx.v3beta1.EntityType] at 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 the Dialogflow
documentation <https://cloud.google.com/dialogflow/docs/entities-overview>__.
Attributes
Name
Description
name
str
Required. The unique identifier of the session entity type.
Format:
projects/
or
projects/.
If Environment ID is not specified, we assume default
'draft' environment.
The types of modifications for the 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.cx.v3beta1.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-08-28 UTC."],[],[],null,["# Class SessionEntityType (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3beta1.types.SessionEntityType) \n\n SessionEntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSession entity types are referred to as **User** entity types and\nare entities that are built for an individual user such as\nfavorites, preferences, playlists, and so on.\n\nYou can redefine a session entity type at the session level to\nextend or replace a \\[custom entity\ntype\\]\\[google.cloud.dialogflow.cx.v3beta1.EntityType\\] at the user\nsession level (we refer to the entity types defined at the agent\nlevel as \"custom entity types\").\n\nNote: session entity types apply to all queries, regardless of the\nlanguage.\n\nFor more information about entity types, see the `Dialogflow\ndocumentation \u003chttps://cloud.google.com/dialogflow/docs/entities-overview\u003e`__.\n\nClasses\n-------\n\n### EntityOverrideMode\n\n EntityOverrideMode(value)\n\nThe types of modifications for the 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.cx.v3beta1.EntityTypes.GetEntityType\"\u003eEntityTypes.GetEntityType\u003c/xref\u003e\n on the custom entity type and merge."]]