Interface PointwiseMetricSpecOrBuilder (3.88.0) 

public interface PointwiseMetricSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomOutputFormatConfig()

public abstract 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.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomOutputFormatConfig

The customOutputFormatConfig.

getCustomOutputFormatConfigOrBuilder()

public abstract 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.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomOutputFormatConfigOrBuilder

getMetricPromptTemplate()

public abstract String getMetricPromptTemplate()

Required. Metric prompt template for pointwise 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 pointwise 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 pointwise metric.

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

Returns
Type Description
String

The systemInstruction.

getSystemInstructionBytes()

public abstract ByteString getSystemInstructionBytes()

Optional. System instructions for pointwise metric.

optional string system_instruction = 2 [(.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. 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.v1beta1.CustomOutputFormatConfig custom_output_format_config = 3 [(.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 pointwise 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 pointwise metric.

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

Returns
Type Description
boolean

Whether the systemInstruction field is set.