Interface EvaluationResult.ScenarioResultOrBuilder (0.3.0) 

public static interface EvaluationResult.ScenarioResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllExpectationsSatisfied()

public abstract boolean getAllExpectationsSatisfied()

Output only. Whether all expectations were satisfied for this turn.

optional bool all_expectations_satisfied = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The allExpectationsSatisfied.

getConversation()

public abstract String getConversation()

Output only. The conversation that was generated in the scenario.

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 in the scenario.

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

Returns
Type Description
ByteString

The bytes for conversation.

getEvaluationExpectationResults(int index)

public abstract EvaluationResult.EvaluationExpectationResult getEvaluationExpectationResults(int index)

Output only. The results of the evaluation expectations.

repeated .google.cloud.ces.v1beta.EvaluationResult.EvaluationExpectationResult evaluation_expectation_results = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.EvaluationExpectationResult

getEvaluationExpectationResultsCount()

public abstract int getEvaluationExpectationResultsCount()

Output only. The results of the evaluation expectations.

repeated .google.cloud.ces.v1beta.EvaluationResult.EvaluationExpectationResult evaluation_expectation_results = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEvaluationExpectationResultsList()

public abstract List<EvaluationResult.EvaluationExpectationResult> getEvaluationExpectationResultsList()

Output only. The results of the evaluation expectations.

repeated .google.cloud.ces.v1beta.EvaluationResult.EvaluationExpectationResult evaluation_expectation_results = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<EvaluationExpectationResult>

getEvaluationExpectationResultsOrBuilder(int index)

public abstract EvaluationResult.EvaluationExpectationResultOrBuilder getEvaluationExpectationResultsOrBuilder(int index)

Output only. The results of the evaluation expectations.

repeated .google.cloud.ces.v1beta.EvaluationResult.EvaluationExpectationResult evaluation_expectation_results = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.EvaluationExpectationResultOrBuilder

getEvaluationExpectationResultsOrBuilderList()

public abstract List<? extends EvaluationResult.EvaluationExpectationResultOrBuilder> getEvaluationExpectationResultsOrBuilderList()

Output only. The results of the evaluation expectations.

repeated .google.cloud.ces.v1beta.EvaluationResult.EvaluationExpectationResult evaluation_expectation_results = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getExpectationOutcomes(int index)

public abstract EvaluationResult.ScenarioExpectationOutcome getExpectationOutcomes(int index)

Output only. The outcome of each expectation.

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

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.ScenarioExpectationOutcome

getExpectationOutcomesCount()

public abstract int getExpectationOutcomesCount()

Output only. The outcome of each expectation.

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

Returns
Type Description
int

getExpectationOutcomesList()

public abstract List<EvaluationResult.ScenarioExpectationOutcome> getExpectationOutcomesList()

Output only. The outcome of each expectation.

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

Returns
Type Description
List<ScenarioExpectationOutcome>

getExpectationOutcomesOrBuilder(int index)

public abstract EvaluationResult.ScenarioExpectationOutcomeOrBuilder getExpectationOutcomesOrBuilder(int index)

Output only. The outcome of each expectation.

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

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.ScenarioExpectationOutcomeOrBuilder

getExpectationOutcomesOrBuilderList()

public abstract List<? extends EvaluationResult.ScenarioExpectationOutcomeOrBuilder> getExpectationOutcomesOrBuilderList()

Output only. The outcome of each expectation.

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

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

getHallucinationResult(int index)

public abstract EvaluationResult.HallucinationResult getHallucinationResult(int index)

Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.

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

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.HallucinationResult

getHallucinationResultCount()

public abstract int getHallucinationResultCount()

Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.

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

Returns
Type Description
int

getHallucinationResultList()

public abstract List<EvaluationResult.HallucinationResult> getHallucinationResultList()

Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.

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

Returns
Type Description
List<HallucinationResult>

getHallucinationResultOrBuilder(int index)

public abstract EvaluationResult.HallucinationResultOrBuilder getHallucinationResultOrBuilder(int index)

Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.

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

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.HallucinationResultOrBuilder

getHallucinationResultOrBuilderList()

public abstract List<? extends EvaluationResult.HallucinationResultOrBuilder> getHallucinationResultOrBuilderList()

Output only. The result of the hallucination check. There will be one hallucination result for each turn in the conversation.

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

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

getRubricOutcomes(int index)

public abstract EvaluationResult.ScenarioRubricOutcome getRubricOutcomes(int index)

Output only. The outcome of the rubric.

repeated .google.cloud.ces.v1beta.EvaluationResult.ScenarioRubricOutcome rubric_outcomes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.ScenarioRubricOutcome

getRubricOutcomesCount()

public abstract int getRubricOutcomesCount()

Output only. The outcome of the rubric.

repeated .google.cloud.ces.v1beta.EvaluationResult.ScenarioRubricOutcome rubric_outcomes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getRubricOutcomesList()

public abstract List<EvaluationResult.ScenarioRubricOutcome> getRubricOutcomesList()

Output only. The outcome of the rubric.

repeated .google.cloud.ces.v1beta.EvaluationResult.ScenarioRubricOutcome rubric_outcomes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ScenarioRubricOutcome>

getRubricOutcomesOrBuilder(int index)

public abstract EvaluationResult.ScenarioRubricOutcomeOrBuilder getRubricOutcomesOrBuilder(int index)

Output only. The outcome of the rubric.

repeated .google.cloud.ces.v1beta.EvaluationResult.ScenarioRubricOutcome rubric_outcomes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EvaluationResult.ScenarioRubricOutcomeOrBuilder

