Interface EvaluationInstanceOrBuilder (3.100.0)

3.100.0 (latest) 3.96.0 3.95.0 3.94.0 3.92.0 3.89.0 3.88.0 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

public interface EvaluationInstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsRubricGroups(String key)

public abstract boolean containsRubricGroups(String key)

Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.

map<string, .google.cloud.aiplatform.v1beta1.RubricGroup> rubric_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAgentData() (deprecated)

public abstract EvaluationInstance.DeprecatedAgentData getAgentData()

Deprecated. google.cloud.aiplatform.v1beta1.EvaluationInstance.agent_data is deprecated. See google/cloud/aiplatform/v1beta1/evaluation_service.proto;l=565

Optional. Deprecated: Use agent_eval_data instead. Data used for agent evaluation.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.DeprecatedAgentData agent_data = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.DeprecatedAgentData	The agentData.

getAgentDataOrBuilder() (deprecated)

public abstract EvaluationInstance.DeprecatedAgentDataOrBuilder getAgentDataOrBuilder()

Optional. Deprecated: Use agent_eval_data instead. Data used for agent evaluation.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.DeprecatedAgentData agent_data = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.DeprecatedAgentDataOrBuilder

getAgentEvalData()

public abstract AgentData getAgentEvalData()

Optional. Data used for agent evaluation.

.google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AgentData	The agentEvalData.

getAgentEvalDataOrBuilder()

public abstract AgentDataOrBuilder getAgentEvalDataOrBuilder()

Optional. Data used for agent evaluation.

.google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AgentDataOrBuilder

getOtherData()

public abstract EvaluationInstance.MapInstance getOtherData()

Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. prompt), the value of the field will take precedence over the value in other_data.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.MapInstance other_data = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.MapInstance	The otherData.

getOtherDataOrBuilder()

public abstract EvaluationInstance.MapInstanceOrBuilder getOtherDataOrBuilder()

Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. prompt), the value of the field will take precedence over the value in other_data.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.MapInstance other_data = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.MapInstanceOrBuilder

getPrompt()

public abstract EvaluationInstance.InstanceData getPrompt()

Optional. Data used to populate placeholder prompt in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData prompt = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.InstanceData	The prompt.

getPromptOrBuilder()

public abstract EvaluationInstance.InstanceDataOrBuilder getPromptOrBuilder()

Optional. Data used to populate placeholder prompt in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData prompt = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.InstanceDataOrBuilder

getReference()

public abstract EvaluationInstance.InstanceData getReference()

Optional. Data used to populate placeholder reference in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData reference = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.InstanceData	The reference.

getReferenceOrBuilder()

public abstract EvaluationInstance.InstanceDataOrBuilder getReferenceOrBuilder()

Optional. Data used to populate placeholder reference in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData reference = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.InstanceDataOrBuilder

getResponse()

public abstract EvaluationInstance.InstanceData getResponse()

Optional. Data used to populate placeholder response in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.InstanceData	The response.

getResponseOrBuilder()

public abstract EvaluationInstance.InstanceDataOrBuilder getResponseOrBuilder()

Optional. Data used to populate placeholder response in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EvaluationInstance.InstanceDataOrBuilder

getRubricGroups() (deprecated)

public abstract Map<String,RubricGroup> getRubricGroups()

Use #getRubricGroupsMap() instead.

Returns
Type	Description
Map<String,RubricGroup>

getRubricGroupsCount()

public abstract int getRubricGroupsCount()

Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.

map<string, .google.cloud.aiplatform.v1beta1.RubricGroup> rubric_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getRubricGroupsMap()

public abstract Map<String,RubricGroup> getRubricGroupsMap()

Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.

map<string, .google.cloud.aiplatform.v1beta1.RubricGroup> rubric_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,RubricGroup>

getRubricGroupsOrDefault(String key, RubricGroup defaultValue)

public abstract RubricGroup getRubricGroupsOrDefault(String key, RubricGroup defaultValue)

Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.

map<string, .google.cloud.aiplatform.v1beta1.RubricGroup> rubric_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	RubricGroup

Returns
Type	Description
RubricGroup

getRubricGroupsOrThrow(String key)

public abstract RubricGroup getRubricGroupsOrThrow(String key)

Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.

map<string, .google.cloud.aiplatform.v1beta1.RubricGroup> rubric_groups = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
RubricGroup

hasAgentData() (deprecated)

public abstract boolean hasAgentData()

Deprecated. google.cloud.aiplatform.v1beta1.EvaluationInstance.agent_data is deprecated. See google/cloud/aiplatform/v1beta1/evaluation_service.proto;l=565

Optional. Deprecated: Use agent_eval_data instead. Data used for agent evaluation.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.DeprecatedAgentData agent_data = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the agentData field is set.

hasAgentEvalData()

public abstract boolean hasAgentEvalData()

Optional. Data used for agent evaluation.

.google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the agentEvalData field is set.

hasOtherData()

public abstract boolean hasOtherData()

Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. prompt), the value of the field will take precedence over the value in other_data.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.MapInstance other_data = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the otherData field is set.

hasPrompt()

public abstract boolean hasPrompt()

Optional. Data used to populate placeholder prompt in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData prompt = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the prompt field is set.

hasReference()

public abstract boolean hasReference()

Optional. Data used to populate placeholder reference in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData reference = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the reference field is set.

hasResponse()

public abstract boolean hasResponse()

Optional. Data used to populate placeholder response in a metric prompt template.

.google.cloud.aiplatform.v1beta1.EvaluationInstance.InstanceData response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the response field is set.