Class SessionEntityType (1.20.0)

Version 1.20.0

• 1.38.0 (latest)
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

SessionEntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.v3.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.
entity_override_mode	google.cloud.dialogflowcx_v3.types.SessionEntityType.EntityOverrideMode Required. Indicates whether the additional data should override or supplement the custom entity type definition.
entities	MutableSequence[google.cloud.dialogflowcx_v3.types.EntityType.Entity] Required. The collection of entities to override or supplement the custom entity type.

Classes

EntityOverrideMode

EntityOverrideMode(value)

The types of modifications for the session entity type.

Values: ENTITY_OVERRIDE_MODE_UNSPECIFIED (0): Not specified. This value should be never used. ENTITY_OVERRIDE_MODE_OVERRIDE (1): The collection of session entities overrides the collection of entities in the corresponding custom entity type. ENTITY_OVERRIDE_MODE_SUPPLEMENT (2): The collection of session entities extends the collection of entities in the corresponding custom 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.v3.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>
    on the custom entity type and merge.