Interface StreamAssistResponseOrBuilder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface StreamAssistResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswer()

public abstract AssistAnswer 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.

.google.cloud.discoveryengine.v1beta.AssistAnswer answer = 1;

Returns
Type	Description
AssistAnswer	The answer.

getAnswerOrBuilder()

public abstract AssistAnswerOrBuilder getAnswerOrBuilder()

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.

.google.cloud.discoveryengine.v1beta.AssistAnswer answer = 1;

Returns
Type	Description
AssistAnswerOrBuilder

getAssistToken()

public abstract String getAssistToken()

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

string assist_token = 4;

Returns
Type	Description
String	The assistToken.

getAssistTokenBytes()

public abstract ByteString getAssistTokenBytes()

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

string assist_token = 4;

Returns
Type	Description
ByteString	The bytes for assistToken.

getInvocationTools(int index)

public abstract String getInvocationTools(int index)

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The invocationTools at the given index.

getInvocationToolsBytes(int index)

public abstract ByteString getInvocationToolsBytes(int index)

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the invocationTools at the given index.

getInvocationToolsCount()

public abstract int getInvocationToolsCount()

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Returns
Type	Description
int	The count of invocationTools.

getInvocationToolsList()

public abstract List<String> getInvocationToolsList()

The tool names of the tools that were invoked.

repeated string invocation_tools = 8;

Returns
Type	Description
List<String>	A list containing the invocationTools.

getInvokedSkills(int index)

public abstract StreamAssistResponse.InvokedSkill getInvokedSkills(int index)

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
StreamAssistResponse.InvokedSkill

getInvokedSkillsCount()

public abstract int getInvokedSkillsCount()

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Returns
Type	Description
int

getInvokedSkillsList()

public abstract List<StreamAssistResponse.InvokedSkill> getInvokedSkillsList()

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Returns
Type	Description
List<InvokedSkill>

getInvokedSkillsOrBuilder(int index)

public abstract StreamAssistResponse.InvokedSkillOrBuilder getInvokedSkillsOrBuilder(int index)

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
StreamAssistResponse.InvokedSkillOrBuilder

getInvokedSkillsOrBuilderList()

public abstract List<? extends StreamAssistResponse.InvokedSkillOrBuilder> getInvokedSkillsOrBuilderList()

The skills executed during the turn.

repeated .google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkill invoked_skills = 10;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.StreamAssistResponse.InvokedSkillOrBuilder>

getSessionInfo()

public abstract StreamAssistResponse.SessionInfo getSessionInfo()

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

.google.cloud.discoveryengine.v1beta.StreamAssistResponse.SessionInfo session_info = 2;

Returns
Type	Description
StreamAssistResponse.SessionInfo	The sessionInfo.

getSessionInfoOrBuilder()

public abstract StreamAssistResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()

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

.google.cloud.discoveryengine.v1beta.StreamAssistResponse.SessionInfo session_info = 2;

Returns
Type	Description
StreamAssistResponse.SessionInfoOrBuilder

hasAnswer()

public abstract boolean hasAnswer()

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.

.google.cloud.discoveryengine.v1beta.AssistAnswer answer = 1;

Returns
Type	Description
boolean	Whether the answer field is set.

hasSessionInfo()

public abstract boolean hasSessionInfo()

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

.google.cloud.discoveryengine.v1beta.StreamAssistResponse.SessionInfo session_info = 2;

Returns
Type	Description
boolean	Whether the sessionInfo field is set.