com.google.cloud.aiplatform.v1beta1

Class AutoraterConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

com.google.cloud.aiplatform.v1beta1.AutoraterConfig.Builder

All Implemented Interfaces:

AutoraterConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

AutoraterConfig

public static final class AutoraterConfig.Builder
extends com.google.protobuf.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

Method Summary

Modifier and Type	Method and Description
AutoraterConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AutoraterConfig	build()
AutoraterConfig	buildPartial()
AutoraterConfig.Builder	clear()
AutoraterConfig.Builder	clearAutoraterModel() Optional.
AutoraterConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AutoraterConfig.Builder	clearFlipEnabled() Optional.
AutoraterConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AutoraterConfig.Builder	clearSamplingCount() Optional.
AutoraterConfig.Builder	clone()
String	getAutoraterModel() Optional.
com.google.protobuf.ByteString	getAutoraterModelBytes() Optional.
AutoraterConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getFlipEnabled() Optional.
int	getSamplingCount() Optional.
boolean	hasFlipEnabled() Optional.
boolean	hasSamplingCount() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AutoraterConfig.Builder	mergeFrom(AutoraterConfig other)
AutoraterConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AutoraterConfig.Builder	mergeFrom(com.google.protobuf.Message other)
AutoraterConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AutoraterConfig.Builder	setAutoraterModel(String value) Optional.
AutoraterConfig.Builder	setAutoraterModelBytes(com.google.protobuf.ByteString value) Optional.
AutoraterConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AutoraterConfig.Builder	setFlipEnabled(boolean value) Optional.
AutoraterConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AutoraterConfig.Builder	setSamplingCount(int value) Optional.
AutoraterConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

clear

public AutoraterConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

getDefaultInstanceForType

public AutoraterConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AutoraterConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AutoraterConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AutoraterConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

setField

public AutoraterConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

clearField

public AutoraterConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

clearOneof

public AutoraterConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

setRepeatedField

public AutoraterConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

addRepeatedField

public AutoraterConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

mergeFrom

public AutoraterConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AutoraterConfig.Builder>

mergeFrom

public AutoraterConfig.Builder mergeFrom(AutoraterConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

mergeFrom

public AutoraterConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AutoraterConfig.Builder>

Throws:

IOException

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

Specified by:

hasSamplingCount in interface AutoraterConfigOrBuilder

Returns:

Whether the samplingCount field is set.

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

Specified by:

getSamplingCount in interface AutoraterConfigOrBuilder

Returns:

The samplingCount.

setSamplingCount

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

Parameters:

value - The samplingCount to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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

Specified by:

hasFlipEnabled in interface AutoraterConfigOrBuilder

Returns:

Whether the flipEnabled field is set.

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

Specified by:

getFlipEnabled in interface AutoraterConfigOrBuilder

Returns:

The flipEnabled.

setFlipEnabled

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

Parameters:

value - The flipEnabled to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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

Specified by:

getAutoraterModel in interface AutoraterConfigOrBuilder

Returns:

The autoraterModel.

getAutoraterModelBytes

public com.google.protobuf.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];

Specified by:

getAutoraterModelBytes in interface AutoraterConfigOrBuilder

Returns:

The bytes for autoraterModel.

setAutoraterModel

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

Parameters:

value - The autoraterModel to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setAutoraterModelBytes

public AutoraterConfig.Builder setAutoraterModelBytes(com.google.protobuf.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];

Parameters:

value - The bytes for autoraterModel to set.

Returns:

This builder for chaining.

setUnknownFields

public final AutoraterConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>

mergeUnknownFields

public final AutoraterConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AutoraterConfig.Builder>