Class LLMBasedMetricSpec (3.86.0)

Version latest

• 3.86.0 (latest)
• 3.84.0
• 3.83.0
• 3.82.0
• 3.81.0
• 3.79.0
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class LLMBasedMetricSpec extends GeneratedMessage implements LLMBasedMetricSpecOrBuilder

Specification for an LLM based metric.

Protobuf type google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LLMBasedMetricSpec

Implements

LLMBasedMetricSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ADDITIONAL_CONFIG_FIELD_NUMBER

public static final int ADDITIONAL_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

JUDGE_AUTORATER_CONFIG_FIELD_NUMBER

public static final int JUDGE_AUTORATER_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

METRIC_PROMPT_TEMPLATE_FIELD_NUMBER

public static final int METRIC_PROMPT_TEMPLATE_FIELD_NUMBER

Field Value
Type	Description
int

PREDEFINED_RUBRIC_GENERATION_SPEC_FIELD_NUMBER

public static final int PREDEFINED_RUBRIC_GENERATION_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

RUBRIC_GROUP_KEY_FIELD_NUMBER

public static final int RUBRIC_GROUP_KEY_FIELD_NUMBER

Field Value
Type	Description
int

SYSTEM_INSTRUCTION_FIELD_NUMBER

public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static LLMBasedMetricSpec getDefaultInstance()

Returns
Type	Description
LLMBasedMetricSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static LLMBasedMetricSpec.Builder newBuilder()

Returns
Type	Description
LLMBasedMetricSpec.Builder

newBuilder(LLMBasedMetricSpec prototype)

public static LLMBasedMetricSpec.Builder newBuilder(LLMBasedMetricSpec prototype)

Parameter
Name	Description
prototype	LLMBasedMetricSpec

Returns
Type	Description
LLMBasedMetricSpec.Builder

parseDelimitedFrom(InputStream input)

public static LLMBasedMetricSpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LLMBasedMetricSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static LLMBasedMetricSpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LLMBasedMetricSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LLMBasedMetricSpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LLMBasedMetricSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LLMBasedMetricSpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LLMBasedMetricSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static LLMBasedMetricSpec parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LLMBasedMetricSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static LLMBasedMetricSpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LLMBasedMetricSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LLMBasedMetricSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<LLMBasedMetricSpec> parser()

Returns
Type	Description
Parser<LLMBasedMetricSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAdditionalConfig()

public Struct getAdditionalConfig()

Optional. Optional additional configuration for the metric.

optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The additionalConfig.

getAdditionalConfigOrBuilder()

public StructOrBuilder getAdditionalConfigOrBuilder()

Optional. Optional additional configuration for the metric.

optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getDefaultInstanceForType()

public LLMBasedMetricSpec getDefaultInstanceForType()

Returns
Type	Description
LLMBasedMetricSpec

getJudgeAutoraterConfig()

public AutoraterConfig getJudgeAutoraterConfig()

Optional. Optional configuration for the judge LLM (Autorater).

optional .google.cloud.aiplatform.v1beta1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AutoraterConfig	The judgeAutoraterConfig.

getJudgeAutoraterConfigOrBuilder()

public AutoraterConfigOrBuilder getJudgeAutoraterConfigOrBuilder()

Optional. Optional configuration for the judge LLM (Autorater).

optional .google.cloud.aiplatform.v1beta1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AutoraterConfigOrBuilder

getMetricPromptTemplate()

public String getMetricPromptTemplate()

Required. Template for the prompt sent to the judge model.

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

Returns
Type	Description
String	The metricPromptTemplate.

getMetricPromptTemplateBytes()

public ByteString getMetricPromptTemplateBytes()

Required. Template for the prompt sent to the judge model.

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

Returns
Type	Description
ByteString	The bytes for metricPromptTemplate.

getParserForType()

public Parser<LLMBasedMetricSpec> getParserForType()

Returns
Type	Description
Parser<LLMBasedMetricSpec>

Overrides

GeneratedMessage.getParserForType()

getPredefinedRubricGenerationSpec()

public PredefinedMetricSpec getPredefinedRubricGenerationSpec()

Dynamically generate rubrics using a predefined spec.

.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

Returns
Type	Description
PredefinedMetricSpec	The predefinedRubricGenerationSpec.

getPredefinedRubricGenerationSpecOrBuilder()

public PredefinedMetricSpecOrBuilder getPredefinedRubricGenerationSpecOrBuilder()

Dynamically generate rubrics using a predefined spec.

.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

Returns
Type	Description
PredefinedMetricSpecOrBuilder

getRubricGroupKey()

public String getRubricGroupKey()

Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.

string rubric_group_key = 4;

Returns
Type	Description
String	The rubricGroupKey.

getRubricGroupKeyBytes()

public ByteString getRubricGroupKeyBytes()

Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.

string rubric_group_key = 4;

Returns
Type	Description
ByteString	The bytes for rubricGroupKey.

getRubricsSourceCase()

public LLMBasedMetricSpec.RubricsSourceCase getRubricsSourceCase()

Returns
Type	Description
LLMBasedMetricSpec.RubricsSourceCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSystemInstruction()

public String getSystemInstruction()

Optional. System instructions for the judge model.

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

Returns
Type	Description
String	The systemInstruction.

getSystemInstructionBytes()

public ByteString getSystemInstructionBytes()

Optional. System instructions for the judge model.

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

Returns
Type	Description
ByteString	The bytes for systemInstruction.

hasAdditionalConfig()

public boolean hasAdditionalConfig()

Optional. Optional additional configuration for the metric.

optional .google.protobuf.Struct additional_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the additionalConfig field is set.

hasJudgeAutoraterConfig()

public boolean hasJudgeAutoraterConfig()

Optional. Optional configuration for the judge LLM (Autorater).

optional .google.cloud.aiplatform.v1beta1.AutoraterConfig judge_autorater_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the judgeAutoraterConfig field is set.

hasMetricPromptTemplate()

public boolean hasMetricPromptTemplate()

Required. Template for the prompt sent to the judge model.

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

Returns
Type	Description
boolean	Whether the metricPromptTemplate field is set.

hasPredefinedRubricGenerationSpec()

public boolean hasPredefinedRubricGenerationSpec()

Dynamically generate rubrics using a predefined spec.

.google.cloud.aiplatform.v1beta1.PredefinedMetricSpec predefined_rubric_generation_spec = 6;

Returns
Type	Description
boolean	Whether the predefinedRubricGenerationSpec field is set.

hasRubricGroupKey()

public boolean hasRubricGroupKey()

Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.

string rubric_group_key = 4;

Returns
Type	Description
boolean	Whether the rubricGroupKey field is set.

hasSystemInstruction()

public boolean hasSystemInstruction()

Optional. System instructions for the judge model.

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

Returns
Type	Description
boolean	Whether the systemInstruction field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public LLMBasedMetricSpec.Builder newBuilderForType()

Returns
Type	Description
LLMBasedMetricSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LLMBasedMetricSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
LLMBasedMetricSpec.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public LLMBasedMetricSpec.Builder toBuilder()

Returns
Type	Description
LLMBasedMetricSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException