public final class SessionOutput extends GeneratedMessage implements SessionOutputOrBuilder
Output for the session.
Protobuf type google.cloud.ces.v1.SessionOutput
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
AUDIO_FIELD_NUMBER
public static final int AUDIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CITATIONS_FIELD_NUMBER
public static final int CITATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DIAGNOSTIC_INFO_FIELD_NUMBER
public static final int DIAGNOSTIC_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
END_SESSION_FIELD_NUMBER
public static final int END_SESSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GOOGLE_SEARCH_SUGGESTIONS_FIELD_NUMBER
public static final int GOOGLE_SEARCH_SUGGESTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAYLOAD_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_CALLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TURN_COMPLETED_FIELD_NUMBER
public static final int TURN_COMPLETED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TURN_INDEX_FIELD_NUMBER
public static final int TURN_INDEX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SessionOutput getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SessionOutput.Builder newBuilder()
newBuilder(SessionOutput prototype)
public static SessionOutput.Builder newBuilder(SessionOutput prototype)
public static SessionOutput parseDelimitedFrom(InputStream input)
public static SessionOutput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SessionOutput parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SessionOutput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SessionOutput parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionOutput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionOutput parseFrom(CodedInputStream input)
public static SessionOutput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SessionOutput parseFrom(InputStream input)
public static SessionOutput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SessionOutput parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SessionOutput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SessionOutput> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAudio()
public ByteString getAudio()
Output audio from the CES agent.
bytes audio = 2;
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.
|
getCitationsOrBuilder()
public CitationsOrBuilder getCitationsOrBuilder()
Citations that provide the source information for the agent's generated
text.
.google.cloud.ces.v1.Citations citations = 8;
getDefaultInstanceForType()
public SessionOutput getDefaultInstanceForType()
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];
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];
getEndSession()
public EndSession getEndSession()
Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
| Returns |
| Type |
Description |
EndSession |
The endSession.
|
getEndSessionOrBuilder()
public EndSessionOrBuilder getEndSessionOrBuilder()
Indicates the session has ended.
.google.cloud.ces.v1.EndSession end_session = 9;
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;
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;
getOutputTypeCase()
public SessionOutput.OutputTypeCase getOutputTypeCase()
getParserForType()
public Parser<SessionOutput> getParserForType()
Overrides
getPayload()
public Struct getPayload()
Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
| Returns |
| Type |
Description |
Struct |
The payload.
|
getPayloadOrBuilder()
public StructOrBuilder getPayloadOrBuilder()
Custom payload with structured output from the CES agent.
.google.protobuf.Struct payload = 11;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
public ToolCallsOrBuilder getToolCallsOrBuilder()
Request for the client to execute the tools.
.google.cloud.ces.v1.ToolCalls tool_calls = 3;
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()
Output text from the CES agent.
string text = 1;
| Returns |
| Type |
Description |
boolean |
Whether the text field is set.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SessionOutput.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SessionOutput.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public SessionOutput.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
