Package com.google.cloud.aiplatform.v1

Class PairwiseMetricSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PairwiseMetricSpec.Builder>
com.google.cloud.aiplatform.v1.PairwiseMetricSpec.Builder
All Implemented Interfaces:
PairwiseMetricSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PairwiseMetricSpec
public static final class PairwiseMetricSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<PairwiseMetricSpec.Builder> implements PairwiseMetricSpecOrBuilder
 Spec for pairwise metric.
Protobuf type google.cloud.aiplatform.v1.PairwiseMetricSpec

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

    • clear

      public PairwiseMetricSpec.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<PairwiseMetricSpec.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<PairwiseMetricSpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public PairwiseMetricSpec.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<PairwiseMetricSpec.Builder>

    • mergeFrom

      public PairwiseMetricSpec.Builder mergeFrom(PairwiseMetricSpec other)

    • isInitialized

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

    • mergeFrom

      public PairwiseMetricSpec.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<PairwiseMetricSpec.Builder>
      Throws:
      IOException

    • hasMetricPromptTemplate

      public boolean hasMetricPromptTemplate()
       Required. Metric prompt template for pairwise metric.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasMetricPromptTemplate in interface PairwiseMetricSpecOrBuilder
      Returns:
      Whether the metricPromptTemplate field is set.

    • getMetricPromptTemplate

      public String getMetricPromptTemplate()
       Required. Metric prompt template for pairwise metric.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetricPromptTemplate in interface PairwiseMetricSpecOrBuilder
      Returns:
      The metricPromptTemplate.

    • getMetricPromptTemplateBytes

      public com.google.protobuf.ByteString getMetricPromptTemplateBytes()
       Required. Metric prompt template for pairwise metric.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getMetricPromptTemplateBytes in interface PairwiseMetricSpecOrBuilder
      Returns:
      The bytes for metricPromptTemplate.

    • setMetricPromptTemplate

      public PairwiseMetricSpec.Builder setMetricPromptTemplate(String value)
       Required. Metric prompt template for pairwise metric.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The metricPromptTemplate to set.
      Returns:
      This builder for chaining.

    • clearMetricPromptTemplate

      public PairwiseMetricSpec.Builder clearMetricPromptTemplate()
       Required. Metric prompt template for pairwise metric.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setMetricPromptTemplateBytes

      public PairwiseMetricSpec.Builder setMetricPromptTemplateBytes(com.google.protobuf.ByteString value)
       Required. Metric prompt template for pairwise metric.
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for metricPromptTemplate to set.
      Returns:
      This builder for chaining.

    • getCandidateResponseFieldName

      public String getCandidateResponseFieldName()
       Optional. The field name of the candidate response.
      string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCandidateResponseFieldName in interface PairwiseMetricSpecOrBuilder
      Returns:
      The candidateResponseFieldName.

    • getCandidateResponseFieldNameBytes

      public com.google.protobuf.ByteString getCandidateResponseFieldNameBytes()
       Optional. The field name of the candidate response.
      string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCandidateResponseFieldNameBytes in interface PairwiseMetricSpecOrBuilder
      Returns:
      The bytes for candidateResponseFieldName.

    • setCandidateResponseFieldName

      public PairwiseMetricSpec.Builder setCandidateResponseFieldName(String value)
       Optional. The field name of the candidate response.
      string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The candidateResponseFieldName to set.
      Returns:
      This builder for chaining.

    • clearCandidateResponseFieldName

      public PairwiseMetricSpec.Builder clearCandidateResponseFieldName()
       Optional. The field name of the candidate response.
      string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setCandidateResponseFieldNameBytes

      public PairwiseMetricSpec.Builder setCandidateResponseFieldNameBytes(com.google.protobuf.ByteString value)
       Optional. The field name of the candidate response.
      string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for candidateResponseFieldName to set.
      Returns:
      This builder for chaining.

    • getBaselineResponseFieldName

      public String getBaselineResponseFieldName()
       Optional. The field name of the baseline response.
      string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBaselineResponseFieldName in interface PairwiseMetricSpecOrBuilder
      Returns:
      The baselineResponseFieldName.

    • getBaselineResponseFieldNameBytes

      public com.google.protobuf.ByteString getBaselineResponseFieldNameBytes()
       Optional. The field name of the baseline response.
      string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBaselineResponseFieldNameBytes in interface PairwiseMetricSpecOrBuilder
      Returns:
      The bytes for baselineResponseFieldName.

    • setBaselineResponseFieldName

      public PairwiseMetricSpec.Builder setBaselineResponseFieldName(String value)
       Optional. The field name of the baseline response.
      string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The baselineResponseFieldName to set.
      Returns:
      This builder for chaining.

    • clearBaselineResponseFieldName

      public PairwiseMetricSpec.Builder clearBaselineResponseFieldName()
       Optional. The field name of the baseline response.
      string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setBaselineResponseFieldNameBytes

      public PairwiseMetricSpec.Builder setBaselineResponseFieldNameBytes(com.google.protobuf.ByteString value)
       Optional. The field name of the baseline response.
      string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for baselineResponseFieldName to set.
      Returns:
      This builder for chaining.

    • hasSystemInstruction

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

    • getSystemInstruction

      public String getSystemInstruction()
       Optional. System instructions for pairwise metric.
      optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstruction in interface PairwiseMetricSpecOrBuilder
      Returns:
      The systemInstruction.

    • getSystemInstructionBytes

      public com.google.protobuf.ByteString getSystemInstructionBytes()
       Optional. System instructions for pairwise metric.
      optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstructionBytes in interface PairwiseMetricSpecOrBuilder
      Returns:
      The bytes for systemInstruction.

    • setSystemInstruction

      public PairwiseMetricSpec.Builder setSystemInstruction(String value)
       Optional. System instructions for pairwise metric.
      optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The systemInstruction to set.
      Returns:
      This builder for chaining.

    • clearSystemInstruction

      public PairwiseMetricSpec.Builder clearSystemInstruction()
       Optional. System instructions for pairwise metric.
      optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setSystemInstructionBytes

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

    • hasCustomOutputFormatConfig

      public boolean hasCustomOutputFormatConfig()
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomOutputFormatConfig in interface PairwiseMetricSpecOrBuilder
      Returns:
      Whether the customOutputFormatConfig field is set.

    • getCustomOutputFormatConfig

      public CustomOutputFormatConfig getCustomOutputFormatConfig()
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomOutputFormatConfig in interface PairwiseMetricSpecOrBuilder
      Returns:
      The customOutputFormatConfig.

    • setCustomOutputFormatConfig

      public PairwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig value)
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    • setCustomOutputFormatConfig

      public PairwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig.Builder builderForValue)
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    • mergeCustomOutputFormatConfig

      public PairwiseMetricSpec.Builder mergeCustomOutputFormatConfig(CustomOutputFormatConfig value)
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    • clearCustomOutputFormatConfig

      public PairwiseMetricSpec.Builder clearCustomOutputFormatConfig()
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getCustomOutputFormatConfigBuilder

      public CustomOutputFormatConfig.Builder getCustomOutputFormatConfigBuilder()
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getCustomOutputFormatConfigOrBuilder

      public CustomOutputFormatConfigOrBuilder getCustomOutputFormatConfigOrBuilder()
       Optional. CustomOutputFormatConfig allows customization of metric output.
 When this config is set, the default output is replaced with
 the raw output string.
 If a custom format is chosen, the `pairwise_choice` and `explanation`
 fields in the corresponding metric result will be empty.
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomOutputFormatConfigOrBuilder in interface PairwiseMetricSpecOrBuilder