Class EvaluationResult.OverallToolInvocationResult.Builder (0.3.0)

public static final class EvaluationResult.OverallToolInvocationResult.Builder extends GeneratedMessage.Builder<EvaluationResult.OverallToolInvocationResult.Builder> implements EvaluationResult.OverallToolInvocationResultOrBuilder

The result of the overall tool invocation check.

Protobuf type google.cloud.ces.v1beta.EvaluationResult.OverallToolInvocationResult

Static Methods

getDescriptor()

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

Methods

build()

public EvaluationResult.OverallToolInvocationResult build()
Returns
Type Description
EvaluationResult.OverallToolInvocationResult

buildPartial()

public EvaluationResult.OverallToolInvocationResult buildPartial()
Returns
Type Description
EvaluationResult.OverallToolInvocationResult

clear()

public EvaluationResult.OverallToolInvocationResult.Builder clear()
Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder
Overrides

clearOutcome()

public EvaluationResult.OverallToolInvocationResult.Builder clearOutcome()

Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder

This builder for chaining.

clearToolInvocationScore()

public EvaluationResult.OverallToolInvocationResult.Builder clearToolInvocationScore()

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

optional float tool_invocation_score = 1;

Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder

This builder for chaining.

getDefaultInstanceForType()

public EvaluationResult.OverallToolInvocationResult getDefaultInstanceForType()
Returns
Type Description
EvaluationResult.OverallToolInvocationResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getOutcome()

public EvaluationResult.Outcome getOutcome()

Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.Outcome

The outcome.

getOutcomeValue()

public int getOutcomeValue()

Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for outcome.

getToolInvocationScore()

public float getToolInvocationScore()

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

optional float tool_invocation_score = 1;

Returns
Type Description
float

The toolInvocationScore.

hasToolInvocationScore()

public boolean hasToolInvocationScore()

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

optional float tool_invocation_score = 1;

Returns
Type Description
boolean

Whether the toolInvocationScore field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EvaluationResult.OverallToolInvocationResult other)

public EvaluationResult.OverallToolInvocationResult.Builder mergeFrom(EvaluationResult.OverallToolInvocationResult other)
Parameter
Name Description
other EvaluationResult.OverallToolInvocationResult
Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EvaluationResult.OverallToolInvocationResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EvaluationResult.OverallToolInvocationResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder
Overrides

setOutcome(EvaluationResult.Outcome value)

public EvaluationResult.OverallToolInvocationResult.Builder setOutcome(EvaluationResult.Outcome value)

Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EvaluationResult.Outcome

The outcome to set.

Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder

This builder for chaining.

setOutcomeValue(int value)

public EvaluationResult.OverallToolInvocationResult.Builder setOutcomeValue(int value)

Output only. The outcome of the tool invocation check. This is determined by comparing the tool_invocation_score to the overall_tool_invocation_correctness_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for outcome to set.

Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder

This builder for chaining.

setToolInvocationScore(float value)

public EvaluationResult.OverallToolInvocationResult.Builder setToolInvocationScore(float value)

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

optional float tool_invocation_score = 1;

Parameter
Name Description
value float

The toolInvocationScore to set.

Returns
Type Description
EvaluationResult.OverallToolInvocationResult.Builder

This builder for chaining.