Package com.google.cloud.aiplatform.v1beta1

Class EvaluationInstance

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.EvaluationInstance
All Implemented Interfaces:
EvaluationInstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EvaluationInstance extends com.google.protobuf.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
See Also:

  • Field Details

    • PROMPT_FIELD_NUMBER

      public static final int PROMPT_FIELD_NUMBER
      See Also:

    • RUBRIC_GROUPS_FIELD_NUMBER

      public static final int RUBRIC_GROUPS_FIELD_NUMBER
      See Also:

    • RESPONSE_FIELD_NUMBER

      public static final int RESPONSE_FIELD_NUMBER
      See Also:

    • REFERENCE_FIELD_NUMBER

      public static final int REFERENCE_FIELD_NUMBER
      See Also:

    • OTHER_DATA_FIELD_NUMBER

      public static final int OTHER_DATA_FIELD_NUMBER
      See Also:

    • AGENT_DATA_FIELD_NUMBER

      public static final int AGENT_DATA_FIELD_NUMBER
      See Also:

    • AGENT_EVAL_DATA_FIELD_NUMBER

      public static final int AGENT_EVAL_DATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      hasPrompt in interface EvaluationInstanceOrBuilder
      Returns:
      Whether the prompt field is set.

    • 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];
      Specified by:
      getPrompt in interface EvaluationInstanceOrBuilder
      Returns:
      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];
      Specified by:
      getPromptOrBuilder in interface EvaluationInstanceOrBuilder

    • getRubricGroupsCount

      public int getRubricGroupsCount()
      Description copied from interface: EvaluationInstanceOrBuilder
       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];
      Specified by:
      getRubricGroupsCount in interface EvaluationInstanceOrBuilder

    • containsRubricGroups

      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];
      Specified by:
      containsRubricGroups in interface EvaluationInstanceOrBuilder

    • getRubricGroups

      @Deprecated public Map<String,RubricGroup> getRubricGroups()
      Deprecated.
      Use getRubricGroupsMap() instead.
      Specified by:
      getRubricGroups in interface EvaluationInstanceOrBuilder

    • getRubricGroupsMap

      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];
      Specified by:
      getRubricGroupsMap in interface EvaluationInstanceOrBuilder

    • getRubricGroupsOrDefault

      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];
      Specified by:
      getRubricGroupsOrDefault in interface EvaluationInstanceOrBuilder

    • getRubricGroupsOrThrow

      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];
      Specified by:
      getRubricGroupsOrThrow in interface EvaluationInstanceOrBuilder

    • 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];
      Specified by:
      hasResponse in interface EvaluationInstanceOrBuilder
      Returns:
      Whether the response field is set.

    • 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];
      Specified by:
      getResponse in interface EvaluationInstanceOrBuilder
      Returns:
      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];
      Specified by:
      getResponseOrBuilder in interface EvaluationInstanceOrBuilder

    • 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];
      Specified by:
      hasReference in interface EvaluationInstanceOrBuilder
      Returns:
      Whether the reference field is set.

    • 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];
      Specified by:
      getReference in interface EvaluationInstanceOrBuilder
      Returns:
      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];
      Specified by:
      getReferenceOrBuilder in interface EvaluationInstanceOrBuilder

    • hasOtherData

      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];
      Specified by:
      hasOtherData in interface EvaluationInstanceOrBuilder
      Returns:
      Whether the otherData field is set.

    • 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];
      Specified by:
      getOtherData in interface EvaluationInstanceOrBuilder
      Returns:
      The otherData.

    • getOtherDataOrBuilder

      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];
      Specified by:
      getOtherDataOrBuilder in interface EvaluationInstanceOrBuilder

    • 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];
      Specified by:
      hasAgentData in interface EvaluationInstanceOrBuilder
      Returns:
      Whether the agentData field is set.

    • 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];
      Specified by:
      getAgentData in interface EvaluationInstanceOrBuilder
      Returns:
      The agentData.

    • getAgentDataOrBuilder

      @Deprecated public EvaluationInstance.DeprecatedAgentDataOrBuilder getAgentDataOrBuilder()
      Deprecated.
       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];
      Specified by:
      getAgentDataOrBuilder in interface EvaluationInstanceOrBuilder

    • hasAgentEvalData

      public boolean hasAgentEvalData()
       Optional. Data used for agent evaluation.
      .google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAgentEvalData in interface EvaluationInstanceOrBuilder
      Returns:
      Whether the agentEvalData field is set.

    • getAgentEvalData

      public AgentData getAgentEvalData()
       Optional. Data used for agent evaluation.
      .google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAgentEvalData in interface EvaluationInstanceOrBuilder
      Returns:
      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];
      Specified by:
      getAgentEvalDataOrBuilder in interface EvaluationInstanceOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EvaluationInstance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EvaluationInstance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EvaluationInstance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EvaluationInstance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EvaluationInstance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EvaluationInstance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EvaluationInstance parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EvaluationInstance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EvaluationInstance parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EvaluationInstance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EvaluationInstance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EvaluationInstance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EvaluationInstance.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EvaluationInstance.Builder newBuilder()

    • newBuilder

      public static EvaluationInstance.Builder newBuilder(EvaluationInstance prototype)

    • toBuilder

      public EvaluationInstance.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EvaluationInstance.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EvaluationInstance getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EvaluationInstance> parser()

    • getParserForType

      public com.google.protobuf.Parser<EvaluationInstance> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EvaluationInstance getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder