Class: OpenAI::Models::Graders::TextSimilarityGrader

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/graders/text_similarity_grader.rb

Defined Under Namespace

Modules: EvaluationMetric

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(evaluation_metric: , input: , name: , reference: , type: :text_similarity) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Graders::TextSimilarityGrader for more details.

A TextSimilarityGrader object which grades text based on similarity metrics.

Parameters:

  • evaluation_metric (Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric) (defaults to: ) —

    The evaluation metric to use. One of ‘fuzzy_match`, `bleu`, `gleu`, `meteor`, `r

  • input (String) (defaults to: ) —

    The text being graded.

  • name (String) (defaults to: ) —

    The name of the grader.

  • reference (String) (defaults to: ) —

    The text being graded against.

  • type (Symbol, :text_similarity) (defaults to: :text_similarity) —

    The type of grader.




# File 'lib/openai/models/graders/text_similarity_grader.rb', line 38

Instance Attribute Details

#evaluation_metric ⇒ Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric

The evaluation metric to use. One of ‘fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.

Returns:



12
 
# File 'lib/openai/models/graders/text_similarity_grader.rb', line 12

required :evaluation_metric, enum: -> { OpenAI::Graders::TextSimilarityGrader::EvaluationMetric }

#input ⇒ String

The text being graded.

Returns:

  • (String) 


18
 
# File 'lib/openai/models/graders/text_similarity_grader.rb', line 18

required :input, String

#name ⇒ String

The name of the grader.

Returns:

  • (String) 


24
 
# File 'lib/openai/models/graders/text_similarity_grader.rb', line 24

required :name, String

#reference ⇒ String

The text being graded against.

Returns:

  • (String) 


30
 
# File 'lib/openai/models/graders/text_similarity_grader.rb', line 30

required :reference, String

#type ⇒ Symbol, :text_similarity

The type of grader.

Returns:

  • (Symbol, :text_similarity) 


36
 
# File 'lib/openai/models/graders/text_similarity_grader.rb', line 36

required :type, const: :text_similarity