Class PairwiseMetricSpec (3.77.0)
Version 3.77.0keyboard_arrow_down
public final class PairwiseMetricSpec extends GeneratedMessageV3 implements PairwiseMetricSpecOrBuilder
Spec for pairwise metric.
Protobuf type google.cloud.aiplatform.v1beta1.PairwiseMetricSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int BASELINE_RESPONSE_FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int CANDIDATE_RESPONSE_FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int CUSTOM_OUTPUT_FORMAT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
public static final int METRIC_PROMPT_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static PairwiseMetricSpec getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static PairwiseMetricSpec . Builder newBuilder ()
public static PairwiseMetricSpec . Builder newBuilder ( PairwiseMetricSpec prototype )
public static PairwiseMetricSpec parseDelimitedFrom ( InputStream input )
public static PairwiseMetricSpec parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static PairwiseMetricSpec parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static PairwiseMetricSpec parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static PairwiseMetricSpec parseFrom ( ByteString data )
public static PairwiseMetricSpec parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PairwiseMetricSpec parseFrom ( CodedInputStream input )
public static PairwiseMetricSpec parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PairwiseMetricSpec parseFrom ( InputStream input )
public static PairwiseMetricSpec parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static PairwiseMetricSpec parseFrom ( ByteBuffer data )
public static PairwiseMetricSpec parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<PairwiseMetricSpec> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public String getBaselineResponseFieldName ()
Optional. The field name of the baseline response.
string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The baselineResponseFieldName.
public ByteString getBaselineResponseFieldNameBytes ()
Optional. The field name of the baseline response.
string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for baselineResponseFieldName.
public String getCandidateResponseFieldName ()
Optional. The field name of the candidate response.
string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The candidateResponseFieldName.
public ByteString getCandidateResponseFieldNameBytes ()
Optional. The field name of the candidate response.
string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for candidateResponseFieldName.
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.v1beta1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];
public PairwiseMetricSpec getDefaultInstanceForType ()
public String getMetricPromptTemplate ()
Required. Metric prompt template for pairwise metric.
optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The metricPromptTemplate.
public ByteString getMetricPromptTemplateBytes ()
Required. Metric prompt template for pairwise metric.
optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for metricPromptTemplate.
public Parser<PairwiseMetricSpec> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public String getSystemInstruction ()
Optional. System instructions for pairwise metric.
optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The systemInstruction.
public ByteString getSystemInstructionBytes ()
Optional. System instructions for pairwise metric.
optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for systemInstruction.
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.v1beta1.CustomOutputFormatConfig custom_output_format_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the customOutputFormatConfig field is set.
public boolean hasMetricPromptTemplate ()
Required. Metric prompt template for pairwise metric.
optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
boolean Whether the metricPromptTemplate field is set.
public boolean hasSystemInstruction ()
Optional. System instructions for pairwise metric.
optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the systemInstruction field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public PairwiseMetricSpec . Builder newBuilderForType ()
protected PairwiseMetricSpec . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public PairwiseMetricSpec . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
