Interface PairwiseMetricSpecOrBuilder (3.79.0)

Version latest

• 3.79.0 (latest)
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface PairwiseMetricSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBaselineResponseFieldName()

public abstract 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.

getBaselineResponseFieldNameBytes()

public abstract 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.

getCandidateResponseFieldName()

public abstract 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.

getCandidateResponseFieldNameBytes()

public abstract 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.

getCustomOutputFormatConfig()

public abstract 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];

Returns
Type	Description
CustomOutputFormatConfig	The customOutputFormatConfig.

getCustomOutputFormatConfigOrBuilder()

public abstract 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];

Returns
Type	Description
CustomOutputFormatConfigOrBuilder

getMetricPromptTemplate()

public abstract 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.

getMetricPromptTemplateBytes()

public abstract 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.

getSystemInstruction()

public abstract String getSystemInstruction()

Optional. System instructions for pairwise metric.

optional string system_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The systemInstruction.

getSystemInstructionBytes()

public abstract 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.

hasCustomOutputFormatConfig()

public abstract 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.

hasMetricPromptTemplate()

public abstract 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.

hasSystemInstruction()

public abstract 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.