Class ConversationTurn.VirtualAgentOutput (0.53.0)

public static final class ConversationTurn.VirtualAgentOutput extends GeneratedMessageV3 implements ConversationTurn.VirtualAgentOutputOrBuilder

The output from the virtual agent.

Protobuf type google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ConversationTurn.VirtualAgentOutput

Static Fields

CURRENT_PAGE_FIELD_NUMBER

public static final int CURRENT_PAGE_FIELD_NUMBER
Field Value
Type Description
int

DIAGNOSTIC_INFO_FIELD_NUMBER

public static final int DIAGNOSTIC_INFO_FIELD_NUMBER
Field Value
Type Description
int

DIFFERENCES_FIELD_NUMBER

public static final int DIFFERENCES_FIELD_NUMBER
Field Value
Type Description
int

SESSION_PARAMETERS_FIELD_NUMBER

public static final int SESSION_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_RESPONSES_FIELD_NUMBER

public static final int TEXT_RESPONSES_FIELD_NUMBER
Field Value
Type Description
int

TRIGGERED_INTENT_FIELD_NUMBER

public static final int TRIGGERED_INTENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversationTurn.VirtualAgentOutput getDefaultInstance()
Returns
Type Description
ConversationTurn.VirtualAgentOutput

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConversationTurn.VirtualAgentOutput.Builder newBuilder()
Returns
Type Description
ConversationTurn.VirtualAgentOutput.Builder

newBuilder(ConversationTurn.VirtualAgentOutput prototype)

public static ConversationTurn.VirtualAgentOutput.Builder newBuilder(ConversationTurn.VirtualAgentOutput prototype)
Parameter
Name Description
prototype ConversationTurn.VirtualAgentOutput
Returns
Type Description
ConversationTurn.VirtualAgentOutput.Builder

parseDelimitedFrom(InputStream input)

public static ConversationTurn.VirtualAgentOutput parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationTurn.VirtualAgentOutput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConversationTurn.VirtualAgentOutput parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversationTurn.VirtualAgentOutput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversationTurn.VirtualAgentOutput parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversationTurn.VirtualAgentOutput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversationTurn.VirtualAgentOutput parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationTurn.VirtualAgentOutput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConversationTurn.VirtualAgentOutput parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationTurn.VirtualAgentOutput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConversationTurn.VirtualAgentOutput parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversationTurn.VirtualAgentOutput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationTurn.VirtualAgentOutput
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConversationTurn.VirtualAgentOutput> parser()
Returns
Type Description
Parser<VirtualAgentOutput>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCurrentPage()

public Page getCurrentPage()

The Page on which the utterance was spoken. Only name and displayName will be set.

.google.cloud.dialogflow.cx.v3.Page current_page = 8;

Returns
Type Description
Page

The currentPage.

getCurrentPageOrBuilder()

public PageOrBuilder getCurrentPageOrBuilder()

The Page on which the utterance was spoken. Only name and displayName will be set.

.google.cloud.dialogflow.cx.v3.Page current_page = 8;

Returns
Type Description
PageOrBuilder

getDefaultInstanceForType()

public ConversationTurn.VirtualAgentOutput getDefaultInstanceForType()
Returns
Type Description
ConversationTurn.VirtualAgentOutput

getDiagnosticInfo()

public Struct getDiagnosticInfo()

Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.

.google.protobuf.Struct diagnostic_info = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Struct

The diagnosticInfo.

getDiagnosticInfoOrBuilder()

public StructOrBuilder getDiagnosticInfoOrBuilder()

Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.

.google.protobuf.Struct diagnostic_info = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
StructOrBuilder

getDifferences(int index)

public TestRunDifference getDifferences(int index)

Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.

repeated .google.cloud.dialogflow.cx.v3.TestRunDifference differences = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
TestRunDifference

getDifferencesCount()

public int getDifferencesCount()

Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.

repeated .google.cloud.dialogflow.cx.v3.TestRunDifference differences = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getDifferencesList()

public List<TestRunDifference> getDifferencesList()

Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.

repeated .google.cloud.dialogflow.cx.v3.TestRunDifference differences = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<TestRunDifference>

getDifferencesOrBuilder(int index)

public TestRunDifferenceOrBuilder getDifferencesOrBuilder(int index)

Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.

repeated .google.cloud.dialogflow.cx.v3.TestRunDifference differences = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
TestRunDifferenceOrBuilder

