Class EvaluationResult.GoldenResult.TurnReplayResult (0.3.0)

public static final class EvaluationResult.GoldenResult.TurnReplayResult extends GeneratedMessage implements EvaluationResult.GoldenResult.TurnReplayResultOrBuilder

The result of running a single turn of the golden conversation.

Protobuf type google.cloud.ces.v1beta.EvaluationResult.GoldenResult.TurnReplayResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > EvaluationResult.GoldenResult.TurnReplayResult

Static Fields

CONVERSATION_FIELD_NUMBER

public static final int CONVERSATION_FIELD_NUMBER
Field Value
Type Description
int

ERROR_INFO_FIELD_NUMBER

public static final int ERROR_INFO_FIELD_NUMBER
Field Value
Type Description
int

EXPECTATION_OUTCOME_FIELD_NUMBER

public static final int EXPECTATION_OUTCOME_FIELD_NUMBER
Field Value
Type Description
int

HALLUCINATION_RESULT_FIELD_NUMBER

public static final int HALLUCINATION_RESULT_FIELD_NUMBER
Field Value
Type Description
int

OVERALL_TOOL_INVOCATION_RESULT_FIELD_NUMBER

public static final int OVERALL_TOOL_INVOCATION_RESULT_FIELD_NUMBER
Field Value
Type Description
int

SEMANTIC_SIMILARITY_RESULT_FIELD_NUMBER

public static final int SEMANTIC_SIMILARITY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

SPAN_LATENCIES_FIELD_NUMBER

public static final int SPAN_LATENCIES_FIELD_NUMBER
Field Value
Type Description
int

TOOL_CALL_LATENCIES_FIELD_NUMBER

public static final int TOOL_CALL_LATENCIES_FIELD_NUMBER
Field Value
Type Description
int

TOOL_INVOCATION_SCORE_FIELD_NUMBER

public static final int TOOL_INVOCATION_SCORE_FIELD_NUMBER
Field Value
Type Description
int

TOOL_ORDERED_INVOCATION_SCORE_FIELD_NUMBER

public static final int TOOL_ORDERED_INVOCATION_SCORE_FIELD_NUMBER
Field Value
Type Description
int

TURN_LATENCY_FIELD_NUMBER

public static final int TURN_LATENCY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EvaluationResult.GoldenResult.TurnReplayResult getDefaultInstance()
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult

getDescriptor()

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

newBuilder()

public static EvaluationResult.GoldenResult.TurnReplayResult.Builder newBuilder()
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult.Builder

newBuilder(EvaluationResult.GoldenResult.TurnReplayResult prototype)

public static EvaluationResult.GoldenResult.TurnReplayResult.Builder newBuilder(EvaluationResult.GoldenResult.TurnReplayResult prototype)
Parameter
Name Description
prototype EvaluationResult.GoldenResult.TurnReplayResult
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult.Builder

parseDelimitedFrom(InputStream input)

public static EvaluationResult.GoldenResult.TurnReplayResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.GoldenResult.TurnReplayResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.GoldenResult.TurnReplayResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EvaluationResult.GoldenResult.TurnReplayResult> parser()
Returns
Type Description
Parser<TurnReplayResult>

Methods

equals(Object obj)

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

getConversation()

public String getConversation()

Output only. The conversation that was generated for this turn.

string conversation = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The conversation.

getConversationBytes()

public ByteString getConversationBytes()

Output only. The conversation that was generated for this turn.

string conversation = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for conversation.

getDefaultInstanceForType()

public EvaluationResult.GoldenResult.TurnReplayResult getDefaultInstanceForType()
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult

getErrorInfo()

public EvaluationErrorInfo getErrorInfo()

Output only. Information about the error that occurred during this turn.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationErrorInfo

The errorInfo.

getErrorInfoOrBuilder()

public EvaluationErrorInfoOrBuilder getErrorInfoOrBuilder()

Output only. Information about the error that occurred during this turn.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationErrorInfoOrBuilder

getExpectationOutcome(int index)

public EvaluationResult.GoldenExpectationOutcome getExpectationOutcome(int index)

Output only. The outcome of each expectation.

repeated .google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcome expectation_outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.GoldenExpectationOutcome

getExpectationOutcomeCount()

public int getExpectationOutcomeCount()

Output only. The outcome of each expectation.

repeated .google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcome expectation_outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getExpectationOutcomeList()

public List<EvaluationResult.GoldenExpectationOutcome> getExpectationOutcomeList()

Output only. The outcome of each expectation.

repeated .google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcome expectation_outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<GoldenExpectationOutcome>

getExpectationOutcomeOrBuilder(int index)

public EvaluationResult.GoldenExpectationOutcomeOrBuilder getExpectationOutcomeOrBuilder(int index)

Output only. The outcome of each expectation.

repeated .google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcome expectation_outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.GoldenExpectationOutcomeOrBuilder

getExpectationOutcomeOrBuilderList()

public List<? extends EvaluationResult.GoldenExpectationOutcomeOrBuilder> getExpectationOutcomeOrBuilderList()

Output only. The outcome of each expectation.

repeated .google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcome expectation_outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcomeOrBuilder>

getHallucinationResult()

public EvaluationResult.HallucinationResult getHallucinationResult()

Output only. The result of the hallucination check.

.google.cloud.ces.v1beta.EvaluationResult.HallucinationResult hallucination_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.HallucinationResult

The hallucinationResult.

getHallucinationResultOrBuilder()

public EvaluationResult.HallucinationResultOrBuilder getHallucinationResultOrBuilder()

Output only. The result of the hallucination check.

.google.cloud.ces.v1beta.EvaluationResult.HallucinationResult hallucination_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.HallucinationResultOrBuilder

getOverallToolInvocationResult()

public EvaluationResult.OverallToolInvocationResult getOverallToolInvocationResult()

Output only. The result of the overall tool invocation check.

.google.cloud.ces.v1beta.EvaluationResult.OverallToolInvocationResult overall_tool_invocation_result = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.OverallToolInvocationResult

The overallToolInvocationResult.

getOverallToolInvocationResultOrBuilder()

public EvaluationResult.OverallToolInvocationResultOrBuilder getOverallToolInvocationResultOrBuilder()

Output only. The result of the overall tool invocation check.

.google.cloud.ces.v1beta.EvaluationResult.OverallToolInvocationResult overall_tool_invocation_result = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.OverallToolInvocationResultOrBuilder

getParserForType()

public Parser<EvaluationResult.GoldenResult.TurnReplayResult> getParserForType()
Returns
Type Description
Parser<TurnReplayResult>
Overrides

getSemanticSimilarityResult()

public EvaluationResult.SemanticSimilarityResult getSemanticSimilarityResult()

Output only. The result of the semantic similarity check.

.google.cloud.ces.v1beta.EvaluationResult.SemanticSimilarityResult semantic_similarity_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.SemanticSimilarityResult

The semanticSimilarityResult.

getSemanticSimilarityResultOrBuilder()

public EvaluationResult.SemanticSimilarityResultOrBuilder getSemanticSimilarityResultOrBuilder()

Output only. The result of the semantic similarity check.

.google.cloud.ces.v1beta.EvaluationResult.SemanticSimilarityResult semantic_similarity_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.SemanticSimilarityResultOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpanLatencies(int index)

public EvaluationResult.SpanLatency getSpanLatencies(int index)

Output only. The latency of spans in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.SpanLatency

getSpanLatenciesCount()

public int getSpanLatenciesCount()

Output only. The latency of spans in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getSpanLatenciesList()

public List<EvaluationResult.SpanLatency> getSpanLatenciesList()

Output only. The latency of spans in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<SpanLatency>

getSpanLatenciesOrBuilder(int index)

public EvaluationResult.SpanLatencyOrBuilder getSpanLatenciesOrBuilder(int index)

Output only. The latency of spans in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.SpanLatencyOrBuilder

