Class: Deeprails::Models::DefendResponse::Event::Evaluation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/deeprails/models/defend_response.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(evaluations: nil, event_id: nil, improved_model_output: nil, improvement_tool_status: nil) ⇒ Object

Parameters:

  • evaluations (Array<Deeprails::Models::DefendResponse::Event::Evaluation>) (defaults to: nil) —

    An array of evaluations for this event.

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

    A unique workflow event ID.

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

    Improved model output after improvement tool was applied.

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

    Status of the improvement tool used to improve the event.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/deeprails/models/defend_response.rb', line 186

class Evaluation < Deeprails::Internal::Type::BaseModel
  # @!attribute attempt
  #   The attempt number or identifier for this evaluation.
  #
  #   @return [String, nil]
  optional :attempt, String

  # @!attribute created_at
  #   The time the evaluation was created in UTC.
  #
  #   @return [Time, nil]
  optional :created_at, Time

  # @!attribute error_message
  #   Error message if the evaluation failed.
  #
  #   @return [String, nil]
  optional :error_message, String

  # @!attribute evaluation_result
  #   The result of the evaluation.
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]

  # @!attribute evaluation_status
  #   Status of the evaluation.
  #
  #   @return [String, nil]
  optional :evaluation_status, String

  # @!attribute evaluation_total_cost
  #   Total cost of the evaluation.
  #
  #   @return [Float, nil]
  optional :evaluation_total_cost, Float

  # @!attribute guardrail_metrics
  #   An array of guardrail metrics evaluated.
  #
  #   @return [Array<String>, nil]
  optional :guardrail_metrics, Deeprails::Internal::Type::ArrayOf[String]

  # @!attribute model_input
  #   The model input used for the evaluation.
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :model_input, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]

  # @!attribute model_output
  #   The model output that was evaluated.
  #
  #   @return [String, nil]
  optional :model_output, String

  # @!attribute modified_at
  #   The time the evaluation was last modified in UTC.
  #
  #   @return [Time, nil]
  optional :modified_at, Time

  # @!attribute nametag
  #   An optional tag for the evaluation.
  #
  #   @return [String, nil]
  optional :nametag, String

  # @!attribute progress
  #   Evaluation progress (0-100).
  #
  #   @return [Integer, nil]
  optional :progress, Integer

  # @!attribute run_mode
  #   Run mode used for the evaluation.
  #
  #   @return [String, nil]
  optional :run_mode, String

  # @!method initialize(attempt: nil, created_at: nil, error_message: nil, evaluation_result: nil, evaluation_status: nil, evaluation_total_cost: nil, guardrail_metrics: nil, model_input: nil, model_output: nil, modified_at: nil, nametag: nil, progress: nil, run_mode: nil)
  #   @param attempt [String] The attempt number or identifier for this evaluation.
  #
  #   @param created_at [Time] The time the evaluation was created in UTC.
  #
  #   @param error_message [String] Error message if the evaluation failed.
  #
  #   @param evaluation_result [Hash{Symbol=>Object}] The result of the evaluation.
  #
  #   @param evaluation_status [String] Status of the evaluation.
  #
  #   @param evaluation_total_cost [Float] Total cost of the evaluation.
  #
  #   @param guardrail_metrics [Array<String>] An array of guardrail metrics evaluated.
  #
  #   @param model_input [Hash{Symbol=>Object}] The model input used for the evaluation.
  #
  #   @param model_output [String] The model output that was evaluated.
  #
  #   @param modified_at [Time] The time the evaluation was last modified in UTC.
  #
  #   @param nametag [String] An optional tag for the evaluation.
  #
  #   @param progress [Integer] Evaluation progress (0-100).
  #
  #   @param run_mode [String] Run mode used for the evaluation.
end

Instance Attribute Details

#attempt ⇒ String?

The attempt number or identifier for this evaluation.

Returns:

  • (String, nil) 


191
 
# File 'lib/deeprails/models/defend_response.rb', line 191

optional :attempt, String

#created_at ⇒ Time?

The time the evaluation was created in UTC.

Returns:

  • (Time, nil) 


197
 
# File 'lib/deeprails/models/defend_response.rb', line 197

optional :created_at, Time

#error_message ⇒ String?

Error message if the evaluation failed.

Returns:

  • (String, nil) 


203
 
# File 'lib/deeprails/models/defend_response.rb', line 203

optional :error_message, String

#evaluation_result ⇒ Hash{Symbol=>Object}?

The result of the evaluation.

Returns:

  • (Hash{Symbol=>Object}, nil) 


209
 
# File 'lib/deeprails/models/defend_response.rb', line 209

optional :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]

#evaluation_status ⇒ String?

Status of the evaluation.

Returns:

  • (String, nil) 


215
 
# File 'lib/deeprails/models/defend_response.rb', line 215

optional :evaluation_status, String

#evaluation_total_cost ⇒ Float?

Total cost of the evaluation.

Returns:

  • (Float, nil) 


221
 
# File 'lib/deeprails/models/defend_response.rb', line 221

optional :evaluation_total_cost, Float

#guardrail_metrics ⇒ Array<String>?

An array of guardrail metrics evaluated.

Returns:

  • (Array<String>, nil) 


227
 
# File 'lib/deeprails/models/defend_response.rb', line 227

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

#model_input ⇒ Hash{Symbol=>Object}?

The model input used for the evaluation.

Returns:

  • (Hash{Symbol=>Object}, nil) 


233
 
# File 'lib/deeprails/models/defend_response.rb', line 233

optional :model_input, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]

#model_output ⇒ String?

The model output that was evaluated.

Returns:

  • (String, nil) 


239
 
# File 'lib/deeprails/models/defend_response.rb', line 239

optional :model_output, String

#modified_at ⇒ Time?

The time the evaluation was last modified in UTC.

Returns:

  • (Time, nil) 


245
 
# File 'lib/deeprails/models/defend_response.rb', line 245

optional :modified_at, Time

#nametag ⇒ String?

An optional tag for the evaluation.

Returns:

  • (String, nil) 


251
 
# File 'lib/deeprails/models/defend_response.rb', line 251

optional :nametag, String

#progress ⇒ Integer?

Evaluation progress (0-100).

Returns:

  • (Integer, nil) 


257
 
# File 'lib/deeprails/models/defend_response.rb', line 257

optional :progress, Integer

#run_mode ⇒ String?

Run mode used for the evaluation.

Returns:

  • (String, nil) 


263
 
# File 'lib/deeprails/models/defend_response.rb', line 263

optional :run_mode, String