Package com.google.cloud.aiplatform.v1

Class LLMBasedMetricSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<LLMBasedMetricSpec.Builder>
com.google.cloud.aiplatform.v1.LLMBasedMetricSpec.Builder
All Implemented Interfaces:
LLMBasedMetricSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
LLMBasedMetricSpec
public static final class LLMBasedMetricSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<LLMBasedMetricSpec.Builder> implements LLMBasedMetricSpecOrBuilder
 Specification for an LLM based metric.
Protobuf type google.cloud.aiplatform.v1.LLMBasedMetricSpec

  • 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.Builder<LLMBasedMetricSpec.Builder>

    • clear

      public LLMBasedMetricSpec.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<LLMBasedMetricSpec.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<LLMBasedMetricSpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public LLMBasedMetricSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LLMBasedMetricSpec.Builder>

    • mergeFrom

      public LLMBasedMetricSpec.Builder mergeFrom(LLMBasedMetricSpec other)

    • isInitialized

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

    • mergeFrom

      public LLMBasedMetricSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LLMBasedMetricSpec.Builder>
      Throws:
      IOException

    • getRubricsSourceCase

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

    • clearRubricsSource

      public LLMBasedMetricSpec.Builder clearRubricsSource()

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

    • setRubricGroupKey

      public LLMBasedMetricSpec.Builder setRubricGroupKey(String value)
       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;
      Parameters:
      value - The rubricGroupKey to set.
      Returns:
      This builder for chaining.

    • clearRubricGroupKey

      public LLMBasedMetricSpec.Builder clearRubricGroupKey()
       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;
      Returns:
      This builder for chaining.

    • setRubricGroupKeyBytes

      public LLMBasedMetricSpec.Builder setRubricGroupKeyBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for rubricGroupKey to set.
      Returns:
      This builder for chaining.

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

    • setPredefinedRubricGenerationSpec

      public LLMBasedMetricSpec.Builder setPredefinedRubricGenerationSpec(PredefinedMetricSpec value)
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

    • setPredefinedRubricGenerationSpec

      public LLMBasedMetricSpec.Builder setPredefinedRubricGenerationSpec(PredefinedMetricSpec.Builder builderForValue)
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

    • mergePredefinedRubricGenerationSpec

      public LLMBasedMetricSpec.Builder mergePredefinedRubricGenerationSpec(PredefinedMetricSpec value)
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

    • clearPredefinedRubricGenerationSpec

      public LLMBasedMetricSpec.Builder clearPredefinedRubricGenerationSpec()
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

    • getPredefinedRubricGenerationSpecBuilder

      public PredefinedMetricSpec.Builder getPredefinedRubricGenerationSpecBuilder()
       Dynamically generate rubrics using a predefined spec.
      .google.cloud.aiplatform.v1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

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

    • setMetricPromptTemplate

      public LLMBasedMetricSpec.Builder setMetricPromptTemplate(String value)
       Required. Template for the prompt sent to the judge model.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The metricPromptTemplate to set.
      Returns:
      This builder for chaining.

    • clearMetricPromptTemplate

      public LLMBasedMetricSpec.Builder clearMetricPromptTemplate()
       Required. Template for the prompt sent to the judge model.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setMetricPromptTemplateBytes

      public LLMBasedMetricSpec.Builder setMetricPromptTemplateBytes(com.google.protobuf.ByteString value)
       Required. Template for the prompt sent to the judge model.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for metricPromptTemplate to set.
      Returns:
      This builder for chaining.

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

    • setSystemInstruction

      public LLMBasedMetricSpec.Builder setSystemInstruction(String value)
       Optional. System instructions for the judge model.
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The systemInstruction to set.
      Returns:
      This builder for chaining.

    • clearSystemInstruction

      public LLMBasedMetricSpec.Builder clearSystemInstruction()
       Optional. System instructions for the judge model.
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setSystemInstructionBytes

      public LLMBasedMetricSpec.Builder setSystemInstructionBytes(com.google.protobuf.ByteString value)
       Optional. System instructions for the judge model.
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for systemInstruction to set.
      Returns:
      This builder for chaining.

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

    • setJudgeAutoraterConfig

      public LLMBasedMetricSpec.Builder setJudgeAutoraterConfig(AutoraterConfig value)
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

    • setJudgeAutoraterConfig

      public LLMBasedMetricSpec.Builder setJudgeAutoraterConfig(AutoraterConfig.Builder builderForValue)
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

    • mergeJudgeAutoraterConfig

      public LLMBasedMetricSpec.Builder mergeJudgeAutoraterConfig(AutoraterConfig value)
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

    • clearJudgeAutoraterConfig

      public LLMBasedMetricSpec.Builder clearJudgeAutoraterConfig()
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getJudgeAutoraterConfigBuilder

      public AutoraterConfig.Builder getJudgeAutoraterConfigBuilder()
       Optional. Optional configuration for the judge LLM (Autorater).
      optional .google.cloud.aiplatform.v1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

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

    • setAdditionalConfig

      public LLMBasedMetricSpec.Builder setAdditionalConfig(com.google.protobuf.Struct value)
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setAdditionalConfig

      public LLMBasedMetricSpec.Builder setAdditionalConfig(com.google.protobuf.Struct.Builder builderForValue)
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeAdditionalConfig

      public LLMBasedMetricSpec.Builder mergeAdditionalConfig(com.google.protobuf.Struct value)
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearAdditionalConfig

      public LLMBasedMetricSpec.Builder clearAdditionalConfig()
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAdditionalConfigBuilder

      public com.google.protobuf.Struct.Builder getAdditionalConfigBuilder()
       Optional. Optional additional configuration for the metric.
      optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

    • 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