Class: Deeprails::Models::DefendSubmitEventParams

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

Overview

See Also:

Defined Under Namespace

Modules: RunMode Classes: ModelInput

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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, 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

#initialize(content: nil, role: nil) ⇒ Object

Parameters:

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

    The content of the message.

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

    The role of the speaker.




# File 'lib/deeprails/models/defend_submit_event_params.rb', line 130

Instance Attribute Details

#model_input ⇒ Deeprails::Models::DefendSubmitEventParams::ModelInput

A dictionary of inputs sent to the LLM to generate output. The dictionary must contain a user_prompt field. For the ground_truth_adherence guardrail metric, ground_truth should be provided.

Returns:



21
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 21

required :model_input, -> { Deeprails::DefendSubmitEventParams::ModelInput }

#model_output ⇒ String

Output generated by the LLM to be evaluated.

Returns:

  • (String) 


27
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 27

required :model_output, String

#model_used ⇒ String

Model ID used to generate the output, like gpt-4o or o3.

Returns:

  • (String) 


33
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 33

required :model_used, String

#nametag ⇒ String?

An optional, user-defined tag for the event.

Returns:

  • (String, nil) 


51
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 51

optional :nametag, String

#run_mode ⇒ Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode

Run mode for the workflow event. The run mode allows the user to optimize for speed, accuracy, and cost by determining which models are used to evaluate the event. Available run modes (fastest to most thorough): super_fast, fast, precision, precision_codex, precision_max, and precision_max_codex. Defaults to fast. Note: super_fast does not support Web Search or File Search — if your workflow has these capabilities enabled, use a different run mode or edit the workflow to disable them.

Returns:



45
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 45

required :run_mode, enum: -> { Deeprails::DefendSubmitEventParams::RunMode }

#workflow_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 13

required :workflow_id, String