Class StreamingReactiveCompanionSuggestionsResponse (4.105.0)

public final class StreamingReactiveCompanionSuggestionsResponse extends GeneratedMessage implements StreamingReactiveCompanionSuggestionsResponseOrBuilder

The response message for Participants.StreamingReactiveCompanionSuggestions.

Protobuf type google.cloud.dialogflow.v2.StreamingReactiveCompanionSuggestionsResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > StreamingReactiveCompanionSuggestionsResponse

Static Fields

ANSWER_RECORD_FIELD_NUMBER

public static final int ANSWER_RECORD_FIELD_NUMBER
Field Value
Type Description
int

INTERMEDIATE_TOOL_CALL_EVENTS_FIELD_NUMBER

public static final int INTERMEDIATE_TOOL_CALL_EVENTS_FIELD_NUMBER
Field Value
Type Description
int

IS_FINAL_FIELD_NUMBER

public static final int IS_FINAL_FIELD_NUMBER
Field Value
Type Description
int

REACTIVE_MODE_FINAL_RESPONSE_FIELD_NUMBER

public static final int REACTIVE_MODE_FINAL_RESPONSE_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_CHUNK_FIELD_NUMBER

public static final int RESPONSE_CHUNK_FIELD_NUMBER
Field Value
Type Description
int

SEND_TIME_FIELD_NUMBER

public static final int SEND_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_MESSAGE_ID_FIELD_NUMBER

public static final int TEXT_MESSAGE_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamingReactiveCompanionSuggestionsResponse getDefaultInstance()
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StreamingReactiveCompanionSuggestionsResponse.Builder newBuilder()
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse.Builder

newBuilder(StreamingReactiveCompanionSuggestionsResponse prototype)

public static StreamingReactiveCompanionSuggestionsResponse.Builder newBuilder(StreamingReactiveCompanionSuggestionsResponse prototype)
Parameter
Name Description
prototype StreamingReactiveCompanionSuggestionsResponse
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse.Builder

parseDelimitedFrom(InputStream input)

public static StreamingReactiveCompanionSuggestionsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingReactiveCompanionSuggestionsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingReactiveCompanionSuggestionsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StreamingReactiveCompanionSuggestionsResponse> parser()
Returns
Type Description
Parser<StreamingReactiveCompanionSuggestionsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnswerRecord()

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

getDefaultInstanceForType()

public StreamingReactiveCompanionSuggestionsResponse getDefaultInstanceForType()
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse

getIntermediateToolCallEvents()

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

getParserForType()

public Parser<StreamingReactiveCompanionSuggestionsResponse> getParserForType()
Returns
Type Description
Parser<StreamingReactiveCompanionSuggestionsResponse>
Overrides

getReactiveModeFinalResponse()

public 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 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 StreamingReactiveCompanionSuggestionsResponse.ResponseCase getResponseCase()
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse.ResponseCase

getResponseChunk()

public String getResponseChunk()

Streamed response text chunks.

string response_chunk = 1;

Returns
Type Description
String

The responseChunk.

getResponseChunkBytes()

public ByteString getResponseChunkBytes()

Streamed response text chunks.

string response_chunk = 1;

Returns
Type Description
ByteString

The bytes for responseChunk.

getSendTime()

public 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 TimestampOrBuilder getSendTimeOrBuilder()

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

.google.protobuf.Timestamp send_time = 9;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public 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 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 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 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 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 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 boolean hasResponseChunk()

Streamed response text chunks.

string response_chunk = 1;

Returns
Type Description
boolean

Whether the responseChunk field is set.

hasSendTime()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StreamingReactiveCompanionSuggestionsResponse.Builder newBuilderForType()
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected StreamingReactiveCompanionSuggestionsResponse.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse.Builder
Overrides

toBuilder()

public StreamingReactiveCompanionSuggestionsResponse.Builder toBuilder()
Returns
Type Description
StreamingReactiveCompanionSuggestionsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException