Class PointwiseMetricSpec.Builder (3.64.0)

public static final class PointwiseMetricSpec.Builder extends GeneratedMessageV3.Builder<PointwiseMetricSpec.Builder> implements PointwiseMetricSpecOrBuilder

Spec for pointwise metric.

Protobuf type google.cloud.aiplatform.v1beta1.PointwiseMetricSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PointwiseMetricSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

build()

public PointwiseMetricSpec build()
Returns
Type Description
PointwiseMetricSpec

buildPartial()

public PointwiseMetricSpec buildPartial()
Returns
Type Description
PointwiseMetricSpec

clear()

public PointwiseMetricSpec.Builder clear()
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

clearCustomOutputFormatConfig()

public PointwiseMetricSpec.Builder clearCustomOutputFormatConfig()

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
PointwiseMetricSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public PointwiseMetricSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

clearMetricPromptTemplate()

public PointwiseMetricSpec.Builder clearMetricPromptTemplate()

Required. Metric prompt template for pointwise metric.

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

Returns
Type Description
PointwiseMetricSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PointwiseMetricSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

clearSystemInstruction()

public PointwiseMetricSpec.Builder clearSystemInstruction()

Optional. System instructions for pointwise metric.

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

Returns
Type Description
PointwiseMetricSpec.Builder

This builder for chaining.

clone()

public PointwiseMetricSpec.Builder clone()
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

getCustomOutputFormatConfig()

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

getCustomOutputFormatConfigBuilder()

public CustomOutputFormatConfig.Builder getCustomOutputFormatConfigBuilder()

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.Builder

getCustomOutputFormatConfigOrBuilder()

public 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

getDefaultInstanceForType()

public PointwiseMetricSpec getDefaultInstanceForType()
Returns
Type Description
PointwiseMetricSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetricPromptTemplate()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomOutputFormatConfig(CustomOutputFormatConfig value)

public PointwiseMetricSpec.Builder mergeCustomOutputFormatConfig(CustomOutputFormatConfig value)

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

Parameter
Name Description
value CustomOutputFormatConfig
Returns
Type Description
PointwiseMetricSpec.Builder

mergeFrom(PointwiseMetricSpec other)

public PointwiseMetricSpec.Builder mergeFrom(PointwiseMetricSpec other)
Parameter
Name Description
other PointwiseMetricSpec
Returns
Type Description
PointwiseMetricSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PointwiseMetricSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PointwiseMetricSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PointwiseMetricSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

setCustomOutputFormatConfig(CustomOutputFormatConfig value)

public PointwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig value)

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

Parameter
Name Description
value CustomOutputFormatConfig
Returns
Type Description
PointwiseMetricSpec.Builder

setCustomOutputFormatConfig(CustomOutputFormatConfig.Builder builderForValue)

public PointwiseMetricSpec.Builder setCustomOutputFormatConfig(CustomOutputFormatConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue CustomOutputFormatConfig.Builder
Returns
Type Description
PointwiseMetricSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PointwiseMetricSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

setMetricPromptTemplate(String value)

public PointwiseMetricSpec.Builder setMetricPromptTemplate(String value)

Required. Metric prompt template for pointwise metric.

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

Parameter
Name Description
value String

The metricPromptTemplate to set.

Returns
Type Description
PointwiseMetricSpec.Builder

This builder for chaining.

setMetricPromptTemplateBytes(ByteString value)

public PointwiseMetricSpec.Builder setMetricPromptTemplateBytes(ByteString value)

Required. Metric prompt template for pointwise metric.

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

Parameter
Name Description
value ByteString

The bytes for metricPromptTemplate to set.

Returns
Type Description
PointwiseMetricSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PointwiseMetricSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides

setSystemInstruction(String value)

public PointwiseMetricSpec.Builder setSystemInstruction(String value)

Optional. System instructions for pointwise metric.

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

Parameter
Name Description
value String

The systemInstruction to set.

Returns
Type Description
PointwiseMetricSpec.Builder

This builder for chaining.

setSystemInstructionBytes(ByteString value)

public PointwiseMetricSpec.Builder setSystemInstructionBytes(ByteString value)

Optional. System instructions for pointwise metric.

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

Parameter
Name Description
value ByteString

The bytes for systemInstruction to set.

Returns
Type Description
PointwiseMetricSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PointwiseMetricSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PointwiseMetricSpec.Builder
Overrides