Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse (v2.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse.

Response for the AssistantService.StreamAssist method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#answer

def answer() -> ::Google::Cloud::DiscoveryEngine::V1::AssistAnswer
Returns
  • (::Google::Cloud::DiscoveryEngine::V1::AssistAnswer) — Assist answer resource object containing parts of the assistant's final answer for the user's query.

    Not present if the current response doesn't add anything to previously sent AssistAnswer.replies.

    Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. [AssistAnswer.name][] won't be filled.

    If the state is SUCCEEDED, FAILED or SKIPPED, the response is the last response and [AssistAnswer.name][] will have a value.

#answer=

def answer=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AssistAnswer
Parameter
  • value (::Google::Cloud::DiscoveryEngine::V1::AssistAnswer) — Assist answer resource object containing parts of the assistant's final answer for the user's query.

    Not present if the current response doesn't add anything to previously sent AssistAnswer.replies.

    Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. [AssistAnswer.name][] won't be filled.

    If the state is SUCCEEDED, FAILED or SKIPPED, the response is the last response and [AssistAnswer.name][] will have a value.

Returns
  • (::Google::Cloud::DiscoveryEngine::V1::AssistAnswer) — Assist answer resource object containing parts of the assistant's final answer for the user's query.

    Not present if the current response doesn't add anything to previously sent AssistAnswer.replies.

    Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. [AssistAnswer.name][] won't be filled.

    If the state is SUCCEEDED, FAILED or SKIPPED, the response is the last response and [AssistAnswer.name][] will have a value.

#assist_token

def assist_token() -> ::String
Returns
  • (::String) — A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

#assist_token=

def assist_token=(value) -> ::String
Parameter
  • value (::String) — A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
Returns
  • (::String) — A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

#session_info

def session_info() -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo
Returns

#session_info=

def session_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo
Parameter
Returns