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-
(::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,FAILEDorSKIPPED, the response is the last response and AssistAnswer.name will have a value.
#answer=
def answer=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AssistAnswer-
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,FAILEDorSKIPPED, the response is the last response and AssistAnswer.name will have a 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,FAILEDorSKIPPED, the response is the last response and AssistAnswer.name will have a value.
#assist_token
def assist_token() -> ::String- (::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- value (::String) — A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
- (::String) — A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.
#connector_auth_errors
def connector_auth_errors() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::ConnectorAuthError>- (::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::ConnectorAuthError>) — Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.
#connector_auth_errors=
def connector_auth_errors=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::ConnectorAuthError>- value (::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::ConnectorAuthError>) — Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.
- (::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::ConnectorAuthError>) — Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors.
#invocation_tools
def invocation_tools() -> ::Array<::String>- (::Array<::String>) — The tool names of the tools that were invoked.
#invocation_tools=
def invocation_tools=(value) -> ::Array<::String>- value (::Array<::String>) — The tool names of the tools that were invoked.
- (::Array<::String>) — The tool names of the tools that were invoked.
#invoked_skills
def invoked_skills() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::InvokedSkill>- (::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::InvokedSkill>) — The skills executed during the turn.
#invoked_skills=
def invoked_skills=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::InvokedSkill>- value (::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::InvokedSkill>) — The skills executed during the turn.
- (::Array<::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::InvokedSkill>) — The skills executed during the turn.
#session_info
def session_info() -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo- (::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo) — Session information. Only included in the final StreamAssistResponse of the response stream.
#session_info=
def session_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo- value (::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo) — Session information. Only included in the final StreamAssistResponse of the response stream.
- (::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo) — Session information. Only included in the final StreamAssistResponse of the response stream.