Class AutoraterConfig (3.58.0)

public final class AutoraterConfig extends GeneratedMessageV3 implements AutoraterConfigOrBuilder

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

Protobuf type google.cloud.aiplatform.v1beta1.AutoraterConfig

Static Fields

AUTORATER_MODEL_FIELD_NUMBER

public static final int AUTORATER_MODEL_FIELD_NUMBER
Field Value
Type Description
int

FLIP_ENABLED_FIELD_NUMBER

public static final int FLIP_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

SAMPLING_COUNT_FIELD_NUMBER

public static final int SAMPLING_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutoraterConfig getDefaultInstance()
Returns
Type Description
AutoraterConfig

getDescriptor()

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

newBuilder()

public static AutoraterConfig.Builder newBuilder()
Returns
Type Description
AutoraterConfig.Builder

newBuilder(AutoraterConfig prototype)

public static AutoraterConfig.Builder newBuilder(AutoraterConfig prototype)
Parameter
Name Description
prototype AutoraterConfig
Returns
Type Description
AutoraterConfig.Builder

parseDelimitedFrom(InputStream input)

public static AutoraterConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoraterConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AutoraterConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AutoraterConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AutoraterConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AutoraterConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AutoraterConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoraterConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AutoraterConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AutoraterConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AutoraterConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AutoraterConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AutoraterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AutoraterConfig> parser()
Returns
Type Description
Parser<AutoraterConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<AutoraterConfig> getParserForType()
Returns
Type Description
Parser<AutoraterConfig>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AutoraterConfig.Builder newBuilderForType()
Returns
Type Description
AutoraterConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AutoraterConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AutoraterConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AutoraterConfig.Builder toBuilder()
Returns
Type Description
AutoraterConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException