Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::SessionEntityType (v0.25.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::SessionEntityType.

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 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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#entities

def entities() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>
Returns

#entities=

def entities=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>
Parameter
Returns

#entity_override_mode

def entity_override_mode() -> ::Google::Cloud::Dialogflow::CX::V3::SessionEntityType::EntityOverrideMode
Returns

#entity_override_mode=

def entity_override_mode=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SessionEntityType::EntityOverrideMode
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Required. The unique identifier of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The unique identifier of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment.
Returns
  • (::String) — Required. The unique identifier of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment.