Class: Deeprails::Models::MonitorCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/deeprails/models/monitor_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: GuardrailMetric

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

This class inherits a constructor from Deeprails::Internal::Type::BaseModel

Instance Attribute Details

#description ⇒ String?

Description of the new monitor.

Returns:

  • (String, nil) 


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

optional :description, String

#file_search ⇒ Array<String>?

An array of file IDs to search in the monitor’s evaluations. Files must be uploaded via the DeepRails API first.

Returns:

  • (Array<String>, nil) 


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

optional :file_search, Deeprails::Internal::Type::ArrayOf[String]

#guardrail_metrics ⇒ Array<Symbol, Deeprails::Models::MonitorCreateParams::GuardrailMetric>

An array of guardrail metrics that the model input and output pair will be evaluated on. For non-enterprise users, these will be limited to ‘correctness`, `completeness`, `instruction_adherence`, `context_adherence`, `ground_truth_adherence`, and/or `comprehensive_safety`.

Returns:



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

required :guardrail_metrics,
-> { Deeprails::Internal::Type::ArrayOf[enum: Deeprails::MonitorCreateParams::GuardrailMetric] }

#name ⇒ String

Name of the new monitor.

Returns:

  • (String) 


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

required :name, String

#web_search ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


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

optional :web_search, Deeprails::Internal::Type::Boolean