Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::StreamChatAiAssistantRequest.
Request message for SessionService.StreamChatAiAssistant.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#attach_only
def attach_only() -> ::Boolean
Returns
- (::Boolean) — Optional. Optional flag to attach to an existing in-flight turn without submitting a new message.
#attach_only=
def attach_only=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Optional flag to attach to an existing in-flight turn without submitting a new message.
Returns
- (::Boolean) — Optional. Optional flag to attach to an existing in-flight turn without submitting a new message.
#attached_gcs_uris
def attached_gcs_uris() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
#attached_gcs_uris=
def attached_gcs_uris=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
Returns
- (::Array<::String>) — Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf"
#client_capabilities
def client_capabilities() -> ::Array<::Google::Cloud::Ces::V1beta::StreamChatAiAssistantRequest::ClientCapability>
Returns
-
(::Array<::Google::Cloud::Ces::V1beta::StreamChatAiAssistantRequest::ClientCapability>) — Optional. Response features this client can render. The server only emits
events that need a capability (e.g.
confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.
#client_capabilities=
def client_capabilities=(value) -> ::Array<::Google::Cloud::Ces::V1beta::StreamChatAiAssistantRequest::ClientCapability>
Parameter
-
value (::Array<::Google::Cloud::Ces::V1beta::StreamChatAiAssistantRequest::ClientCapability>) — Optional. Response features this client can render. The server only emits
events that need a capability (e.g.
confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.
Returns
-
(::Array<::Google::Cloud::Ces::V1beta::StreamChatAiAssistantRequest::ClientCapability>) — Optional. Response features this client can render. The server only emits
events that need a capability (e.g.
confirmation_request) when the capability is declared, so older clients never receive events they would silently drop.
#confirmation_response
def confirmation_response() -> ::Google::Cloud::Ces::V1beta::AssistantConfirmationResponse
Returns
- (::Google::Cloud::Ces::V1beta::AssistantConfirmationResponse) — Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.
#confirmation_response=
def confirmation_response=(value) -> ::Google::Cloud::Ces::V1beta::AssistantConfirmationResponse
Parameter
- value (::Google::Cloud::Ces::V1beta::AssistantConfirmationResponse) — Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.
Returns
- (::Google::Cloud::Ces::V1beta::AssistantConfirmationResponse) — Optional. The user's answer to a pending AssistantConfirmationRequest. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn.
#context_token
def context_token() -> ::String
Returns
- (::String) — Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.
#context_token=
def context_token=(value) -> ::String
Parameter
- value (::String) — Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.
Returns
- (::String) — Optional. Opaque onboarding context token returned by SessionService.GenerateOnboardingSuggestions. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn.
#message
def message() -> ::String
Returns
-
(::String) — Optional. The message to send to the assistant agent. May be empty when
confirmation_responseis set (answering a pending confirmation without adding a new message); at least one of the two must be provided.
#message=
def message=(value) -> ::String
Parameter
-
value (::String) — Optional. The message to send to the assistant agent. May be empty when
confirmation_responseis set (answering a pending confirmation without adding a new message); at least one of the two must be provided.
Returns
-
(::String) — Optional. The message to send to the assistant agent. May be empty when
confirmation_responseis set (answering a pending confirmation without adding a new message); at least one of the two must be provided.
#name
def name() -> ::String
Returns
-
(::String) — Required. The assistant session to be used to run the assistant.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. The assistant session to be used to run the assistant.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}
Returns
-
(::String) — Required. The assistant session to be used to run the assistant.
Format:
projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}
#operation_completed_event
def operation_completed_event() -> ::Google::Cloud::Ces::V1beta::OperationCompletedEvent
Returns
- (::Google::Cloud::Ces::V1beta::OperationCompletedEvent) — Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.
#operation_completed_event=
def operation_completed_event=(value) -> ::Google::Cloud::Ces::V1beta::OperationCompletedEvent
Parameter
- value (::Google::Cloud::Ces::V1beta::OperationCompletedEvent) — Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.
Returns
- (::Google::Cloud::Ces::V1beta::OperationCompletedEvent) — Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete.
#resume_from_sequence_number
def resume_from_sequence_number() -> ::Integer
Returns
- (::Integer) — Optional. Optional cursor to resume and replay events from an in-flight or completed turn.
#resume_from_sequence_number=
def resume_from_sequence_number=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Optional cursor to resume and replay events from an in-flight or completed turn.
Returns
- (::Integer) — Optional. Optional cursor to resume and replay events from an in-flight or completed turn.