public sealed class StreamingReactiveCompanionSuggestionsResponse : IMessage<StreamingReactiveCompanionSuggestionsResponse>, IEquatable<StreamingReactiveCompanionSuggestionsResponse>, IDeepCloneable<StreamingReactiveCompanionSuggestionsResponse>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Dialogflow v2 API class StreamingReactiveCompanionSuggestionsResponse.
The response message for [Participants.StreamingReactiveCompanionSuggestions][google.cloud.dialogflow.v2.Participants.StreamingReactiveCompanionSuggestions].
Implements
IMessageStreamingReactiveCompanionSuggestionsResponse, IEquatableStreamingReactiveCompanionSuggestionsResponse, IDeepCloneableStreamingReactiveCompanionSuggestionsResponse, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.V2Assembly
Google.Cloud.Dialogflow.V2.dll
Constructors
StreamingReactiveCompanionSuggestionsResponse()
public StreamingReactiveCompanionSuggestionsResponse()StreamingReactiveCompanionSuggestionsResponse(StreamingReactiveCompanionSuggestionsResponse)
public StreamingReactiveCompanionSuggestionsResponse(StreamingReactiveCompanionSuggestionsResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
StreamingReactiveCompanionSuggestionsResponse |
Properties
AnswerRecord
public string AnswerRecord { get; set; }Output only. Only set when is_final is true and conversational turn
processing completes. The final answer record representing the completed
suggestion. Only present in the last chunk of the completed response.
| Property Value | |
|---|---|
| Type | Description |
string |
|
AnswerRecordAsAnswerRecordName
public AnswerRecordName AnswerRecordAsAnswerRecordName { get; set; }AnswerRecordName-typed view over the AnswerRecord resource name property.
| Property Value | |
|---|---|
| Type | Description |
AnswerRecordName |
|
HasResponseChunk
public bool HasResponseChunk { get; }Gets whether the "response_chunk" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IntermediateToolCallEvents
public ToolCallEvents IntermediateToolCallEvents { get; set; }Output only. Captures intermediate tool call events that occur during the
execution of the reactive query turn. Note that conversational messages
within tool calls are displayed within the tool cards and hence are not
accumulated within the reactive_mode_final_response.response string.
| Property Value | |
|---|---|
| Type | Description |
ToolCallEvents |
|
IsFinal
public bool IsFinal { get; set; }Output only. Indicates whether the client/UI can accept a new query for
reactive chat. When is_final is true, the reactive chat interface is
unblocked and ready to receive new human agent queries. For synchronous
turns, this is set to true on the final response chunk. For asynchronous
tool calls running in the background, this is set to true on the
intermediate trigger chunk to unblock the UI while the background tool
execution is in progress.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ReactiveModeFinalResponse
public StreamingReactiveCompanionSuggestionsResponse.Types.ReactiveModeResponse ReactiveModeFinalResponse { get; set; }Output only. The final response from the reactive mode capturing the
entire accumulated streaming response, grounding metadata, and tool
calls. Only set when is_final is true and conversational processing
for the query turn completes.
| Property Value | |
|---|---|
| Type | Description |
StreamingReactiveCompanionSuggestionsResponseTypesReactiveModeResponse |
|
ResponseCase
public StreamingReactiveCompanionSuggestionsResponse.ResponseOneofCase ResponseCase { get; }| Property Value | |
|---|---|
| Type | Description |
StreamingReactiveCompanionSuggestionsResponseResponseOneofCase |
|
ResponseChunk
public string ResponseChunk { get; set; }Streamed response text chunks.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SendTime
public Timestamp SendTime { get; set; }The timestamp when the response chunk was sent by the service.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Status
public Status Status { get; set; }Status of the response for the current query. If set and non-ok, indicates an error occurred during processing of the current query, or confirms that a requested cancellation has successfully completed (status code CANCELLED).
| Property Value | |
|---|---|
| Type | Description |
Status |
|
TextMessageId
public string TextMessageId { get; set; }Required. The unique message identifier corresponding to the human agent query that generated this response chunk.
| Property Value | |
|---|---|
| Type | Description |
string |
|