com.google.cloud.aiplatform.v1beta1

Interface PointwiseMetricSpecOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

PointwiseMetricSpec, PointwiseMetricSpec.Builder

public interface PointwiseMetricSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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 pointwise 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 pointwise 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 pointwise metric.
 

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

Returns:

The bytes for metricPromptTemplate.

hasSystemInstruction

boolean hasSystemInstruction()

 Optional. System instructions for pointwise metric.
 

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

Returns:

Whether the systemInstruction field is set.

getSystemInstruction

String getSystemInstruction()

 Optional. System instructions for pointwise metric.
 

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

Returns:

The systemInstruction.

getSystemInstructionBytes

com.google.protobuf.ByteString getSystemInstructionBytes()

 Optional. System instructions for pointwise metric.
 

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

Returns:

The bytes for systemInstruction.

hasCustomOutputFormatConfig

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:

Whether the customOutputFormatConfig field is set.

getCustomOutputFormatConfig

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:

The customOutputFormatConfig.

getCustomOutputFormatConfigOrBuilder

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