public final class EvaluationInstance extends GeneratedMessage implements EvaluationInstanceOrBuilder
A single instance to be evaluated.
Instances are used to specify the input data for evaluation, from
simple string comparisons to complex, multi-turn model evaluations
Protobuf type google.cloud.aiplatform.v1beta1.EvaluationInstance
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int AGENT_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int AGENT_EVAL_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OTHER_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROMPT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REFERENCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RUBRIC_GROUPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static EvaluationInstance getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static EvaluationInstance.Builder newBuilder()
public static EvaluationInstance.Builder newBuilder(EvaluationInstance prototype)
public static EvaluationInstance parseDelimitedFrom(InputStream input)
public static EvaluationInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluationInstance parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static EvaluationInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EvaluationInstance parseFrom(ByteString data)
public static EvaluationInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EvaluationInstance parseFrom(CodedInputStream input)
public static EvaluationInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluationInstance parseFrom(InputStream input)
public static EvaluationInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluationInstance parseFrom(ByteBuffer data)
public static EvaluationInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<EvaluationInstance> parser()
Methods
public 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
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public 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];
public 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];
public 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.
|
public AgentDataOrBuilder getAgentEvalDataOrBuilder()
Optional. Data used for agent evaluation.
.google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];
public EvaluationInstance getDefaultInstanceForType()
public 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];
public 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];
public Parser<EvaluationInstance> getParserForType()
Overrides
public 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];
public 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];
public 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];
public 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];
public 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];
public 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];
public Map<String,RubricGroup> getRubricGroups()
public 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 |
|
public 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];
public 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];
public 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
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public EvaluationInstance.Builder newBuilderForType()
protected EvaluationInstance.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public EvaluationInstance.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides