com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1StreamAssistResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1StreamAssistResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1StreamAssistResponse
extends com.google.api.client.json.GenericJson

Response for the AssistantService.StreamAssist method.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1StreamAssistResponse()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1StreamAssistResponse	clone()
GoogleCloudDiscoveryengineV1AssistAnswer	getAnswer() Assist answer resource object containing parts of the assistant's final answer for the user's query.
String	getAssistToken() A global unique ID that identifies the current pair of request and stream of responses.
List<String>	getInvocationTools() The tool names of the tools that were invoked.
GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo	getSessionInfo() Session information.
GoogleCloudDiscoveryengineV1StreamAssistResponse	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1StreamAssistResponse	setAnswer(GoogleCloudDiscoveryengineV1AssistAnswer answer) Assist answer resource object containing parts of the assistant's final answer for the user's query.
GoogleCloudDiscoveryengineV1StreamAssistResponse	setAssistToken(String assistToken) A global unique ID that identifies the current pair of request and stream of responses.
GoogleCloudDiscoveryengineV1StreamAssistResponse	setInvocationTools(List<String> invocationTools) The tool names of the tools that were invoked.
GoogleCloudDiscoveryengineV1StreamAssistResponse	setSessionInfo(GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo sessionInfo) Session information.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1StreamAssistResponse

public GoogleCloudDiscoveryengineV1StreamAssistResponse()

Method Detail

getAnswer

public GoogleCloudDiscoveryengineV1AssistAnswer getAnswer()

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:

value or null for none

setAnswer

public GoogleCloudDiscoveryengineV1StreamAssistResponse setAnswer(GoogleCloudDiscoveryengineV1AssistAnswer answer)

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.

Parameters:

answer - answer or null for none

getAssistToken

public String getAssistToken()

A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

Returns:

value or null for none

setAssistToken

public GoogleCloudDiscoveryengineV1StreamAssistResponse setAssistToken(String assistToken)

A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

Parameters:

assistToken - assistToken or null for none

getInvocationTools

public List<String> getInvocationTools()

The tool names of the tools that were invoked.

Returns:

value or null for none

setInvocationTools

public GoogleCloudDiscoveryengineV1StreamAssistResponse setInvocationTools(List<String> invocationTools)

The tool names of the tools that were invoked.

Parameters:

invocationTools - invocationTools or null for none

getSessionInfo

public GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo getSessionInfo()

Session information. Only included in the final StreamAssistResponse of the response stream.

Returns:

value or null for none

setSessionInfo

public GoogleCloudDiscoveryengineV1StreamAssistResponse setSessionInfo(GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo sessionInfo)

Session information. Only included in the final StreamAssistResponse of the response stream.

Parameters:

sessionInfo - sessionInfo or null for none

set

public GoogleCloudDiscoveryengineV1StreamAssistResponse set(String fieldName,
                                                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1StreamAssistResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson