Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::AssistantConfirmationRequest.
A blocking question or confirmation the assistant needs answered before an agent action can proceed. The requesting agent is paused and resumes only when the answer arrives on a later StreamChatAiAssistantRequest.confirmation_response.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#agent_name
def agent_name() -> ::String
Returns
-
(::String) — Display label of the agent that raised the confirmation (e.g.
"Contract Architect"), for the card header.
#agent_name=
def agent_name=(value) -> ::String
Parameter
-
value (::String) — Display label of the agent that raised the confirmation (e.g.
"Contract Architect"), for the card header.
Returns
-
(::String) — Display label of the agent that raised the confirmation (e.g.
"Contract Architect"), for the card header.
#confirmation_id
def confirmation_id() -> ::String
Returns
- (::String) — Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request.
#confirmation_id=
def confirmation_id=(value) -> ::String
Parameter
- value (::String) — Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request.
Returns
- (::String) — Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request.
#context
def context() -> ::String
Returns
- (::String) — Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown.
#context=
def context=(value) -> ::String
Parameter
- value (::String) — Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown.
Returns
- (::String) — Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely.
#expire_time=
def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely.
Returns
- (::Google::Protobuf::Timestamp) — Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely.
#negative_label
def negative_label() -> ::String
Returns
-
(::String) — Label for the declining action of a binary confirmation (e.g. "Not yet").
Unset when
questionsis populated.
#negative_label=
def negative_label=(value) -> ::String
Parameter
-
value (::String) — Label for the declining action of a binary confirmation (e.g. "Not yet").
Unset when
questionsis populated.
Returns
-
(::String) — Label for the declining action of a binary confirmation (e.g. "Not yet").
Unset when
questionsis populated.
#positive_label
def positive_label() -> ::String
Returns
-
(::String) — Label for the approving action of a binary confirmation (e.g. "Publish").
Unset when
questionsis populated.
#positive_label=
def positive_label=(value) -> ::String
Parameter
-
value (::String) — Label for the approving action of a binary confirmation (e.g. "Publish").
Unset when
questionsis populated.
Returns
-
(::String) — Label for the approving action of a binary confirmation (e.g. "Publish").
Unset when
questionsis populated.
#questions
def questions() -> ::Array<::Google::Cloud::Ces::V1beta::OptionQuestionsChunk::Question>
Returns
- (::Array<::Google::Cloud::Ces::V1beta::OptionQuestionsChunk::Question>) — Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.
#questions=
def questions=(value) -> ::Array<::Google::Cloud::Ces::V1beta::OptionQuestionsChunk::Question>
Parameter
- value (::Array<::Google::Cloud::Ces::V1beta::OptionQuestionsChunk::Question>) — Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.
Returns
- (::Array<::Google::Cloud::Ces::V1beta::OptionQuestionsChunk::Question>) — Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as AssistantConfirmationResponse.answer_text.
#tool
def tool() -> ::String
Returns
- (::String) — Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions.
#tool=
def tool=(value) -> ::String
Parameter
- value (::String) — Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions.
Returns
- (::String) — Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions.