Package com.google.cloud.aiplatform.v1beta1

Interface EvaluationInstanceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EvaluationInstance, EvaluationInstance.Builder
@Generated public interface EvaluationInstanceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasPrompt

      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:
      Whether the prompt field is set.

    • getPrompt

      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:
      The prompt.

    • getPromptOrBuilder

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

    • getRubricGroupsCount

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

    • containsRubricGroups

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

    • getRubricGroups

      @Deprecated Map<String,RubricGroup> getRubricGroups()
      Deprecated.
      Use getRubricGroupsMap() instead.

    • getRubricGroupsMap

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

    • getRubricGroupsOrDefault

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

    • getRubricGroupsOrThrow

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

    • hasResponse

      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:
      Whether the response field is set.

    • getResponse

      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:
      The response.

    • getResponseOrBuilder

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

    • hasReference

      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:
      Whether the reference field is set.

    • getReference

      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:
      The reference.

    • getReferenceOrBuilder

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

    • hasOtherData

      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:
      Whether the otherData field is set.

    • getOtherData

      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:
      The otherData.

    • getOtherDataOrBuilder

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

    • hasAgentData

      @Deprecated 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:
      Whether the agentData field is set.

    • getAgentData

      @Deprecated 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:
      The agentData.

    • getAgentDataOrBuilder

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

    • hasAgentEvalData

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

    • getAgentEvalData

      AgentData getAgentEvalData()
       Optional. Data used for agent evaluation.
      .google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The agentEvalData.

    • getAgentEvalDataOrBuilder

      AgentDataOrBuilder getAgentEvalDataOrBuilder()
       Optional. Data used for agent evaluation.
      .google.cloud.aiplatform.v1beta1.AgentData agent_eval_data = 7 [(.google.api.field_behavior) = OPTIONAL];