Interface SessionOutputOrBuilder (0.1.0)

public interface SessionOutputOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudio()

public abstract ByteString getAudio()

Output audio from the CES agent.

bytes audio = 2;

Returns
Type	Description
ByteString	The audio.

getCitations()

public abstract Citations getCitations()

Citations that provide the source information for the agent's generated text.

.google.cloud.ces.v1.Citations citations = 8;

Returns
Type	Description
Citations	The citations.

getCitationsOrBuilder()

public abstract CitationsOrBuilder getCitationsOrBuilder()

Citations that provide the source information for the agent's generated text.

.google.cloud.ces.v1.Citations citations = 8;

Returns
Type	Description
CitationsOrBuilder

getDiagnosticInfo()

public abstract SessionOutput.DiagnosticInfo getDiagnosticInfo()

Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with turn_completed=true) for each turn.

.google.cloud.ces.v1.SessionOutput.DiagnosticInfo diagnostic_info = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SessionOutput.DiagnosticInfo	The diagnosticInfo.

getDiagnosticInfoOrBuilder()

public abstract SessionOutput.DiagnosticInfoOrBuilder getDiagnosticInfoOrBuilder()

Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with turn_completed=true) for each turn.

.google.cloud.ces.v1.SessionOutput.DiagnosticInfo diagnostic_info = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SessionOutput.DiagnosticInfoOrBuilder

getEndSession()

public abstract EndSession getEndSession()

Indicates the session has ended.

.google.cloud.ces.v1.EndSession end_session = 9;

Returns
Type	Description
EndSession	The endSession.

getEndSessionOrBuilder()

public abstract EndSessionOrBuilder getEndSessionOrBuilder()

Indicates the session has ended.

.google.cloud.ces.v1.EndSession end_session = 9;

Returns
Type	Description
EndSessionOrBuilder

getGoogleSearchSuggestions()

public abstract GoogleSearchSuggestions getGoogleSearchSuggestions()

The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.

.google.cloud.ces.v1.GoogleSearchSuggestions google_search_suggestions = 10;

Returns
Type	Description
GoogleSearchSuggestions	The googleSearchSuggestions.

getGoogleSearchSuggestionsOrBuilder()

public abstract GoogleSearchSuggestionsOrBuilder getGoogleSearchSuggestionsOrBuilder()

The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.

.google.cloud.ces.v1.GoogleSearchSuggestions google_search_suggestions = 10;

Returns
Type	Description
GoogleSearchSuggestionsOrBuilder

getOutputTypeCase()

public abstract SessionOutput.OutputTypeCase getOutputTypeCase()

Returns
Type	Description
SessionOutput.OutputTypeCase

getPayload()

public abstract Struct getPayload()

Custom payload with structured output from the CES agent.

.google.protobuf.Struct payload = 11;

Returns
Type	Description
Struct	The payload.

getPayloadOrBuilder()

public abstract StructOrBuilder getPayloadOrBuilder()

Custom payload with structured output from the CES agent.

.google.protobuf.Struct payload = 11;

Returns
Type	Description
StructOrBuilder

getText()

public abstract String getText()

Output text from the CES agent.

string text = 1;

Returns
Type	Description
String	The text.

getTextBytes()

public abstract ByteString getTextBytes()

Output text from the CES agent.

string text = 1;

Returns
Type	Description
ByteString	The bytes for text.

getToolCalls()

public abstract ToolCalls getToolCalls()

Request for the client to execute the tools.

.google.cloud.ces.v1.ToolCalls tool_calls = 3;

Returns
Type	Description
ToolCalls	The toolCalls.

getToolCallsOrBuilder()

public abstract ToolCallsOrBuilder getToolCallsOrBuilder()

Request for the client to execute the tools.

.google.cloud.ces.v1.ToolCalls tool_calls = 3;

Returns
Type	Description
ToolCallsOrBuilder

getTurnCompleted()

public abstract boolean getTurnCompleted()

If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn.

bool turn_completed = 4;

Returns
Type	Description
boolean	The turnCompleted.

getTurnIndex()

public abstract int getTurnIndex()

Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.

int32 turn_index = 6;

Returns
Type	Description
int	The turnIndex.

hasAudio()

public abstract boolean hasAudio()

Output audio from the CES agent.

bytes audio = 2;

Returns
Type	Description
boolean	Whether the audio field is set.

hasCitations()

public abstract boolean hasCitations()

Citations that provide the source information for the agent's generated text.

.google.cloud.ces.v1.Citations citations = 8;

Returns
Type	Description
boolean	Whether the citations field is set.

hasDiagnosticInfo()

public abstract boolean hasDiagnosticInfo()

Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with turn_completed=true) for each turn.

.google.cloud.ces.v1.SessionOutput.DiagnosticInfo diagnostic_info = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the diagnosticInfo field is set.

hasEndSession()

public abstract boolean hasEndSession()

Indicates the session has ended.

.google.cloud.ces.v1.EndSession end_session = 9;

Returns
Type	Description
boolean	Whether the endSession field is set.

hasGoogleSearchSuggestions()

public abstract boolean hasGoogleSearchSuggestions()

The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.

.google.cloud.ces.v1.GoogleSearchSuggestions google_search_suggestions = 10;

Returns
Type	Description
boolean	Whether the googleSearchSuggestions field is set.

hasPayload()

public abstract boolean hasPayload()

Custom payload with structured output from the CES agent.

.google.protobuf.Struct payload = 11;

Returns
Type	Description
boolean	Whether the payload field is set.

hasText()

public abstract boolean hasText()

Output text from the CES agent.

string text = 1;

Returns
Type	Description
boolean	Whether the text field is set.

hasToolCalls()

public abstract boolean hasToolCalls()

Request for the client to execute the tools.

.google.cloud.ces.v1.ToolCalls tool_calls = 3;

Returns
Type	Description
boolean	Whether the toolCalls field is set.