Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::SessionEntityType (v1.4.0)

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

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#entities

def entities() -> ::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity>

Returns

(::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity>) — Required. The collection of entities associated with this session entity type.

#entities=

def entities=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity>

Parameter

value (::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity>) — Required. The collection of entities associated with this session entity type.

Returns

(::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity>) — Required. The collection of entities associated with this session entity type.

#entity_override_mode

def entity_override_mode() -> ::Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode

Returns

(::Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode) — Required. Indicates whether the additional data should override or supplement the custom entity type definition.

#entity_override_mode=

def entity_override_mode=(value) -> ::Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode

Parameter

value (::Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode) — Required. Indicates whether the additional data should override or supplement the custom entity type definition.

Returns

(::Google::Cloud::Dialogflow::V2::SessionEntityType::EntityOverrideMode) — Required. Indicates whether the additional data should override or supplement the custom entity type definition.

#name

def name() -> ::String

Returns

(::String) — Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

<Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

<Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

Returns

(::String) — Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

<Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.