com.google.cloud.aiplatform.v1beta1

Interface PairwiseMetricSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PairwiseMetricSpec, PairwiseMetricSpec.Builder

public interface PairwiseMetricSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getBaselineResponseFieldName() Optional.
com.google.protobuf.ByteString	getBaselineResponseFieldNameBytes() Optional.
String	getCandidateResponseFieldName() Optional.
com.google.protobuf.ByteString	getCandidateResponseFieldNameBytes() Optional.
CustomOutputFormatConfig	getCustomOutputFormatConfig() Optional.
CustomOutputFormatConfigOrBuilder	getCustomOutputFormatConfigOrBuilder() Optional.
String	getMetricPromptTemplate() Required.
com.google.protobuf.ByteString	getMetricPromptTemplateBytes() Required.
String	getSystemInstruction() Optional.
com.google.protobuf.ByteString	getSystemInstructionBytes() Optional.
boolean	hasCustomOutputFormatConfig() Optional.
boolean	hasMetricPromptTemplate() Required.
boolean	hasSystemInstruction() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasMetricPromptTemplate

boolean hasMetricPromptTemplate()

 Required. Metric prompt template for pairwise metric.
 

optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the metricPromptTemplate field is set.

getMetricPromptTemplate

String getMetricPromptTemplate()

 Required. Metric prompt template for pairwise metric.
 

optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The metricPromptTemplate.

getMetricPromptTemplateBytes

com.google.protobuf.ByteString getMetricPromptTemplateBytes()

 Required. Metric prompt template for pairwise metric.
 

optional string metric_prompt_template = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for metricPromptTemplate.

getCandidateResponseFieldName

String getCandidateResponseFieldName()

 Optional. The field name of the candidate response.
 

string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The candidateResponseFieldName.

getCandidateResponseFieldNameBytes

com.google.protobuf.ByteString getCandidateResponseFieldNameBytes()

 Optional. The field name of the candidate response.
 

string candidate_response_field_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for candidateResponseFieldName.

getBaselineResponseFieldName

String getBaselineResponseFieldName()

 Optional. The field name of the baseline response.
 

string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The baselineResponseFieldName.

getBaselineResponseFieldNameBytes

com.google.protobuf.ByteString getBaselineResponseFieldNameBytes()

 Optional. The field name of the baseline response.
 

string baseline_response_field_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for baselineResponseFieldName.

hasSystemInstruction

boolean hasSystemInstruction()

 Optional. System instructions for pairwise metric.
 

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

Returns:

Whether the systemInstruction field is set.

getSystemInstruction

String getSystemInstruction()

 Optional. System instructions for pairwise metric.
 

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

Returns:

The systemInstruction.

getSystemInstructionBytes

com.google.protobuf.ByteString getSystemInstructionBytes()

 Optional. System instructions for pairwise metric.
 

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

Returns:

The bytes for systemInstruction.

hasCustomOutputFormatConfig

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:

Whether the customOutputFormatConfig field is set.

getCustomOutputFormatConfig

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:

The customOutputFormatConfig.

getCustomOutputFormatConfigOrBuilder

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