Package com.google.cloud.aiplatform.v1

Class PairwiseMetricSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.PairwiseMetricSpec
All Implemented Interfaces:
PairwiseMetricSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PairwiseMetricSpec extends com.google.protobuf.GeneratedMessage implements PairwiseMetricSpecOrBuilder
 Spec for pairwise metric.
Protobuf type google.cloud.aiplatform.v1.PairwiseMetricSpec
See Also:

  • Field Details

    • METRIC_PROMPT_TEMPLATE_FIELD_NUMBER

      public static final int METRIC_PROMPT_TEMPLATE_FIELD_NUMBER
      See Also:

    • CANDIDATE_RESPONSE_FIELD_NAME_FIELD_NUMBER

      public static final int CANDIDATE_RESPONSE_FIELD_NAME_FIELD_NUMBER
      See Also:

    • BASELINE_RESPONSE_FIELD_NAME_FIELD_NUMBER

      public static final int BASELINE_RESPONSE_FIELD_NAME_FIELD_NUMBER
      See Also:

    • SYSTEM_INSTRUCTION_FIELD_NUMBER

      public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
      See Also:

    • CUSTOM_OUTPUT_FORMAT_CONFIG_FIELD_NUMBER

      public static final int CUSTOM_OUTPUT_FORMAT_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

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

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

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

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

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

    • 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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PairwiseMetricSpec.Builder newBuilder()

    • newBuilder

      public static PairwiseMetricSpec.Builder newBuilder(PairwiseMetricSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PairwiseMetricSpec getDefaultInstance()

    • parser

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

    • getParserForType

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