Class PointwiseMetricSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PointwiseMetricSpec.Builder>
com.google.cloud.aiplatform.v1.PointwiseMetricSpec.Builder
All Implemented Interfaces:
PointwiseMetricSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PointwiseMetricSpec

public static final class PointwiseMetricSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<PointwiseMetricSpec.Builder> implements PointwiseMetricSpecOrBuilder
 Spec for pointwise metric.
 
Protobuf type google.cloud.aiplatform.v1.PointwiseMetricSpec
  • 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<PointwiseMetricSpec.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<PointwiseMetricSpec.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<PointwiseMetricSpec.Builder>
    • getDefaultInstanceForType

      public PointwiseMetricSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public PointwiseMetricSpec.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<PointwiseMetricSpec.Builder>
    • mergeFrom

    • isInitialized

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

      public PointwiseMetricSpec.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<PointwiseMetricSpec.Builder>
      Throws:
      IOException
    • hasMetricPromptTemplate

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

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

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

      public PointwiseMetricSpec.Builder setMetricPromptTemplate(String value)
       Required. Metric prompt template for pointwise 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 PointwiseMetricSpec.Builder clearMetricPromptTemplate()
       Required. Metric prompt template for pointwise metric.
       
      optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • setMetricPromptTemplateBytes

      public PointwiseMetricSpec.Builder setMetricPromptTemplateBytes(com.google.protobuf.ByteString value)
       Required. Metric prompt template for pointwise 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.
    • hasSystemInstruction

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

      public String getSystemInstruction()
       Optional. System instructions for pointwise metric.
       
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstruction in interface PointwiseMetricSpecOrBuilder
      Returns:
      The systemInstruction.
    • getSystemInstructionBytes

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

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

      public PointwiseMetricSpec.Builder clearSystemInstruction()
       Optional. System instructions for pointwise metric.
       
      optional string system_instruction = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setSystemInstructionBytes

      public PointwiseMetricSpec.Builder setSystemInstructionBytes(com.google.protobuf.ByteString value)
       Optional. System instructions for pointwise metric.
       
      optional string system_instruction = 2 [(.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.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomOutputFormatConfig in interface PointwiseMetricSpecOrBuilder
      Returns:
      Whether the customOutputFormatConfig field is set.
    • getCustomOutputFormatConfig

      public CustomOutputFormatConfig getCustomOutputFormatConfig()
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomOutputFormatConfig in interface PointwiseMetricSpecOrBuilder
      Returns:
      The customOutputFormatConfig.
    • setCustomOutputFormatConfig

      public PointwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig value)
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
    • setCustomOutputFormatConfig

      public PointwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig.Builder builderForValue)
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
    • mergeCustomOutputFormatConfig

      public PointwiseMetricSpec.Builder mergeCustomOutputFormatConfig(CustomOutputFormatConfig value)
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
    • clearCustomOutputFormatConfig

      public PointwiseMetricSpec.Builder clearCustomOutputFormatConfig()
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
    • getCustomOutputFormatConfigBuilder

      public CustomOutputFormatConfig.Builder getCustomOutputFormatConfigBuilder()
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
    • getCustomOutputFormatConfigOrBuilder

      public CustomOutputFormatConfigOrBuilder getCustomOutputFormatConfigOrBuilder()
       Optional. CustomOutputFormatConfig allows customization of metric output.
       By default, metrics return a score and explanation.
       When this config is set, the default output is replaced with either:
       - The raw output string.
       - A parsed output based on a user-defined schema.
       If a custom format is chosen, the `score` and `explanation` fields in the
       corresponding metric result will be empty.
       
      .google.cloud.aiplatform.v1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomOutputFormatConfigOrBuilder in interface PointwiseMetricSpecOrBuilder