Module: Deeprails::Models::MonitorCreateParams::GuardrailMetric

Extended by:
Internal::Type::Enum
Defined in:
lib/deeprails/models/monitor_create_params.rb

Constant Summary collapse

CORRECTNESS = 
:correctness
COMPLETENESS = 
:completeness
INSTRUCTION_ADHERENCE = 
:instruction_adherence
CONTEXT_ADHERENCE = 
:context_adherence
GROUND_TRUTH_ADHERENCE = 
:ground_truth_adherence
COMPREHENSIVE_SAFETY = 
:comprehensive_safety

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/deeprails/models/monitor_create_params.rb', line 71

Instance Method Details

#initialize(guardrail_metrics:, name:, description: nil, file_search: nil, web_search: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Deeprails::Models::MonitorCreateParams for more details.

Parameters:

  • guardrail_metrics (Array<Symbol, Deeprails::Models::MonitorCreateParams::GuardrailMetric>) —

    An array of guardrail metrics that the model input and output pair will be evalu

  • name (String) —

    Name of the new monitor.

  • description (String) (defaults to: nil) —

    Description of the new monitor.

  • file_search (Array<String>) (defaults to: nil) —

    An array of file IDs to search in the monitor’s evaluations. Files must be uploa

  • web_search (Boolean) (defaults to: nil) —

    Whether to enable web search for this monitor’s evaluations. Defaults to false.

  • request_options (Deeprails::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/deeprails/models/monitor_create_params.rb', line 61

module GuardrailMetric
  extend Deeprails::Internal::Type::Enum

  CORRECTNESS = :correctness
  COMPLETENESS = :completeness
  INSTRUCTION_ADHERENCE = :instruction_adherence
  CONTEXT_ADHERENCE = :context_adherence
  GROUND_TRUTH_ADHERENCE = :ground_truth_adherence
  COMPREHENSIVE_SAFETY = :comprehensive_safety

  # @!method self.values
  #   @return [Array<Symbol>]
end