Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Session (v2.1.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Session.

External session proto definition.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. The display name of the session.

    This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The display name of the session.

    This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.

Returns
  • (::String) — Optional. The display name of the session.

    This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns

#is_pinned

def is_pinned() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.

#is_pinned=

def is_pinned=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
Returns
  • (::Boolean) — Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.

#name

def name() -> ::String
Returns
  • (::String) — Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
Returns
  • (::String) — Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#state

def state() -> ::Google::Cloud::DiscoveryEngine::V1::Session::State
Returns

#state=

def state=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Session::State
Parameter
Returns

#turns

def turns() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>
Returns

#turns=

def turns=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>
Parameter
Returns

#user_pseudo_id

def user_pseudo_id() -> ::String
Returns
  • (::String) — A unique identifier for tracking users.

#user_pseudo_id=

def user_pseudo_id=(value) -> ::String
Parameter
  • value (::String) — A unique identifier for tracking users.
Returns
  • (::String) — A unique identifier for tracking users.