Class SessionOutput (0.1.0)

public final class SessionOutput extends GeneratedMessage implements SessionOutputOrBuilder

Output for the session.

Protobuf type google.cloud.ces.v1.SessionOutput

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SessionOutput

Implements

SessionOutputOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

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()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

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()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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

TOOL_CALLS_FIELD_NUMBER

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()

Returns
Type	Description
SessionOutput

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SessionOutput.Builder newBuilder()

Returns
Type	Description
SessionOutput.Builder

newBuilder(SessionOutput prototype)

public static SessionOutput.Builder newBuilder(SessionOutput prototype)

Parameter
Name	Description
prototype	SessionOutput

Returns
Type	Description
SessionOutput.Builder

parseDelimitedFrom(InputStream input)

public static SessionOutput parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionOutput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SessionOutput parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SessionOutput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SessionOutput parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SessionOutput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SessionOutput parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionOutput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SessionOutput parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionOutput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SessionOutput parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SessionOutput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SessionOutput

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SessionOutput> parser()

Returns
Type	Description
Parser<SessionOutput>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

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

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.

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.

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.

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

getParserForType()

public Parser<SessionOutput> getParserForType()

Returns
Type	Description
Parser<SessionOutput>

Overrides

GeneratedMessage.getParserForType()

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;

Returns
Type	Description
StructOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SessionOutput.Builder newBuilderForType()

Returns
Type	Description
SessionOutput.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SessionOutput.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SessionOutput.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SessionOutput.Builder toBuilder()

Returns
Type	Description
SessionOutput.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException