Class SessionEntityType (2.27.0)

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

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

NameDescription
name str
Required. The unique identifier of this session entity type. Supported formats: - projects/ - projects/ - projects/ - projects/ 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. must be the display name of an existing entity type in the same agent that will be overridden or supplemented.
entity_override_mode google.cloud.dialogflow_v2beta1.types.SessionEntityType.EntityOverrideMode
Required. Indicates whether the additional data should override or supplement the custom entity type definition.
entities MutableSequence[google.cloud.dialogflow_v2beta1.types.EntityType.Entity]
Required. The collection of entities associated with this session entity type.

Classes

EntityOverrideMode

EntityOverrideMode(value)

The types of modifications for a 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.v2beta1.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>
    on the custom entity type and merge.