Class StreamingReactiveCompanionSuggestionsResponse (2.52.0)

StreamingReactiveCompanionSuggestionsResponse(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

The response message for Participants.StreamingReactiveCompanionSuggestions.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
response_chunk str
Streamed response text chunks. This field is a member of oneof_ response.
status google.rpc.status_pb2.Status
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). This field is a member of oneof_ response.
reactive_mode_final_response google.cloud.dialogflow_v2.types.StreamingReactiveCompanionSuggestionsResponse.ReactiveModeResponse
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. This field is a member of oneof_ response.
intermediate_tool_call_events google.cloud.dialogflow_v2.types.ToolCallEvents
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. This field is a member of oneof_ response.
is_final bool
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.
answer_record str
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.
text_message_id str
Required. The unique message identifier corresponding to the human agent query that generated this response chunk.
send_time google.protobuf.timestamp_pb2.Timestamp
The timestamp when the response chunk was sent by the service.

Classes

ReactiveModeResponse

ReactiveModeResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The complete response generated by the reactive mode capturing the entire accumulated streaming response, grounding metadata, and tool calls.