Class: Deeprails::Models::DefendSubmitEventParams::ModelInput

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/deeprails/models/defend_submit_event_params.rb

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, 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(model_input:, model_output:, model_used:, run_mode:, nametag: nil, request_options: {}) ⇒ Object

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

Parameters:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/deeprails/models/defend_submit_event_params.rb', line 61

class ModelInput < Deeprails::Internal::Type::BaseModel
  # @!attribute ground_truth
  #   The ground truth for evaluating the Ground Truth Adherence guardrail.
  #
  #   @return [String, nil]
  optional :ground_truth, String

  # @!attribute system_prompt
  #   The system prompt used to generate the output.
  #
  #   @return [String, nil]
  optional :system_prompt, String

  # @!attribute user_prompt
  #   The user prompt used to generate the output.
  #
  #   @return [String, nil]
  optional :user_prompt, String

  # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
  #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
  #   contain at least a `user_prompt` field or a `system_prompt` field. For the
  #   ground_truth_adherence guardrail metric, `ground_truth` should be provided.
  #
  #   @param ground_truth [String] The ground truth for evaluating the Ground Truth Adherence guardrail.
  #
  #   @param system_prompt [String] The system prompt used to generate the output.
  #
  #   @param user_prompt [String] The user prompt used to generate the output.
end

Instance Attribute Details

#ground_truth ⇒ String?

The ground truth for evaluating the Ground Truth Adherence guardrail.

Returns:

  • (String, nil) 


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

optional :ground_truth, String

#system_prompt ⇒ String?

The system prompt used to generate the output.

Returns:

  • (String, nil) 


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

optional :system_prompt, String

#user_prompt ⇒ String?

The user prompt used to generate the output.

Returns:

  • (String, nil) 


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

optional :user_prompt, String