Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class EvaluationInstance (3.100.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > EvaluationInstance

Implements

EvaluationInstanceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

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()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

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()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AGENT_DATA_FIELD_NUMBER

public static final int AGENT_DATA_FIELD_NUMBER

Field Value
Type	Description
`int`

AGENT_EVAL_DATA_FIELD_NUMBER

public static final int AGENT_EVAL_DATA_FIELD_NUMBER

Field Value
Type	Description
`int`

OTHER_DATA_FIELD_NUMBER

public static final int OTHER_DATA_FIELD_NUMBER

Field Value
Type	Description
`int`

PROMPT_FIELD_NUMBER

public static final int PROMPT_FIELD_NUMBER

Field Value
Type	Description
`int`

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER

Field Value
Type	Description
`int`

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_FIELD_NUMBER

Field Value
Type	Description
`int`

RUBRIC_GROUPS_FIELD_NUMBER

public static final int RUBRIC_GROUPS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static EvaluationInstance getDefaultInstance()

Returns
Type	Description
`EvaluationInstance`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static EvaluationInstance.Builder newBuilder()

Returns
Type	Description
`EvaluationInstance.Builder`

newBuilder(EvaluationInstance prototype)

public static EvaluationInstance.Builder newBuilder(EvaluationInstance prototype)

Parameter
Name	Description
`prototype`	`EvaluationInstance`

Returns
Type	Description
`EvaluationInstance.Builder`

parseDelimitedFrom(InputStream input)

public static EvaluationInstance parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static EvaluationInstance parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EvaluationInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static EvaluationInstance parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EvaluationInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static EvaluationInstance parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static EvaluationInstance parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static EvaluationInstance parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EvaluationInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`EvaluationInstance`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<EvaluationInstance> parser()

Returns
Type	Description
`Parser<EvaluationInstance>`

Methods

containsRubricGroups(String key)

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`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAgentData() (deprecated)

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];

Returns
Type	Description
`EvaluationInstance.DeprecatedAgentData`	The agentData.

getAgentDataOrBuilder() (deprecated)

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];

Returns
Type	Description
`EvaluationInstance.DeprecatedAgentDataOrBuilder`

getAgentEvalData()

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.

getAgentEvalDataOrBuilder()

public 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`

getDefaultInstanceForType()

public EvaluationInstance getDefaultInstanceForType()

Returns
Type	Description
`EvaluationInstance`

getOtherData()

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];

Returns
Type	Description
`EvaluationInstance.MapInstance`	The otherData.

getOtherDataOrBuilder()

public EvaluationInstance.MapInstanceOrBuilder getOtherDataOrBuilder()

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

Returns
Type	Description
`EvaluationInstance.MapInstanceOrBuilder`

getParserForType()

public Parser<EvaluationInstance> getParserForType()

Returns
Type	Description
`Parser<EvaluationInstance>`

Overrides

GeneratedMessage.getParserForType()

getPrompt()

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];

Returns
Type	Description
`EvaluationInstance.InstanceData`	The prompt.

getPromptOrBuilder()

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];

Returns
Type	Description
`EvaluationInstance.InstanceDataOrBuilder`

getReference()

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];

Returns
Type	Description
`EvaluationInstance.InstanceData`	The reference.

getReferenceOrBuilder()

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];

Returns
Type	Description
`EvaluationInstance.InstanceDataOrBuilder`

getResponse()

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];

Returns
Type	Description
`EvaluationInstance.InstanceData`	The response.

getResponseOrBuilder()

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];

Returns
Type	Description
`EvaluationInstance.InstanceDataOrBuilder`

getRubricGroups() (deprecated)

public Map<String,RubricGroup> getRubricGroups()

Use #getRubricGroupsMap() instead.

Returns
Type	Description
`Map<String,RubricGroup>`

getRubricGroupsCount()

public int getRubricGroupsCount()

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

Returns
Type	Description
`int`

getRubricGroupsMap()

public Map<String,RubricGroup> getRubricGroupsMap()

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 RubricGroup getRubricGroupsOrDefault(String key, RubricGroup defaultValue)

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 RubricGroup getRubricGroupsOrThrow(String key)

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`RubricGroup`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hasAgentData() (deprecated)

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.

hasAgentEvalData()

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.

hasOtherData()

public boolean hasOtherData()

.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 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 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 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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public EvaluationInstance.Builder newBuilderForType()

Returns
Type	Description
`EvaluationInstance.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EvaluationInstance.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`EvaluationInstance.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public EvaluationInstance.Builder toBuilder()

Returns
Type	Description
`EvaluationInstance.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`