Module: Deeprails::Models::MonitorUpdateParams::GuardrailMetric

Extended by:
Internal::Type::Enum
Defined in:
lib/deeprails/models/monitor_update_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

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

Instance Method Details

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

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

Parameters:

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

    New description of the monitor.

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

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

  • guardrail_metrics (Array<Symbol, Deeprails::Models::MonitorUpdateParams::GuardrailMetric>) (defaults to: nil) —

    An array of the new guardrail metrics that model input and output pairs will be

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

    New name of the monitor.

  • status (Symbol, Deeprails::Models::MonitorUpdateParams::Status) (defaults to: nil) —

    Status of the monitor. Can be active or inactive. Inactive monitors no lon

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

    Whether to enable web search for this monitor's evaluations.

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


75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/deeprails/models/monitor_update_params.rb', line 75

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