getDifferencesOrBuilderList()

public List<? extends TestRunDifferenceOrBuilder> getDifferencesOrBuilderList()

Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.

repeated .google.cloud.dialogflow.cx.v3.TestRunDifference differences = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.TestRunDifferenceOrBuilder>

getParserForType()

public Parser<ConversationTurn.VirtualAgentOutput> getParserForType()
Returns
Type Description
Parser<VirtualAgentOutput>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionParameters()

public Struct getSessionParameters()

The session parameters available to the bot at this point.

.google.protobuf.Struct session_parameters = 4;

Returns
Type Description
Struct

The sessionParameters.

getSessionParametersOrBuilder()

public StructOrBuilder getSessionParametersOrBuilder()

The session parameters available to the bot at this point.

.google.protobuf.Struct session_parameters = 4;

Returns
Type Description
StructOrBuilder

getStatus()

public Status getStatus()

Response error from the agent in the test result. If set, other output is empty.

.google.rpc.Status status = 10;

Returns
Type Description
com.google.rpc.Status

The status.

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

Response error from the agent in the test result. If set, other output is empty.

.google.rpc.Status status = 10;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getTextResponses(int index)

public ResponseMessage.Text getTextResponses(int index)

The text responses from the agent for the turn.

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text_responses = 9;

Parameter
Name Description
index int
Returns
Type Description
ResponseMessage.Text

getTextResponsesCount()

public int getTextResponsesCount()

The text responses from the agent for the turn.

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text_responses = 9;

Returns
Type Description
int

getTextResponsesList()

public List<ResponseMessage.Text> getTextResponsesList()

The text responses from the agent for the turn.

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text_responses = 9;

Returns
Type Description
List<Text>

getTextResponsesOrBuilder(int index)

public ResponseMessage.TextOrBuilder getTextResponsesOrBuilder(int index)

The text responses from the agent for the turn.

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text_responses = 9;

Parameter
Name Description
index int
Returns
Type Description
ResponseMessage.TextOrBuilder

getTextResponsesOrBuilderList()

public List<? extends ResponseMessage.TextOrBuilder> getTextResponsesOrBuilderList()

The text responses from the agent for the turn.

repeated .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text_responses = 9;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.ResponseMessage.TextOrBuilder>

getTriggeredIntent()

public Intent getTriggeredIntent()

The Intent that triggered the response. Only name and displayName will be set.

.google.cloud.dialogflow.cx.v3.Intent triggered_intent = 7;

Returns
Type Description
Intent

The triggeredIntent.

getTriggeredIntentOrBuilder()

public IntentOrBuilder getTriggeredIntentOrBuilder()

The Intent that triggered the response. Only name and displayName will be set.

.google.cloud.dialogflow.cx.v3.Intent triggered_intent = 7;

Returns
Type Description
IntentOrBuilder

hasCurrentPage()

public boolean hasCurrentPage()

The Page on which the utterance was spoken. Only name and displayName will be set.

.google.cloud.dialogflow.cx.v3.Page current_page = 8;

Returns
Type Description
boolean

Whether the currentPage field is set.

hasDiagnosticInfo()

public boolean hasDiagnosticInfo()

Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.

.google.protobuf.Struct diagnostic_info = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the diagnosticInfo field is set.

hasSessionParameters()

public boolean hasSessionParameters()

The session parameters available to the bot at this point.

.google.protobuf.Struct session_parameters = 4;

Returns
Type Description
boolean

Whether the sessionParameters field is set.

hasStatus()

public boolean hasStatus()

Response error from the agent in the test result. If set, other output is empty.

.google.rpc.Status status = 10;

Returns
Type Description
boolean

Whether the status field is set.

hasTriggeredIntent()

public boolean hasTriggeredIntent()

The Intent that triggered the response. Only name and displayName will be set.

.google.cloud.dialogflow.cx.v3.Intent triggered_intent = 7;

Returns
Type Description
boolean

Whether the triggeredIntent field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConversationTurn.VirtualAgentOutput.Builder newBuilderForType()
Returns
Type Description
ConversationTurn.VirtualAgentOutput.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversationTurn.VirtualAgentOutput.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversationTurn.VirtualAgentOutput.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConversationTurn.VirtualAgentOutput.Builder toBuilder()
Returns
Type Description
ConversationTurn.VirtualAgentOutput.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException