Interface Evaluation.GoldenExpectationOrBuilder (0.3.0)

public static interface Evaluation.GoldenExpectationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAgentResponse()

public abstract Message getAgentResponse()

Optional. Check that the agent responded with the correct response. The role "agent" is implied.

.google.cloud.ces.v1beta.Message agent_response = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Message

The agentResponse.

getAgentResponseOrBuilder()

public abstract MessageOrBuilder getAgentResponseOrBuilder()

Optional. Check that the agent responded with the correct response. The role "agent" is implied.

.google.cloud.ces.v1beta.Message agent_response = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MessageOrBuilder

getAgentTransfer()

public abstract AgentTransfer getAgentTransfer()

Optional. Check that the agent transferred the conversation to a different agent.

.google.cloud.ces.v1beta.AgentTransfer agent_transfer = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentTransfer

The agentTransfer.

getAgentTransferOrBuilder()

public abstract AgentTransferOrBuilder getAgentTransferOrBuilder()

Optional. Check that the agent transferred the conversation to a different agent.

.google.cloud.ces.v1beta.AgentTransfer agent_transfer = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AgentTransferOrBuilder

getConditionCase()

public abstract Evaluation.GoldenExpectation.ConditionCase getConditionCase()
Returns
Type Description
Evaluation.GoldenExpectation.ConditionCase

getMockToolResponse()

public abstract ToolResponse getMockToolResponse()

Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.

.google.cloud.ces.v1beta.ToolResponse mock_tool_response = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponse

The mockToolResponse.

getMockToolResponseOrBuilder()

public abstract ToolResponseOrBuilder getMockToolResponseOrBuilder()

Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.

.google.cloud.ces.v1beta.ToolResponse mock_tool_response = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponseOrBuilder

getNote()

public abstract String getNote()

Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called".

string note = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The note.

getNoteBytes()

public abstract ByteString getNoteBytes()

Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called".

string note = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for note.

getToolCall()

public abstract ToolCall getToolCall()

Optional. Check that a specific tool was called with the parameters.

.google.cloud.ces.v1beta.ToolCall tool_call = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall

The toolCall.

getToolCallOrBuilder()

public abstract ToolCallOrBuilder getToolCallOrBuilder()

Optional. Check that a specific tool was called with the parameters.

.google.cloud.ces.v1beta.ToolCall tool_call = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCallOrBuilder

getToolResponse()

public abstract ToolResponse getToolResponse()

Optional. Check that a specific tool had the expected response.

.google.cloud.ces.v1beta.ToolResponse tool_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponse

The toolResponse.

getToolResponseOrBuilder()

public abstract ToolResponseOrBuilder getToolResponseOrBuilder()

Optional. Check that a specific tool had the expected response.

.google.cloud.ces.v1beta.ToolResponse tool_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolResponseOrBuilder

getUpdatedVariables()

public abstract Struct getUpdatedVariables()

Optional. Check that the agent updated the session variables to the expected values. Used to also capture agent variable updates for golden evals.

.google.protobuf.Struct updated_variables = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The updatedVariables.

getUpdatedVariablesOrBuilder()

public abstract StructOrBuilder getUpdatedVariablesOrBuilder()

Optional. Check that the agent updated the session variables to the expected values. Used to also capture agent variable updates for golden evals.

.google.protobuf.Struct updated_variables = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

hasAgentResponse()

public abstract boolean hasAgentResponse()

Optional. Check that the agent responded with the correct response. The role "agent" is implied.

.google.cloud.ces.v1beta.Message agent_response = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the agentResponse field is set.

hasAgentTransfer()

public abstract boolean hasAgentTransfer()

Optional. Check that the agent transferred the conversation to a different agent.

.google.cloud.ces.v1beta.AgentTransfer agent_transfer = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the agentTransfer field is set.

hasMockToolResponse()

public abstract boolean hasMockToolResponse()

Optional. The tool response to mock, with the parameters of interest specified. Any parameters not specified will be hallucinated by the LLM.

.google.cloud.ces.v1beta.ToolResponse mock_tool_response = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the mockToolResponse field is set.

hasToolCall()

public abstract boolean hasToolCall()

Optional. Check that a specific tool was called with the parameters.

.google.cloud.ces.v1beta.ToolCall tool_call = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolCall field is set.

hasToolResponse()

public abstract boolean hasToolResponse()

Optional. Check that a specific tool had the expected response.

.google.cloud.ces.v1beta.ToolResponse tool_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolResponse field is set.

hasUpdatedVariables()

public abstract boolean hasUpdatedVariables()

Optional. Check that the agent updated the session variables to the expected values. Used to also capture agent variable updates for golden evals.

.google.protobuf.Struct updated_variables = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updatedVariables field is set.