public static final class SessionOutput.Builder extends GeneratedMessage.Builder<SessionOutput.Builder> implements SessionOutputOrBuilderOutput for the session.
Protobuf type google.cloud.ces.v1.SessionOutput
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SessionOutput.BuilderImplements
SessionOutputOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SessionOutput build()| Returns | |
|---|---|
| Type | Description |
SessionOutput |
|
buildPartial()
public SessionOutput buildPartial()| Returns | |
|---|---|
| Type | Description |
SessionOutput |
|
clear()
public SessionOutput.Builder clear()| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
clearAudio()
public SessionOutput.Builder clearAudio()Output audio from the CES agent.
bytes audio = 2;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
clearCitations()
public SessionOutput.Builder clearCitations()Citations that provide the source information for the agent's generated text.
.google.cloud.ces.v1.Citations citations = 8;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
clearDiagnosticInfo()
public SessionOutput.Builder clearDiagnosticInfo() 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.Builder |
|
clearEndSession()
public SessionOutput.Builder clearEndSession()Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
clearGoogleSearchSuggestions()
public SessionOutput.Builder clearGoogleSearchSuggestions()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 |
SessionOutput.Builder |
|
clearOutputType()
public SessionOutput.Builder clearOutputType()| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
clearPayload()
public SessionOutput.Builder clearPayload()Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
clearText()
public SessionOutput.Builder clearText()Output text from the CES agent.
string text = 1;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
clearToolCalls()
public SessionOutput.Builder clearToolCalls()Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
clearTurnCompleted()
public SessionOutput.Builder clearTurnCompleted()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 |
SessionOutput.Builder |
This builder for chaining. |
clearTurnIndex()
public SessionOutput.Builder clearTurnIndex()Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
int32 turn_index = 6;
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
getAudio()
public ByteString getAudio()Output audio from the CES agent.
bytes audio = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The audio. |
getCitations()
public 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. |
getCitationsBuilder()
public Citations.Builder getCitationsBuilder()Citations that provide the source information for the agent's generated text.
.google.cloud.ces.v1.Citations citations = 8;
| Returns | |
|---|---|
| Type | Description |
Citations.Builder |
|
getCitationsOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public SessionOutput getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SessionOutput |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDiagnosticInfo()
public 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. |
getDiagnosticInfoBuilder()
public SessionOutput.DiagnosticInfo.Builder getDiagnosticInfoBuilder() 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.Builder |
|
getDiagnosticInfoOrBuilder()
public 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 EndSession getEndSession()Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Returns | |
|---|---|
| Type | Description |
EndSession |
The endSession. |
getEndSessionBuilder()
public EndSession.Builder getEndSessionBuilder()Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Returns | |
|---|---|
| Type | Description |
EndSession.Builder |
|
getEndSessionOrBuilder()
public EndSessionOrBuilder getEndSessionOrBuilder()Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Returns | |
|---|---|
| Type | Description |
EndSessionOrBuilder |
|
getGoogleSearchSuggestions()
public 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. |
getGoogleSearchSuggestionsBuilder()
public GoogleSearchSuggestions.Builder getGoogleSearchSuggestionsBuilder()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.Builder |
|
getGoogleSearchSuggestionsOrBuilder()
public 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 SessionOutput.OutputTypeCase getOutputTypeCase()| Returns | |
|---|---|
| Type | Description |
SessionOutput.OutputTypeCase |
|
getPayload()
public Struct getPayload()Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Returns | |
|---|---|
| Type | Description |
Struct |
The payload. |
getPayloadBuilder()
public Struct.Builder getPayloadBuilder()Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getPayloadOrBuilder()
public StructOrBuilder getPayloadOrBuilder()Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getText()
public String getText()Output text from the CES agent.
string text = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The text. |
getTextBytes()
public ByteString getTextBytes()Output text from the CES agent.
string text = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for text. |
getToolCalls()
public ToolCalls getToolCalls()Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Returns | |
|---|---|
| Type | Description |
ToolCalls |
The toolCalls. |
getToolCallsBuilder()
public ToolCalls.Builder getToolCallsBuilder()Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Returns | |
|---|---|
| Type | Description |
ToolCalls.Builder |
|
getToolCallsOrBuilder()
public ToolCallsOrBuilder getToolCallsOrBuilder()Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Returns | |
|---|---|
| Type | Description |
ToolCallsOrBuilder |
|
getTurnCompleted()
public 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 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 boolean hasAudio()Output audio from the CES agent.
bytes audio = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the audio field is set. |
hasCitations()
public 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 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 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 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 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 boolean hasText()Output text from the CES agent.
string text = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the text field is set. |
hasToolCalls()
public 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCitations(Citations value)
public SessionOutput.Builder mergeCitations(Citations value)Citations that provide the source information for the agent's generated text.
.google.cloud.ces.v1.Citations citations = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
Citations |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergeDiagnosticInfo(SessionOutput.DiagnosticInfo value)
public SessionOutput.Builder mergeDiagnosticInfo(SessionOutput.DiagnosticInfo value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
SessionOutput.DiagnosticInfo |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergeEndSession(EndSession value)
public SessionOutput.Builder mergeEndSession(EndSession value)Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
EndSession |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergeFrom(SessionOutput other)
public SessionOutput.Builder mergeFrom(SessionOutput other)| Parameter | |
|---|---|
| Name | Description |
other |
SessionOutput |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SessionOutput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SessionOutput.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergeGoogleSearchSuggestions(GoogleSearchSuggestions value)
public SessionOutput.Builder mergeGoogleSearchSuggestions(GoogleSearchSuggestions value)The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.
.google.cloud.ces.v1.GoogleSearchSuggestions google_search_suggestions = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
GoogleSearchSuggestions |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergePayload(Struct value)
public SessionOutput.Builder mergePayload(Struct value)Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
mergeToolCalls(ToolCalls value)
public SessionOutput.Builder mergeToolCalls(ToolCalls value)Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ToolCalls |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setAudio(ByteString value)
public SessionOutput.Builder setAudio(ByteString value)Output audio from the CES agent.
bytes audio = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe audio to set. |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
setCitations(Citations value)
public SessionOutput.Builder setCitations(Citations value)Citations that provide the source information for the agent's generated text.
.google.cloud.ces.v1.Citations citations = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
Citations |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setCitations(Citations.Builder builderForValue)
public SessionOutput.Builder setCitations(Citations.Builder builderForValue)Citations that provide the source information for the agent's generated text.
.google.cloud.ces.v1.Citations citations = 8;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Citations.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setDiagnosticInfo(SessionOutput.DiagnosticInfo value)
public SessionOutput.Builder setDiagnosticInfo(SessionOutput.DiagnosticInfo value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
SessionOutput.DiagnosticInfo |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setDiagnosticInfo(SessionOutput.DiagnosticInfo.Builder builderForValue)
public SessionOutput.Builder setDiagnosticInfo(SessionOutput.DiagnosticInfo.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SessionOutput.DiagnosticInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setEndSession(EndSession value)
public SessionOutput.Builder setEndSession(EndSession value)Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
EndSession |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setEndSession(EndSession.Builder builderForValue)
public SessionOutput.Builder setEndSession(EndSession.Builder builderForValue)Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EndSession.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setGoogleSearchSuggestions(GoogleSearchSuggestions value)
public SessionOutput.Builder setGoogleSearchSuggestions(GoogleSearchSuggestions value)The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.
.google.cloud.ces.v1.GoogleSearchSuggestions google_search_suggestions = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
GoogleSearchSuggestions |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setGoogleSearchSuggestions(GoogleSearchSuggestions.Builder builderForValue)
public SessionOutput.Builder setGoogleSearchSuggestions(GoogleSearchSuggestions.Builder builderForValue)The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.
.google.cloud.ces.v1.GoogleSearchSuggestions google_search_suggestions = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GoogleSearchSuggestions.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setPayload(Struct value)
public SessionOutput.Builder setPayload(Struct value)Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setPayload(Struct.Builder builderForValue)
public SessionOutput.Builder setPayload(Struct.Builder builderForValue)Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setText(String value)
public SessionOutput.Builder setText(String value)Output text from the CES agent.
string text = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe text to set. |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
setTextBytes(ByteString value)
public SessionOutput.Builder setTextBytes(ByteString value)Output text from the CES agent.
string text = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for text to set. |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
setToolCalls(ToolCalls value)
public SessionOutput.Builder setToolCalls(ToolCalls value)Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ToolCalls |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setToolCalls(ToolCalls.Builder builderForValue)
public SessionOutput.Builder setToolCalls(ToolCalls.Builder builderForValue)Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ToolCalls.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
|
setTurnCompleted(boolean value)
public SessionOutput.Builder setTurnCompleted(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe turnCompleted to set. |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |
setTurnIndex(int value)
public SessionOutput.Builder setTurnIndex(int value)Indicates the sequential order of conversation turn to which this output belongs to, starting from 1.
int32 turn_index = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe turnIndex to set. |
| Returns | |
|---|---|
| Type | Description |
SessionOutput.Builder |
This builder for chaining. |