getRubricOutcomesOrBuilderList()

public abstract List<? extends EvaluationResult.ScenarioRubricOutcomeOrBuilder> getRubricOutcomesOrBuilderList()

Output only. The outcome of the rubric.

repeated .google.cloud.ces.v1beta.EvaluationResult.ScenarioRubricOutcome rubric_outcomes = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getSpanLatencies(int index)

public abstract EvaluationResult.SpanLatency getSpanLatencies(int index)

Output only. The latency of spans in the conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 12 [(.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 conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 12 [(.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 conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 12 [(.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 conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.SpanLatency span_latencies = 12 [(.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 conversation.

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

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

getTask()

public abstract String getTask()

Output only. The task that was used when running the scenario for this result.

string task = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The task.

getTaskBytes()

public abstract ByteString getTaskBytes()

Output only. The task that was used when running the scenario for this result.

string task = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for task.

getTaskCompleted()

public abstract boolean getTaskCompleted()

Output only. Whether the task was completed for this turn. This is a composite of all expectations satisfied, no hallucinations, and user goal satisfaction.

optional bool task_completed = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The taskCompleted.

getTaskCompletionResult() (deprecated)

public abstract EvaluationResult.TaskCompletionResult getTaskCompletionResult()

Deprecated. google.cloud.ces.v1beta.EvaluationResult.ScenarioResult.task_completion_result is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=713

Output only. The result of the task completion check.

.google.cloud.ces.v1beta.EvaluationResult.TaskCompletionResult task_completion_result = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.TaskCompletionResult

The taskCompletionResult.

getTaskCompletionResultOrBuilder() (deprecated)

public abstract EvaluationResult.TaskCompletionResultOrBuilder getTaskCompletionResultOrBuilder()

Output only. The result of the task completion check.

.google.cloud.ces.v1beta.EvaluationResult.TaskCompletionResult task_completion_result = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.TaskCompletionResultOrBuilder

getToolCallLatencies(int index)

public abstract EvaluationResult.ToolCallLatency getToolCallLatencies(int index)

Output only. The latency of each tool call execution in the conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 6 [(.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 execution in the conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 6 [(.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 execution in the conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 6 [(.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 execution in the conversation.

repeated .google.cloud.ces.v1beta.EvaluationResult.ToolCallLatency tool_call_latencies = 6 [(.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 execution in the conversation.

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

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

getUserFacts(int index)

public abstract Evaluation.Scenario.UserFact getUserFacts(int index)

Output only. The user facts that were used by the scenario for this result.

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Evaluation.Scenario.UserFact

getUserFactsCount()

public abstract int getUserFactsCount()

Output only. The user facts that were used by the scenario for this result.

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getUserFactsList()

public abstract List<Evaluation.Scenario.UserFact> getUserFactsList()

Output only. The user facts that were used by the scenario for this result.

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<UserFact>

getUserFactsOrBuilder(int index)

public abstract Evaluation.Scenario.UserFactOrBuilder getUserFactsOrBuilder(int index)

Output only. The user facts that were used by the scenario for this result.

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Evaluation.Scenario.UserFactOrBuilder

getUserFactsOrBuilderList()

public abstract List<? extends Evaluation.Scenario.UserFactOrBuilder> getUserFactsOrBuilderList()

Output only. The user facts that were used by the scenario for this result.

repeated .google.cloud.ces.v1beta.Evaluation.Scenario.UserFact user_facts = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.Evaluation.Scenario.UserFactOrBuilder>

getUserGoalSatisfactionResult()

public abstract EvaluationResult.UserGoalSatisfactionResult getUserGoalSatisfactionResult()

Output only. The result of the user goal satisfaction check.

.google.cloud.ces.v1beta.EvaluationResult.UserGoalSatisfactionResult user_goal_satisfaction_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.UserGoalSatisfactionResult

The userGoalSatisfactionResult.

getUserGoalSatisfactionResultOrBuilder()

public abstract EvaluationResult.UserGoalSatisfactionResultOrBuilder getUserGoalSatisfactionResultOrBuilder()

Output only. The result of the user goal satisfaction check.

.google.cloud.ces.v1beta.EvaluationResult.UserGoalSatisfactionResult user_goal_satisfaction_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.UserGoalSatisfactionResultOrBuilder

hasAllExpectationsSatisfied()

public abstract boolean hasAllExpectationsSatisfied()

Output only. Whether all expectations were satisfied for this turn.

optional bool all_expectations_satisfied = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the allExpectationsSatisfied field is set.

hasTaskCompleted()

public abstract boolean hasTaskCompleted()

Output only. Whether the task was completed for this turn. This is a composite of all expectations satisfied, no hallucinations, and user goal satisfaction.

optional bool task_completed = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the taskCompleted field is set.

hasTaskCompletionResult() (deprecated)

public abstract boolean hasTaskCompletionResult()

Deprecated. google.cloud.ces.v1beta.EvaluationResult.ScenarioResult.task_completion_result is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=713

Output only. The result of the task completion check.

.google.cloud.ces.v1beta.EvaluationResult.TaskCompletionResult task_completion_result = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the taskCompletionResult field is set.

hasUserGoalSatisfactionResult()

public abstract boolean hasUserGoalSatisfactionResult()

Output only. The result of the user goal satisfaction check.

.google.cloud.ces.v1beta.EvaluationResult.UserGoalSatisfactionResult user_goal_satisfaction_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the userGoalSatisfactionResult field is set.