Interface StreamAssistResponseOrBuilder (0.66.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.v1.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.v1.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.

getSessionInfo()

public abstract StreamAssistResponse.SessionInfo getSessionInfo()

Session information.

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

Returns
Type Description
StreamAssistResponse.SessionInfo

The sessionInfo.

getSessionInfoOrBuilder()

public abstract StreamAssistResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()

Session information.

.google.cloud.discoveryengine.v1.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.v1.AssistAnswer answer = 1;

Returns
Type Description
boolean

Whether the answer field is set.

hasSessionInfo()

public abstract boolean hasSessionInfo()

Session information.

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

Returns
Type Description
boolean

Whether the sessionInfo field is set.