Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LlmBasedMetricSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

Specification for an LLM based metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1LlmBasedMetricSpec

Returns a new instance of GoogleCloudAiplatformV1LlmBasedMetricSpec.



19435
19436
19437
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19435

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_config ⇒ Hash<String,Object>

Optional. Optional additional configuration for the metric. Corresponds to the JSON property additionalConfig

Returns:

  • (Hash<String,Object>) 


19395
19396
19397
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19395

def additional_config
  @additional_config
end

#judge_autorater_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AutoraterConfig

The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. Corresponds to the JSON property judgeAutoraterConfig

Returns:



19401
19402
19403
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19401

def judge_autorater_config
  @judge_autorater_config
end

#metric_prompt_template ⇒ String

Required. Template for the prompt sent to the judge model. Corresponds to the JSON property metricPromptTemplate

Returns:

  • (String) 


19406
19407
19408
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19406

def metric_prompt_template
  @metric_prompt_template
end

#predefined_rubric_generation_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredefinedMetricSpec

The spec for a pre-defined metric. Corresponds to the JSON property predefinedRubricGenerationSpec

Returns:



19411
19412
19413
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19411

def predefined_rubric_generation_spec
  @predefined_rubric_generation_spec
end

#result_parser_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationParserConfig

Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. Corresponds to the JSON property resultParserConfig

Returns:



19417
19418
19419
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19417

def result_parser_config
  @result_parser_config
end

#rubric_generation_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricGenerationSpec

Specification for how rubrics should be generated. Corresponds to the JSON property rubricGenerationSpec

Returns:



19422
19423
19424
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19422

def rubric_generation_spec
  @rubric_generation_spec
end

#rubric_group_key ⇒ String

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

Returns:

  • (String) 


19428
19429
19430
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19428

def rubric_group_key
  @rubric_group_key
end

#system_instruction ⇒ String

Optional. System instructions for the judge model. Corresponds to the JSON property systemInstruction

Returns:

  • (String) 


19433
19434
19435
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19433

def system_instruction
  @system_instruction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 19440

def update!(**args)
  @additional_config = args[:additional_config] if args.key?(:additional_config)
  @judge_autorater_config = args[:judge_autorater_config] if args.key?(:judge_autorater_config)
  @metric_prompt_template = args[:metric_prompt_template] if args.key?(:metric_prompt_template)
  @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
  @result_parser_config = args[:result_parser_config] if args.key?(:result_parser_config)
  @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
  @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
end