Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::StreamChatAiAssistantResponse.
Response message for SessionService.StreamChatAiAssistant.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#artifact_chunk
def artifact_chunk() -> ::Google::Cloud::Ces::V1beta::ArtifactChunk-
(::Google::Cloud::Ces::V1beta::ArtifactChunk) — Generated-document artifact event (live preview deltas + final GCS
pointer).
Note: The following fields are mutually exclusive:
artifact_chunk,text_chunk,status,thought_chunk,tool_call,tool_response,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#artifact_chunk=
def artifact_chunk=(value) -> ::Google::Cloud::Ces::V1beta::ArtifactChunk-
value (::Google::Cloud::Ces::V1beta::ArtifactChunk) — Generated-document artifact event (live preview deltas + final GCS
pointer).
Note: The following fields are mutually exclusive:
artifact_chunk,text_chunk,status,thought_chunk,tool_call,tool_response,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::ArtifactChunk) — Generated-document artifact event (live preview deltas + final GCS
pointer).
Note: The following fields are mutually exclusive:
artifact_chunk,text_chunk,status,thought_chunk,tool_call,tool_response,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#confirmation_request
def confirmation_request() -> ::Google::Cloud::Ces::V1beta::AssistantConfirmationRequest-
(::Google::Cloud::Ces::V1beta::AssistantConfirmationRequest) — A blocking confirmation the agent paused on. The agent resumes when the
answer arrives on a later request's
confirmation_response. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.Note: The following fields are mutually exclusive:
confirmation_request,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#confirmation_request=
def confirmation_request=(value) -> ::Google::Cloud::Ces::V1beta::AssistantConfirmationRequest-
value (::Google::Cloud::Ces::V1beta::AssistantConfirmationRequest) — A blocking confirmation the agent paused on. The agent resumes when the
answer arrives on a later request's
confirmation_response. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.Note: The following fields are mutually exclusive:
confirmation_request,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::AssistantConfirmationRequest) — A blocking confirmation the agent paused on. The agent resumes when the
answer arrives on a later request's
confirmation_response. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request.Note: The following fields are mutually exclusive:
confirmation_request,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#event_id
def event_id() -> ::String- (::String) — Unique identifier for the event.
#event_id=
def event_id=(value) -> ::String- value (::String) — Unique identifier for the event.
- (::String) — Unique identifier for the event.
#event_time
def event_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Timestamp when the event occurred.
#event_time=
def event_time=(value) -> ::Google::Protobuf::Timestamp- value (::Google::Protobuf::Timestamp) — Timestamp when the event occurred.
- (::Google::Protobuf::Timestamp) — Timestamp when the event occurred.
#handoff
def handoff() -> ::Google::Cloud::Ces::V1beta::TurnHandoffEvent-
(::Google::Cloud::Ces::V1beta::TurnHandoffEvent) — Tells the client to silently reconnect with
resume_from_sequence_number: the task serving this stream is going
away and the turn will continue elsewhere. Not an error; the stream
completes normally after this event.
Note: The following fields are mutually exclusive:
handoff,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#handoff=
def handoff=(value) -> ::Google::Cloud::Ces::V1beta::TurnHandoffEvent-
value (::Google::Cloud::Ces::V1beta::TurnHandoffEvent) — Tells the client to silently reconnect with
resume_from_sequence_number: the task serving this stream is going
away and the turn will continue elsewhere. Not an error; the stream
completes normally after this event.
Note: The following fields are mutually exclusive:
handoff,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::TurnHandoffEvent) — Tells the client to silently reconnect with
resume_from_sequence_number: the task serving this stream is going
away and the turn will continue elsewhere. Not an error; the stream
completes normally after this event.
Note: The following fields are mutually exclusive:
handoff,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#option_questions_chunk
def option_questions_chunk() -> ::Google::Cloud::Ces::V1beta::OptionQuestionsChunk-
(::Google::Cloud::Ces::V1beta::OptionQuestionsChunk) — Structured clarification options parsed out of the model turn. The
console renders these as a selectable option list instead of raw text.
Note: The following fields are mutually exclusive:
option_questions_chunk,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#option_questions_chunk=
def option_questions_chunk=(value) -> ::Google::Cloud::Ces::V1beta::OptionQuestionsChunk-
value (::Google::Cloud::Ces::V1beta::OptionQuestionsChunk) — Structured clarification options parsed out of the model turn. The
console renders these as a selectable option list instead of raw text.
Note: The following fields are mutually exclusive:
option_questions_chunk,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::OptionQuestionsChunk) — Structured clarification options parsed out of the model turn. The
console renders these as a selectable option list instead of raw text.
Note: The following fields are mutually exclusive:
option_questions_chunk,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#resume_snapshot
def resume_snapshot() -> ::Google::Cloud::Ces::V1beta::TurnResumeSnapshot-
(::Google::Cloud::Ces::V1beta::TurnResumeSnapshot) — A compacted replay of an in-flight turn, sent as the first event of
every attach or resume before any live event. The client replaces any
locally rendered state for this turn with the snapshot's contents.
Note: The following fields are mutually exclusive:
resume_snapshot,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#resume_snapshot=
def resume_snapshot=(value) -> ::Google::Cloud::Ces::V1beta::TurnResumeSnapshot-
value (::Google::Cloud::Ces::V1beta::TurnResumeSnapshot) — A compacted replay of an in-flight turn, sent as the first event of
every attach or resume before any live event. The client replaces any
locally rendered state for this turn with the snapshot's contents.
Note: The following fields are mutually exclusive:
resume_snapshot,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::TurnResumeSnapshot) — A compacted replay of an in-flight turn, sent as the first event of
every attach or resume before any live event. The client replaces any
locally rendered state for this turn with the snapshot's contents.
Note: The following fields are mutually exclusive:
resume_snapshot,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#sequence_number
def sequence_number() -> ::Integer- (::Integer) — Optional. Monotonically increasing sequence number for this session turn.
#sequence_number=
def sequence_number=(value) -> ::Integer- value (::Integer) — Optional. Monotonically increasing sequence number for this session turn.
- (::Integer) — Optional. Monotonically increasing sequence number for this session turn.
#session_checkpoint
def session_checkpoint() -> ::Google::Cloud::Ces::V1beta::SessionCheckpoint-
(::Google::Cloud::Ces::V1beta::SessionCheckpoint) — Session checkpoint/compaction recap event containing user intent and
rolling summary.
Note: The following fields are mutually exclusive:
session_checkpoint,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#session_checkpoint=
def session_checkpoint=(value) -> ::Google::Cloud::Ces::V1beta::SessionCheckpoint-
value (::Google::Cloud::Ces::V1beta::SessionCheckpoint) — Session checkpoint/compaction recap event containing user intent and
rolling summary.
Note: The following fields are mutually exclusive:
session_checkpoint,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::SessionCheckpoint) — Session checkpoint/compaction recap event containing user intent and
rolling summary.
Note: The following fields are mutually exclusive:
session_checkpoint,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#status
def status() -> ::Google::Rpc::Status-
(::Google::Rpc::Status) — Simple status update.
Note: The following fields are mutually exclusive:
status,text_chunk,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#status=
def status=(value) -> ::Google::Rpc::Status-
value (::Google::Rpc::Status) — Simple status update.
Note: The following fields are mutually exclusive:
status,text_chunk,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Rpc::Status) — Simple status update.
Note: The following fields are mutually exclusive:
status,text_chunk,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text_chunk
def text_chunk() -> ::String-
(::String) — Text Token (for streaming Gemini responses word-by-word).
Note: The following fields are mutually exclusive:
text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text_chunk=
def text_chunk=(value) -> ::String-
value (::String) — Text Token (for streaming Gemini responses word-by-word).
Note: The following fields are mutually exclusive:
text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::String) — Text Token (for streaming Gemini responses word-by-word).
Note: The following fields are mutually exclusive:
text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#thought_chunk
def thought_chunk() -> ::String-
(::String) — Thought text chunk (agent's reasoning before generating response).
Note: The following fields are mutually exclusive:
thought_chunk,text_chunk,status,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#thought_chunk=
def thought_chunk=(value) -> ::String-
value (::String) — Thought text chunk (agent's reasoning before generating response).
Note: The following fields are mutually exclusive:
thought_chunk,text_chunk,status,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::String) — Thought text chunk (agent's reasoning before generating response).
Note: The following fields are mutually exclusive:
thought_chunk,text_chunk,status,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#tool_call
def tool_call() -> ::Google::Cloud::Ces::V1beta::ToolCall-
(::Google::Cloud::Ces::V1beta::ToolCall) — Tool call execution event.
Note: The following fields are mutually exclusive:
tool_call,text_chunk,status,thought_chunk,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#tool_call=
def tool_call=(value) -> ::Google::Cloud::Ces::V1beta::ToolCall-
value (::Google::Cloud::Ces::V1beta::ToolCall) — Tool call execution event.
Note: The following fields are mutually exclusive:
tool_call,text_chunk,status,thought_chunk,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::ToolCall) — Tool call execution event.
Note: The following fields are mutually exclusive:
tool_call,text_chunk,status,thought_chunk,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#tool_response
def tool_response() -> ::Google::Cloud::Ces::V1beta::ToolResponse-
(::Google::Cloud::Ces::V1beta::ToolResponse) — Tool call response event.
Note: The following fields are mutually exclusive:
tool_response,text_chunk,status,thought_chunk,tool_call,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#tool_response=
def tool_response=(value) -> ::Google::Cloud::Ces::V1beta::ToolResponse-
value (::Google::Cloud::Ces::V1beta::ToolResponse) — Tool call response event.
Note: The following fields are mutually exclusive:
tool_response,text_chunk,status,thought_chunk,tool_call,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::ToolResponse) — Tool call response event.
Note: The following fields are mutually exclusive:
tool_response,text_chunk,status,thought_chunk,tool_call,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff,turn_completed. If a field in that set is populated, all other fields in the set will automatically be cleared.
#turn_completed
def turn_completed() -> ::Google::Cloud::Ces::V1beta::TurnCompletedEvent-
(::Google::Cloud::Ces::V1beta::TurnCompletedEvent) — The turn has ended. Sent as the last event of every turn, on the original
stream and on every attached or resumed stream, so clients can end the
turn on an explicit signal instead of inferring it from stream closure.
Note: The following fields are mutually exclusive:
turn_completed,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff. If a field in that set is populated, all other fields in the set will automatically be cleared.
#turn_completed=
def turn_completed=(value) -> ::Google::Cloud::Ces::V1beta::TurnCompletedEvent-
value (::Google::Cloud::Ces::V1beta::TurnCompletedEvent) — The turn has ended. Sent as the last event of every turn, on the original
stream and on every attached or resumed stream, so clients can end the
turn on an explicit signal instead of inferring it from stream closure.
Note: The following fields are mutually exclusive:
turn_completed,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::Ces::V1beta::TurnCompletedEvent) — The turn has ended. Sent as the last event of every turn, on the original
stream and on every attached or resumed stream, so clients can end the
turn on an explicit signal instead of inferring it from stream closure.
Note: The following fields are mutually exclusive:
turn_completed,text_chunk,status,thought_chunk,tool_call,tool_response,artifact_chunk,option_questions_chunk,confirmation_request,session_checkpoint,resume_snapshot,handoff. If a field in that set is populated, all other fields in the set will automatically be cleared.
#turn_in_progress
def turn_in_progress() -> ::Boolean- (::Boolean) — Optional. Indicates whether the turn is still actively running in the background.
#turn_in_progress=
def turn_in_progress=(value) -> ::Boolean- value (::Boolean) — Optional. Indicates whether the turn is still actively running in the background.
- (::Boolean) — Optional. Indicates whether the turn is still actively running in the background.
#turn_metadata
def turn_metadata() -> ::Google::Cloud::Ces::V1beta::TurnMetadata- (::Google::Cloud::Ces::V1beta::TurnMetadata) — Optional. Turn-level metadata and intent categorization.
#turn_metadata=
def turn_metadata=(value) -> ::Google::Cloud::Ces::V1beta::TurnMetadata- value (::Google::Cloud::Ces::V1beta::TurnMetadata) — Optional. Turn-level metadata and intent categorization.
- (::Google::Cloud::Ces::V1beta::TurnMetadata) — Optional. Turn-level metadata and intent categorization.
#ui_event
def ui_event() -> ::Google::Cloud::Ces::V1beta::UiEvent- (::Google::Cloud::Ces::V1beta::UiEvent) — Optional. UI event payload.
#ui_event=
def ui_event=(value) -> ::Google::Cloud::Ces::V1beta::UiEvent- value (::Google::Cloud::Ces::V1beta::UiEvent) — Optional. UI event payload.
- (::Google::Cloud::Ces::V1beta::UiEvent) — Optional. UI event payload.