Package com.google.cloud.aiplatform.v1

Class LLMBasedMetricSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.LLMBasedMetricSpec
All Implemented Interfaces:
LLMBasedMetricSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class LLMBasedMetricSpec extends com.google.protobuf.GeneratedMessage implements LLMBasedMetricSpecOrBuilder
 Specification for an LLM based metric.
Protobuf type google.cloud.aiplatform.v1.LLMBasedMetricSpec
See Also:

  • Field Details

    • RUBRIC_GROUP_KEY_FIELD_NUMBER

      public static final int RUBRIC_GROUP_KEY_FIELD_NUMBER
      See Also:

    • PREDEFINED_RUBRIC_GENERATION_SPEC_FIELD_NUMBER

      public static final int PREDEFINED_RUBRIC_GENERATION_SPEC_FIELD_NUMBER
      See Also:

    • METRIC_PROMPT_TEMPLATE_FIELD_NUMBER

      public static final int METRIC_PROMPT_TEMPLATE_FIELD_NUMBER
      See Also:

    • SYSTEM_INSTRUCTION_FIELD_NUMBER

      public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
      See Also:

    • JUDGE_AUTORATER_CONFIG_FIELD_NUMBER

      public static final int JUDGE_AUTORATER_CONFIG_FIELD_NUMBER
      See Also:

    • ADDITIONAL_CONFIG_FIELD_NUMBER

      public static final int ADDITIONAL_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getRubricsSourceCase

      public LLMBasedMetricSpec.RubricsSourceCase getRubricsSourceCase()
      Specified by:
      getRubricsSourceCase in interface LLMBasedMetricSpecOrBuilder

    • hasRubricGroupKey

      public boolean hasRubricGroupKey()
       Use a pre-defined group of rubrics associated with the input.
 Refers to a key in the rubric_groups map of EvaluationInstance.
      string rubric_group_key = 4;
      Specified by:
      hasRubricGroupKey in interface LLMBasedMetricSpecOrBuilder
      Returns:
      Whether the rubricGroupKey field is set.

    • getRubricGroupKey

      public String getRubricGroupKey()
       Use a pre-defined group of rubrics associated with the input.
 Refers to a key in the rubric_groups map of EvaluationInstance.
      string rubric_group_key = 4;
      Specified by:
      getRubricGroupKey in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The rubricGroupKey.

    • getRubricGroupKeyBytes

      public com.google.protobuf.ByteString getRubricGroupKeyBytes()
       Use a pre-defined group of rubrics associated with the input.
 Refers to a key in the rubric_groups map of EvaluationInstance.
      string rubric_group_key = 4;
      Specified by:
      getRubricGroupKeyBytes in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The bytes for rubricGroupKey.

    • hasPredefinedRubricGenerationSpec

      public boolean hasPredefinedRubricGenerationSpec()
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;
      Specified by:
      hasPredefinedRubricGenerationSpec in interface LLMBasedMetricSpecOrBuilder
      Returns:
      Whether the predefinedRubricGenerationSpec field is set.

    • getPredefinedRubricGenerationSpec

      public PredefinedMetricSpec getPredefinedRubricGenerationSpec()
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;
      Specified by:
      getPredefinedRubricGenerationSpec in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The predefinedRubricGenerationSpec.

    • getPredefinedRubricGenerationSpecOrBuilder

      public PredefinedMetricSpecOrBuilder getPredefinedRubricGenerationSpecOrBuilder()
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;
      Specified by:
      getPredefinedRubricGenerationSpecOrBuilder in interface LLMBasedMetricSpecOrBuilder

    • hasMetricPromptTemplate

      public boolean hasMetricPromptTemplate()
       Required. Template for the prompt sent to the judge model.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasMetricPromptTemplate in interface LLMBasedMetricSpecOrBuilder
      Returns:
      Whether the metricPromptTemplate field is set.

    • getMetricPromptTemplate

      public String getMetricPromptTemplate()
       Required. Template for the prompt sent to the judge model.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetricPromptTemplate in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The metricPromptTemplate.

    • getMetricPromptTemplateBytes

      public com.google.protobuf.ByteString getMetricPromptTemplateBytes()
       Required. Template for the prompt sent to the judge model.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetricPromptTemplateBytes in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The bytes for metricPromptTemplate.

    • hasSystemInstruction

      public boolean hasSystemInstruction()
       Optional. System instructions for the judge model.
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSystemInstruction in interface LLMBasedMetricSpecOrBuilder
      Returns:
      Whether the systemInstruction field is set.

    • getSystemInstruction

      public String getSystemInstruction()
       Optional. System instructions for the judge model.
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstruction in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The systemInstruction.

    • getSystemInstructionBytes

      public com.google.protobuf.ByteString getSystemInstructionBytes()
       Optional. System instructions for the judge model.
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstructionBytes in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The bytes for systemInstruction.

    • hasJudgeAutoraterConfig

      public boolean hasJudgeAutoraterConfig()
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasJudgeAutoraterConfig in interface LLMBasedMetricSpecOrBuilder
      Returns:
      Whether the judgeAutoraterConfig field is set.

    • getJudgeAutoraterConfig

      public AutoraterConfig getJudgeAutoraterConfig()
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getJudgeAutoraterConfig in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The judgeAutoraterConfig.

    • getJudgeAutoraterConfigOrBuilder

      public AutoraterConfigOrBuilder getJudgeAutoraterConfigOrBuilder()
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getJudgeAutoraterConfigOrBuilder in interface LLMBasedMetricSpecOrBuilder

    • hasAdditionalConfig

      public boolean hasAdditionalConfig()
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAdditionalConfig in interface LLMBasedMetricSpecOrBuilder
      Returns:
      Whether the additionalConfig field is set.

    • getAdditionalConfig

      public com.google.protobuf.Struct getAdditionalConfig()
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalConfig in interface LLMBasedMetricSpecOrBuilder
      Returns:
      The additionalConfig.

    • getAdditionalConfigOrBuilder

      public com.google.protobuf.StructOrBuilder getAdditionalConfigOrBuilder()
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdditionalConfigOrBuilder in interface LLMBasedMetricSpecOrBuilder

    • 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 LLMBasedMetricSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LLMBasedMetricSpec.Builder newBuilder()

    • newBuilder

      public static LLMBasedMetricSpec.Builder newBuilder(LLMBasedMetricSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LLMBasedMetricSpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<LLMBasedMetricSpec> 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 LLMBasedMetricSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder