Interface StreamingReactiveCompanionSuggestionsResponseOrBuilder (4.105.0)

4.105.0 (latest) 4.101.0 4.100.0 4.99.0 4.97.0 4.94.0 4.93.0 4.91.0 4.89.0 4.88.0 4.87.0 4.86.0 4.84.0 4.82.0 4.81.0 4.80.0 4.79.0 4.78.0 4.76.0 4.74.0 4.73.0 4.70.0 4.69.0 4.68.0 4.66.0 4.65.0 4.64.0 4.63.0 4.62.0 4.61.0 4.60.0 4.59.0 4.58.0 4.57.0 4.55.0 4.54.0 4.53.0 4.52.0 4.51.0 4.50.0 4.49.0 4.48.0 4.47.0 4.46.0 4.45.0 4.43.0 4.42.0 4.41.0 4.40.0 4.39.0 4.38.0 4.37.0 4.36.0 4.35.0 4.34.0 4.33.0 4.30.0 4.29.0 4.28.0 4.27.0 4.26.0 4.25.0 4.24.0 4.23.0 4.22.0 4.21.0 4.20.0 4.19.0 4.18.0 4.17.0 4.15.0 4.14.0 4.13.0 4.12.0 4.11.0 4.10.0 4.9.1 4.8.6 4.7.5 4.6.0 4.5.11 4.4.0 4.3.1

public interface StreamingReactiveCompanionSuggestionsResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswerRecord()

public abstract String getAnswerRecord()

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.

string answer_record = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The answerRecord.

getAnswerRecordBytes()

public abstract ByteString getAnswerRecordBytes()

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.

string answer_record = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for answerRecord.

getIntermediateToolCallEvents()

public abstract ToolCallEvents getIntermediateToolCallEvents()

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.

.google.cloud.dialogflow.v2.ToolCallEvents intermediate_tool_call_events = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ToolCallEvents	The intermediateToolCallEvents.

getIntermediateToolCallEventsOrBuilder()

public abstract ToolCallEventsOrBuilder getIntermediateToolCallEventsOrBuilder()

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.

.google.cloud.dialogflow.v2.ToolCallEvents intermediate_tool_call_events = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ToolCallEventsOrBuilder

getIsFinal()

public abstract boolean getIsFinal()

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.

bool is_final = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The isFinal.

getReactiveModeFinalResponse()

public abstract StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse getReactiveModeFinalResponse()

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.

.google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse reactive_mode_final_response = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse	The reactiveModeFinalResponse.

getReactiveModeFinalResponseOrBuilder()

public abstract StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponseOrBuilder getReactiveModeFinalResponseOrBuilder()

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.

.google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse reactive_mode_final_response = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponseOrBuilder

getResponseCase()

public abstract StreamingReactiveCompanionSuggestionsResponse.ResponseCase getResponseCase()

Returns
Type	Description
StreamingReactiveCompanionSuggestionsResponse.ResponseCase

getResponseChunk()

public abstract String getResponseChunk()

Streamed response text chunks.

string response_chunk = 1;

Returns
Type	Description
String	The responseChunk.

getResponseChunkBytes()

public abstract ByteString getResponseChunkBytes()

Streamed response text chunks.

string response_chunk = 1;

Returns
Type	Description
ByteString	The bytes for responseChunk.

getSendTime()

public abstract Timestamp getSendTime()

The timestamp when the response chunk was sent by the service.

.google.protobuf.Timestamp send_time = 9;

Returns
Type	Description
Timestamp	The sendTime.

getSendTimeOrBuilder()

public abstract TimestampOrBuilder getSendTimeOrBuilder()

The timestamp when the response chunk was sent by the service.

.google.protobuf.Timestamp send_time = 9;

Returns
Type	Description
TimestampOrBuilder

getStatus()

public abstract Status getStatus()

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

.google.rpc.Status status = 3;

Returns
Type	Description
com.google.rpc.Status	The status.

getStatusOrBuilder()

public abstract StatusOrBuilder getStatusOrBuilder()

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

.google.rpc.Status status = 3;

Returns
Type	Description
com.google.rpc.StatusOrBuilder

getTextMessageId()

public abstract String getTextMessageId()

Required. The unique message identifier corresponding to the human agent query that generated this response chunk.

string text_message_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The textMessageId.

getTextMessageIdBytes()

public abstract ByteString getTextMessageIdBytes()

Required. The unique message identifier corresponding to the human agent query that generated this response chunk.

string text_message_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for textMessageId.

hasIntermediateToolCallEvents()

public abstract boolean hasIntermediateToolCallEvents()

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.

.google.cloud.dialogflow.v2.ToolCallEvents intermediate_tool_call_events = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the intermediateToolCallEvents field is set.

hasReactiveModeFinalResponse()

public abstract boolean hasReactiveModeFinalResponse()

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.

.google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse reactive_mode_final_response = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the reactiveModeFinalResponse field is set.

hasResponseChunk()

public abstract boolean hasResponseChunk()

Streamed response text chunks.

string response_chunk = 1;

Returns
Type	Description
boolean	Whether the responseChunk field is set.

hasSendTime()

public abstract boolean hasSendTime()

The timestamp when the response chunk was sent by the service.

.google.protobuf.Timestamp send_time = 9;

Returns
Type	Description
boolean	Whether the sendTime field is set.

hasStatus()

public abstract boolean hasStatus()

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

.google.rpc.Status status = 3;

Returns
Type	Description
boolean	Whether the status field is set.