Class EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder (0.3.0)

public static final class EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder extends GeneratedMessage.Builder<EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder> implements EvaluationResult.GoldenExpectationOutcome.ToolInvocationResultOrBuilder

The result of the tool invocation check.

Protobuf type google.cloud.ces.v1beta.EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder

Static Methods

getDescriptor()

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

Methods

build()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult build()
Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult

buildPartial()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult buildPartial()
Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult

clear()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder clear()
Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder
Overrides

clearExplanation()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder clearExplanation()

Output only. A free text explanation for the tool invocation result.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

clearOutcome()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder clearOutcome()

Output only. The outcome of the tool invocation check. This is determined by comparing the parameter_correctness_score to the 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.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

clearParameterCorrectnessScore()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder clearParameterCorrectnessScore()

Output only. The tool invocation parameter correctness score. This indicates the percent of parameters from the expected tool call that were also present in the actual tool call.

optional float parameter_correctness_score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

getDefaultInstanceForType()

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult getDefaultInstanceForType()
Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult

getDescriptorForType()

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

getExplanation()

public String getExplanation()

Output only. A free text explanation for the tool invocation result.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The explanation.

getExplanationBytes()

public ByteString getExplanationBytes()

Output only. A free text explanation for the tool invocation result.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for explanation.

getOutcome()

public EvaluationResult.Outcome getOutcome()

Output only. The outcome of the tool invocation check. This is determined by comparing the parameter_correctness_score to the 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 parameter_correctness_score to the 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.

getParameterCorrectnessScore()

public float getParameterCorrectnessScore()

Output only. The tool invocation parameter correctness score. This indicates the percent of parameters from the expected tool call that were also present in the actual tool call.

optional float parameter_correctness_score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The parameterCorrectnessScore.

hasParameterCorrectnessScore()

public boolean hasParameterCorrectnessScore()

Output only. The tool invocation parameter correctness score. This indicates the percent of parameters from the expected tool call that were also present in the actual tool call.

optional float parameter_correctness_score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the parameterCorrectnessScore 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.GoldenExpectationOutcome.ToolInvocationResult other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setExplanation(String value)

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder setExplanation(String value)

Output only. A free text explanation for the tool invocation result.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The explanation to set.

Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

setExplanationBytes(ByteString value)

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder setExplanationBytes(ByteString value)

Output only. A free text explanation for the tool invocation result.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for explanation to set.

Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

setOutcome(EvaluationResult.Outcome value)

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder setOutcome(EvaluationResult.Outcome value)

Output only. The outcome of the tool invocation check. This is determined by comparing the parameter_correctness_score to the 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.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

setOutcomeValue(int value)

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder setOutcomeValue(int value)

Output only. The outcome of the tool invocation check. This is determined by comparing the parameter_correctness_score to the 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.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.

setParameterCorrectnessScore(float value)

public EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder setParameterCorrectnessScore(float value)

Output only. The tool invocation parameter correctness score. This indicates the percent of parameters from the expected tool call that were also present in the actual tool call.

optional float parameter_correctness_score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value float

The parameterCorrectnessScore to set.

Returns
Type Description
EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult.Builder

This builder for chaining.