Class LLMBasedMetricSpec.Builder (3.86.0)

public static final class LLMBasedMetricSpec.Builder extends GeneratedMessage.Builder<LLMBasedMetricSpec.Builder> implements LLMBasedMetricSpecOrBuilder

Specification for an LLM based metric.

Protobuf type google.cloud.aiplatform.v1beta1.LLMBasedMetricSpec

Static Methods

getDescriptor()

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

Methods

build()

public LLMBasedMetricSpec build()
Returns
Type Description
LLMBasedMetricSpec

buildPartial()

public LLMBasedMetricSpec buildPartial()
Returns
Type Description
LLMBasedMetricSpec

clear()

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

clearAdditionalConfig()

public LLMBasedMetricSpec.Builder clearAdditionalConfig()

Optional. Optional additional configuration for the metric.

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

Returns
Type Description
LLMBasedMetricSpec.Builder

clearJudgeAutoraterConfig()

public LLMBasedMetricSpec.Builder clearJudgeAutoraterConfig()

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
LLMBasedMetricSpec.Builder

clearMetricPromptTemplate()

public LLMBasedMetricSpec.Builder clearMetricPromptTemplate()

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

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

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.

clearPredefinedRubricGenerationSpec()

public LLMBasedMetricSpec.Builder clearPredefinedRubricGenerationSpec()

Dynamically generate rubrics using a predefined spec.

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

Returns
Type Description
LLMBasedMetricSpec.Builder

clearRubricGroupKey()

public LLMBasedMetricSpec.Builder clearRubricGroupKey()

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
LLMBasedMetricSpec.Builder

This builder for chaining.

clearRubricsSource()

public LLMBasedMetricSpec.Builder clearRubricsSource()
Returns
Type Description
LLMBasedMetricSpec.Builder

clearSystemInstruction()

public LLMBasedMetricSpec.Builder clearSystemInstruction()

Optional. System instructions for the judge model.

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

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.

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.

getAdditionalConfigBuilder()

public Struct.Builder getAdditionalConfigBuilder()

Optional. Optional additional configuration for the metric.

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

Returns
Type Description
Builder

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

getDescriptorForType()

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

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.

getJudgeAutoraterConfigBuilder()

public AutoraterConfig.Builder getJudgeAutoraterConfigBuilder()

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

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.

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.

getPredefinedRubricGenerationSpecBuilder()

public PredefinedMetricSpec.Builder getPredefinedRubricGenerationSpecBuilder()

Dynamically generate rubrics using a predefined spec.

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

Returns
Type Description
PredefinedMetricSpec.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdditionalConfig(Struct value)

public LLMBasedMetricSpec.Builder mergeAdditionalConfig(Struct value)

Optional. Optional additional configuration for the metric.

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

Parameter
Name Description
value Struct
Returns
Type Description
LLMBasedMetricSpec.Builder

mergeFrom(LLMBasedMetricSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeJudgeAutoraterConfig(AutoraterConfig value)

public LLMBasedMetricSpec.Builder mergeJudgeAutoraterConfig(AutoraterConfig value)

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

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

Parameter
Name Description
value AutoraterConfig
Returns
Type Description
LLMBasedMetricSpec.Builder

mergePredefinedRubricGenerationSpec(PredefinedMetricSpec value)

public LLMBasedMetricSpec.Builder mergePredefinedRubricGenerationSpec(PredefinedMetricSpec value)

Dynamically generate rubrics using a predefined spec.

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

Parameter
Name Description
value PredefinedMetricSpec
Returns
Type Description
LLMBasedMetricSpec.Builder

setAdditionalConfig(Struct value)

public LLMBasedMetricSpec.Builder setAdditionalConfig(Struct value)

Optional. Optional additional configuration for the metric.

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

Parameter
Name Description
value Struct
Returns
Type Description
LLMBasedMetricSpec.Builder

setAdditionalConfig(Struct.Builder builderForValue)

public LLMBasedMetricSpec.Builder setAdditionalConfig(Struct.Builder builderForValue)

Optional. Optional additional configuration for the metric.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
LLMBasedMetricSpec.Builder

setJudgeAutoraterConfig(AutoraterConfig value)

public LLMBasedMetricSpec.Builder setJudgeAutoraterConfig(AutoraterConfig value)

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

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

Parameter
Name Description
value AutoraterConfig
Returns
Type Description
LLMBasedMetricSpec.Builder

setJudgeAutoraterConfig(AutoraterConfig.Builder builderForValue)

public LLMBasedMetricSpec.Builder setJudgeAutoraterConfig(AutoraterConfig.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue AutoraterConfig.Builder
Returns
Type Description
LLMBasedMetricSpec.Builder

setMetricPromptTemplate(String value)

public LLMBasedMetricSpec.Builder setMetricPromptTemplate(String value)

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

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

Parameter
Name Description
value String

The metricPromptTemplate to set.

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.

setMetricPromptTemplateBytes(ByteString value)

public LLMBasedMetricSpec.Builder setMetricPromptTemplateBytes(ByteString value)

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

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
LLMBasedMetricSpec.Builder

This builder for chaining.

setPredefinedRubricGenerationSpec(PredefinedMetricSpec value)

public LLMBasedMetricSpec.Builder setPredefinedRubricGenerationSpec(PredefinedMetricSpec value)

Dynamically generate rubrics using a predefined spec.

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

Parameter
Name Description
value PredefinedMetricSpec
Returns
Type Description
LLMBasedMetricSpec.Builder

setPredefinedRubricGenerationSpec(PredefinedMetricSpec.Builder builderForValue)

public LLMBasedMetricSpec.Builder setPredefinedRubricGenerationSpec(PredefinedMetricSpec.Builder builderForValue)

Dynamically generate rubrics using a predefined spec.

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

Parameter
Name Description
builderForValue PredefinedMetricSpec.Builder
Returns
Type Description
LLMBasedMetricSpec.Builder

setRubricGroupKey(String value)

public LLMBasedMetricSpec.Builder setRubricGroupKey(String value)

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;

Parameter
Name Description
value String

The rubricGroupKey to set.

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.

setRubricGroupKeyBytes(ByteString value)

public LLMBasedMetricSpec.Builder setRubricGroupKeyBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for rubricGroupKey to set.

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.

setSystemInstruction(String value)

public LLMBasedMetricSpec.Builder setSystemInstruction(String value)

Optional. System instructions for the judge model.

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

Parameter
Name Description
value String

The systemInstruction to set.

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.

setSystemInstructionBytes(ByteString value)

public LLMBasedMetricSpec.Builder setSystemInstructionBytes(ByteString value)

Optional. System instructions for the judge model.

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

Parameter
Name Description
value ByteString

The bytes for systemInstruction to set.

Returns
Type Description
LLMBasedMetricSpec.Builder

This builder for chaining.