getSpanLatenciesOrBuilderList()

public List<? extends EvaluationResult.SpanLatencyOrBuilder> getSpanLatenciesOrBuilderList()

Output only. The latency of spans in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.EvaluationResult.SpanLatencyOrBuilder>

getToolCallLatencies(int index)

public EvaluationResult.ToolCallLatency getToolCallLatencies(int index)

Output only. The latency of each tool call in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.ToolCallLatency

getToolCallLatenciesCount()

public int getToolCallLatenciesCount()

Output only. The latency of each tool call in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getToolCallLatenciesList()

public List<EvaluationResult.ToolCallLatency> getToolCallLatenciesList()

Output only. The latency of each tool call in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ToolCallLatency>

getToolCallLatenciesOrBuilder(int index)

public EvaluationResult.ToolCallLatencyOrBuilder getToolCallLatenciesOrBuilder(int index)

Output only. The latency of each tool call in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.ToolCallLatencyOrBuilder

getToolCallLatenciesOrBuilderList()

public List<? extends EvaluationResult.ToolCallLatencyOrBuilder> getToolCallLatenciesOrBuilderList()

Output only. The latency of each tool call in the turn.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.EvaluationResult.ToolCallLatencyOrBuilder>

getToolInvocationScore() (deprecated)

public float getToolInvocationScore()

Deprecated. google.cloud.ces.v1beta.EvaluationResult.GoldenResult.TurnReplayResult.tool_invocation_score is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=593

Output only. Deprecated. Use OverallToolInvocationResult instead.

float tool_invocation_score = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The toolInvocationScore.

getToolOrderedInvocationScore()

public float getToolOrderedInvocationScore()

Output only. The overall tool ordered invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked in the expected order.

optional float tool_ordered_invocation_score = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The toolOrderedInvocationScore.

getTurnLatency()

public Duration getTurnLatency()

Output only. Duration of the turn.

.google.protobuf.Duration turn_latency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Duration

The turnLatency.

getTurnLatencyOrBuilder()

public DurationOrBuilder getTurnLatencyOrBuilder()

Output only. Duration of the turn.

.google.protobuf.Duration turn_latency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DurationOrBuilder

hasErrorInfo()

public boolean hasErrorInfo()

Output only. Information about the error that occurred during this turn.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the errorInfo field is set.

hasHallucinationResult()

public boolean hasHallucinationResult()

Output only. The result of the hallucination check.

.google.cloud.ces.v1beta.EvaluationResult.HallucinationResult hallucination_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the hallucinationResult field is set.

hasOverallToolInvocationResult()

public boolean hasOverallToolInvocationResult()

Output only. The result of the overall tool invocation check.

.google.cloud.ces.v1beta.EvaluationResult.OverallToolInvocationResult overall_tool_invocation_result = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the overallToolInvocationResult field is set.

hasSemanticSimilarityResult()

public boolean hasSemanticSimilarityResult()

Output only. The result of the semantic similarity check.

.google.cloud.ces.v1beta.EvaluationResult.SemanticSimilarityResult semantic_similarity_result = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the semanticSimilarityResult field is set.

hasToolOrderedInvocationScore()

public boolean hasToolOrderedInvocationScore()

Output only. The overall tool ordered invocation score for this turn. This indicates the overall percent of tools from the expected turn that were actually invoked in the expected order.

optional float tool_ordered_invocation_score = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the toolOrderedInvocationScore field is set.

hasTurnLatency()

public boolean hasTurnLatency()

Output only. Duration of the turn.

.google.protobuf.Duration turn_latency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the turnLatency field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EvaluationResult.GoldenResult.TurnReplayResult.Builder newBuilderForType()
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EvaluationResult.GoldenResult.TurnReplayResult.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult.Builder
Overrides

toBuilder()

public EvaluationResult.GoldenResult.TurnReplayResult.Builder toBuilder()
Returns
Type Description
EvaluationResult.GoldenResult.TurnReplayResult.Builder

writeTo(CodedOutputStream output)

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