Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::AssistantSession.
An assistant session represents a conversation between a user and the assistant agent.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#active_turn
def active_turn() -> ::Google::Cloud::Ces::V1beta::ActiveTurnInfo
Returns
- (::Google::Cloud::Ces::V1beta::ActiveTurnInfo) — Output only. Attachment info for this session's currently running turn. Unset when no turn is running.
#artifacts
def artifacts() -> ::Array<::Google::Cloud::Ces::V1beta::AssistantSessionArtifact>
Returns
- (::Array<::Google::Cloud::Ces::V1beta::AssistantSessionArtifact>) — Output only. Document artifacts (e.g. generated TDDs in markdown) produced by the assistant in this session. Pointers only; the file content lives in the customer's Cloud Storage bucket.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the assistant session was created.
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. The display name of the assistant session.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. The display name of the assistant session.
Returns
- (::String) — Optional. The display name of the assistant session.
#messages
def messages() -> ::Array<::Google::Cloud::Ces::V1beta::AssistantMessage>
Returns
- (::Array<::Google::Cloud::Ces::V1beta::AssistantMessage>) — Optional. History of messages in the session.
#messages=
def messages=(value) -> ::Array<::Google::Cloud::Ces::V1beta::AssistantMessage>
Parameter
- value (::Array<::Google::Cloud::Ces::V1beta::AssistantMessage>) — Optional. History of messages in the session.
Returns
- (::Array<::Google::Cloud::Ces::V1beta::AssistantMessage>) — Optional. History of messages in the session.
#name
def name() -> ::String
Returns
-
(::String) — Required. Identifier. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. Identifier. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
Returns
-
(::String) — Required. Identifier. The unique identifier of the session.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
#requestor
def requestor() -> ::String
Returns
- (::String) — Output only. The user who initiated the session.
#session_checkpoint
def session_checkpoint() -> ::Google::Cloud::Ces::V1beta::SessionCheckpoint
Returns
- (::Google::Cloud::Ces::V1beta::SessionCheckpoint) — Output only. Session checkpoint containing user intent and rolling history summary.
#state
def state() -> ::Google::Cloud::Ces::V1beta::AssistantSessionState
Returns
- (::Google::Cloud::Ces::V1beta::AssistantSessionState) — Output only. The status of the assistant session.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the assistant session was last updated.
#user_response_suggestions
def user_response_suggestions() -> ::Google::Cloud::Ces::V1beta::UserResponseSuggestions
Returns
- (::Google::Cloud::Ces::V1beta::UserResponseSuggestions) — Output only. Suggested user responses from the assistant agent.