Interface EvaluationResult.GoldenResult.TurnReplayResultOrBuilder (0.3.0) 

public static interface EvaluationResult.GoldenResult.TurnReplayResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConversation()

public abstract 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 abstract 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.

getErrorInfo()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getSemanticSimilarityResult()

public abstract 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 abstract 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

getSpanLatencies(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.