Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::StreamingReactiveCompanionSuggestionsResponse (v1.18.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::StreamingReactiveCompanionSuggestionsResponse.

The response message for Participants.StreamingReactiveCompanionSuggestions.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#answer_record

def answer_record() -> ::String
Returns
  • (::String) — 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.

#intermediate_tool_call_events

def intermediate_tool_call_events() -> ::Google::Cloud::Dialogflow::V2::ToolCallEvents
Returns
  • (::Google::Cloud::Dialogflow::V2::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.

    Note: The following fields are mutually exclusive: intermediate_tool_call_events, response_chunk, status, reactive_mode_final_response. If a field in that set is populated, all other fields in the set will automatically be cleared.

#is_final

def is_final() -> ::Boolean
Returns
  • (::Boolean) — 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.

#reactive_mode_final_response

def reactive_mode_final_response() -> ::Google::Cloud::Dialogflow::V2::StreamingReactiveCompanionSuggestionsResponse::ReactiveModeResponse
Returns
  • (::Google::Cloud::Dialogflow::V2::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.

    Note: The following fields are mutually exclusive: reactive_mode_final_response, response_chunk, status, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

#response_chunk

def response_chunk() -> ::String
Returns
  • (::String) — Streamed response text chunks.

    Note: The following fields are mutually exclusive: response_chunk, status, reactive_mode_final_response, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

#response_chunk=

def response_chunk=(value) -> ::String
Parameter
  • value (::String) — Streamed response text chunks.

    Note: The following fields are mutually exclusive: response_chunk, status, reactive_mode_final_response, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Streamed response text chunks.

    Note: The following fields are mutually exclusive: response_chunk, status, reactive_mode_final_response, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

#send_time

def send_time() -> ::Google::Protobuf::Timestamp
Returns

#send_time=

def send_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#status

def status() -> ::Google::Rpc::Status
Returns
  • (::Google::Rpc::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).

    Note: The following fields are mutually exclusive: status, response_chunk, reactive_mode_final_response, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

#status=

def status=(value) -> ::Google::Rpc::Status
Parameter
  • value (::Google::Rpc::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).

    Note: The following fields are mutually exclusive: status, response_chunk, reactive_mode_final_response, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Rpc::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).

    Note: The following fields are mutually exclusive: status, response_chunk, reactive_mode_final_response, intermediate_tool_call_events. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_message_id

def text_message_id() -> ::String
Returns
  • (::String) — Required. The unique message identifier corresponding to the human agent query that generated this response chunk.

#text_message_id=

def text_message_id=(value) -> ::String
Parameter
  • value (::String) — Required. The unique message identifier corresponding to the human agent query that generated this response chunk.
Returns
  • (::String) — Required. The unique message identifier corresponding to the human agent query that generated this response chunk.