Class PairwiseMetricSpec.Builder (3.58.0)

public static final class PairwiseMetricSpec.Builder extends GeneratedMessageV3.Builder<PairwiseMetricSpec.Builder> implements PairwiseMetricSpecOrBuilder

Spec for pairwise metric.

Protobuf type google.cloud.aiplatform.v1beta1.PairwiseMetricSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PairwiseMetricSpec build()
Returns
Type Description
PairwiseMetricSpec

buildPartial()

public PairwiseMetricSpec buildPartial()
Returns
Type Description
PairwiseMetricSpec

clear()

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

clearBaselineResponseFieldName()

public PairwiseMetricSpec.Builder clearBaselineResponseFieldName()

Optional. The field name of the baseline response.

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

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

clearCandidateResponseFieldName()

public PairwiseMetricSpec.Builder clearCandidateResponseFieldName()

Optional. The field name of the candidate response.

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

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMetricPromptTemplate()

public PairwiseMetricSpec.Builder clearMetricPromptTemplate()

Required. Metric prompt template for pairwise metric.

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

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSystemInstruction()

public PairwiseMetricSpec.Builder clearSystemInstruction()

Optional. System instructions for pairwise metric.

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

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

clone()

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

getBaselineResponseFieldName()

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

getDefaultInstanceForType()

public PairwiseMetricSpec getDefaultInstanceForType()
Returns
Type Description
PairwiseMetricSpec

getDescriptorForType()

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

getMetricPromptTemplate()

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

hasMetricPromptTemplate()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PairwiseMetricSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBaselineResponseFieldName(String value)

public PairwiseMetricSpec.Builder setBaselineResponseFieldName(String value)

Optional. The field name of the baseline response.

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

Parameter
Name Description
value String

The baselineResponseFieldName to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setBaselineResponseFieldNameBytes(ByteString value)

public PairwiseMetricSpec.Builder setBaselineResponseFieldNameBytes(ByteString value)

Optional. The field name of the baseline response.

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

Parameter
Name Description
value ByteString

The bytes for baselineResponseFieldName to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setCandidateResponseFieldName(String value)

public PairwiseMetricSpec.Builder setCandidateResponseFieldName(String value)

Optional. The field name of the candidate response.

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

Parameter
Name Description
value String

The candidateResponseFieldName to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setCandidateResponseFieldNameBytes(ByteString value)

public PairwiseMetricSpec.Builder setCandidateResponseFieldNameBytes(ByteString value)

Optional. The field name of the candidate response.

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

Parameter
Name Description
value ByteString

The bytes for candidateResponseFieldName to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetricPromptTemplate(String value)

public PairwiseMetricSpec.Builder setMetricPromptTemplate(String value)

Required. Metric prompt template for pairwise metric.

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

Parameter
Name Description
value String

The metricPromptTemplate to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setMetricPromptTemplateBytes(ByteString value)

public PairwiseMetricSpec.Builder setMetricPromptTemplateBytes(ByteString value)

Required. Metric prompt template for pairwise 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
PairwiseMetricSpec.Builder

This builder for chaining.

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

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

setSystemInstruction(String value)

public PairwiseMetricSpec.Builder setSystemInstruction(String value)

Optional. System instructions for pairwise metric.

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

Parameter
Name Description
value String

The systemInstruction to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setSystemInstructionBytes(ByteString value)

public PairwiseMetricSpec.Builder setSystemInstructionBytes(ByteString value)

Optional. System instructions for pairwise metric.

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

Parameter
Name Description
value ByteString

The bytes for systemInstruction to set.

Returns
Type Description
PairwiseMetricSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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