Show / Hide Table of Contents

Class 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.

Inheritance
object
AssistantConfirmationRequest
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll
Syntax
public class AssistantConfirmationRequest : IDirectResponseSchema

Properties

AgentName

Display label of the agent that raised the confirmation (e.g. "Contract Architect"), for the card header.

Declaration
[JsonProperty("agentName")]
public virtual string AgentName { get; set; }
Property Value
Type Description
string

ConfirmationId

Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request.

Declaration
[JsonProperty("confirmationId")]
public virtual string ConfirmationId { get; set; }
Property Value
Type Description
string

Context

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.

Declaration
[JsonProperty("context")]
public virtual string Context { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExpireTime

object representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ExpireTimeRaw

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.

Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }
Property Value
Type Description
string

NegativeLabel

Label for the declining action of a binary confirmation (e.g. "Not yet"). Unset when questions is populated.

Declaration
[JsonProperty("negativeLabel")]
public virtual string NegativeLabel { get; set; }
Property Value
Type Description
string

PositiveLabel

Label for the approving action of a binary confirmation (e.g. "Publish"). Unset when questions is populated.

Declaration
[JsonProperty("positiveLabel")]
public virtual string PositiveLabel { get; set; }
Property Value
Type Description
string

Questions

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.

Declaration
[JsonProperty("questions")]
public virtual IList<OptionQuestionsChunkQuestion> Questions { get; set; }
Property Value
Type Description
IList<OptionQuestionsChunkQuestion>

Tool

Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions.

Declaration
[JsonProperty("tool")]
public virtual string Tool { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX