Class AutoraterConfig.Builder (3.58.0)

public static final class AutoraterConfig.Builder extends GeneratedMessageV3.Builder<AutoraterConfig.Builder> implements AutoraterConfigOrBuilder

The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.

Protobuf type google.cloud.aiplatform.v1beta1.AutoraterConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AutoraterConfig build()
Returns
Type Description
AutoraterConfig

buildPartial()

public AutoraterConfig buildPartial()
Returns
Type Description
AutoraterConfig

clear()

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

clearAutoraterModel()

public AutoraterConfig.Builder clearAutoraterModel()

Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

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

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFlipEnabled()

public AutoraterConfig.Builder clearFlipEnabled()

Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.

optional bool flip_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSamplingCount()

public AutoraterConfig.Builder clearSamplingCount()

Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.

optional int32 sampling_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

clone()

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

getAutoraterModel()

public String getAutoraterModel()

Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

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

Returns
Type Description
String

The autoraterModel.

getAutoraterModelBytes()

public ByteString getAutoraterModelBytes()

Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

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

Returns
Type Description
ByteString

The bytes for autoraterModel.

getDefaultInstanceForType()

public AutoraterConfig getDefaultInstanceForType()
Returns
Type Description
AutoraterConfig

getDescriptorForType()

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

getFlipEnabled()

public boolean getFlipEnabled()

Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.

optional bool flip_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The flipEnabled.

getSamplingCount()

public int getSamplingCount()

Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.

optional int32 sampling_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The samplingCount.

hasFlipEnabled()

public boolean hasFlipEnabled()

Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.

optional bool flip_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the flipEnabled field is set.

hasSamplingCount()

public boolean hasSamplingCount()

Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.

optional int32 sampling_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the samplingCount field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AutoraterConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAutoraterModel(String value)

public AutoraterConfig.Builder setAutoraterModel(String value)

Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

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

Parameter
Name Description
value String

The autoraterModel to set.

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

setAutoraterModelBytes(ByteString value)

public AutoraterConfig.Builder setAutoraterModelBytes(ByteString value)

Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*

Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

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

Parameter
Name Description
value ByteString

The bytes for autoraterModel to set.

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFlipEnabled(boolean value)

public AutoraterConfig.Builder setFlipEnabled(boolean value)

Optional. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.

optional bool flip_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The flipEnabled to set.

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

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

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

setSamplingCount(int value)

public AutoraterConfig.Builder setSamplingCount(int value)

Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.

optional int32 sampling_count = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The samplingCount to set.

Returns
Type Description
AutoraterConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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