deeprails 0.18.0 → 0.24.0

data/rbi/deeprails/models/monitor_update_params.rbi

@@ -11,14 +11,44 @@ module Deeprails
           T.any(Deeprails::MonitorUpdateParams, Deeprails::Internal::AnyHash)
         end
 
-      # Description of the monitor.
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
+      # New description of the monitor.
       sig { returns(T.nilable(String)) }
       attr_reader :description
 
       sig { params(description: String).void }
       attr_writer :description
 
-      # Name of the monitor.
+      # An array of file IDs to search in the monitor's evaluations. Files must be
+      # uploaded via the DeepRails API first.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :file_search
+
+      sig { params(file_search: T::Array[String]).void }
+      attr_writer :file_search
+
+      # An array of the new guardrail metrics that model input and output pairs will be
+      # evaluated on.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Deeprails::MonitorUpdateParams::GuardrailMetric::OrSymbol]
+          )
+        )
+      end
+      attr_reader :guardrail_metrics
+
+      sig do
+        params(
+          guardrail_metrics:
+            T::Array[Deeprails::MonitorUpdateParams::GuardrailMetric::OrSymbol]
+        ).void
+      end
+      attr_writer :guardrail_metrics
+
+      # New name of the monitor.
       sig { returns(T.nilable(String)) }
       attr_reader :name
 
@@ -37,22 +67,43 @@ module Deeprails
       end
       attr_writer :status
 
+      # Whether to enable web search for this monitor's evaluations.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :web_search
+
+      sig { params(web_search: T::Boolean).void }
+      attr_writer :web_search
+
       sig do
         params(
+          monitor_id: String,
           description: String,
+          file_search: T::Array[String],
+          guardrail_metrics:
+            T::Array[Deeprails::MonitorUpdateParams::GuardrailMetric::OrSymbol],
           name: String,
           status: Deeprails::MonitorUpdateParams::Status::OrSymbol,
+          web_search: T::Boolean,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Description of the monitor.
+        monitor_id:,
+        # New description of the monitor.
         description: nil,
-        # Name of the monitor.
+        # An array of file IDs to search in the monitor's evaluations. Files must be
+        # uploaded via the DeepRails API first.
+        file_search: nil,
+        # An array of the new guardrail metrics that model input and output pairs will be
+        # evaluated on.
+        guardrail_metrics: nil,
+        # New name of the monitor.
         name: nil,
         # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
         # longer record and evaluate events.
         status: nil,
+        # Whether to enable web search for this monitor's evaluations.
+        web_search: nil,
         request_options: {}
       )
       end
@@ -60,9 +111,16 @@ module Deeprails
       sig do
         override.returns(
           {
+            monitor_id: String,
             description: String,
+            file_search: T::Array[String],
+            guardrail_metrics:
+              T::Array[
+                Deeprails::MonitorUpdateParams::GuardrailMetric::OrSymbol
+              ],
             name: String,
             status: Deeprails::MonitorUpdateParams::Status::OrSymbol,
+            web_search: T::Boolean,
             request_options: Deeprails::RequestOptions
           }
         )
@@ -70,6 +128,57 @@ module Deeprails
       def to_hash
       end
 
+      module GuardrailMetric
+        extend Deeprails::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Deeprails::MonitorUpdateParams::GuardrailMetric)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CORRECTNESS =
+          T.let(
+            :correctness,
+            Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+          )
+        COMPLETENESS =
+          T.let(
+            :completeness,
+            Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+          )
+        INSTRUCTION_ADHERENCE =
+          T.let(
+            :instruction_adherence,
+            Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+          )
+        CONTEXT_ADHERENCE =
+          T.let(
+            :context_adherence,
+            Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+          )
+        GROUND_TRUTH_ADHERENCE =
+          T.let(
+            :ground_truth_adherence,
+            Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+          )
+        COMPREHENSIVE_SAFETY =
+          T.let(
+            :comprehensive_safety,
+            Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Deeprails::MonitorUpdateParams::GuardrailMetric::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
       # longer record and evaluate events.
       module Status

data/rbi/deeprails/models/workflow_event_detail_response.rbi

@@ -11,6 +11,9 @@ module Deeprails
           )
         end
 
+      sig { returns(T::Array[String]) }
+      attr_accessor :analysis_of_failures
+
       # History of evaluations for the event.
       sig do
         returns(
@@ -45,7 +48,12 @@ module Deeprails
       end
       attr_accessor :improvement_action
 
-      # Status of the improvement tool used to improve the event.
+      # Status of the improvement tool used to improve the event. `improvement_required`
+      # indicates that the evaluation is complete and the improvement action is needed
+      # but is not taking place. `improved` and `improvement_failed` indicate when the
+      # improvement action concludes, successfully and unsuccessfully, respectively.
+      # `no_improvement_required` means that the first evaluation passed all its
+      # metrics!
       sig do
         returns(
           T.nilable(
@@ -55,6 +63,13 @@ module Deeprails
       end
       attr_accessor :improvement_tool_status
 
+      sig do
+        returns(
+          T::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement]
+        )
+      end
+      attr_accessor :key_improvements
+
       # Status of the event.
       sig do
         returns(Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol)
@@ -98,8 +113,8 @@ module Deeprails
       end
       attr_writer :automatic_hallucination_tolerance_levels
 
-      # Extended AI capabilities available to the event, if any. Can be `web_search`
-      # and/or `file_search`.
+      # Extended AI capabilities available to the event, if any. Can be `web_search`,
+      # `file_search`, and/or `context_awareness`.
       sig do
         returns(
           T.nilable(
@@ -145,8 +160,17 @@ module Deeprails
       end
       attr_writer :files
 
+      # The maximum number of improvement attempts to be applied to one event before it
+      # is considered failed.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_improvement_attempts
+
+      sig { params(max_improvement_attempts: Integer).void }
+      attr_writer :max_improvement_attempts
+
       sig do
         params(
+          analysis_of_failures: T::Array[String],
           evaluation_history:
             T::Array[
               Deeprails::WorkflowEventDetailResponse::EvaluationHistory::OrHash
@@ -161,6 +185,10 @@ module Deeprails
             T.nilable(
               Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::OrSymbol
             ),
+          key_improvements:
+            T::Array[
+              Deeprails::WorkflowEventDetailResponse::KeyImprovement::OrHash
+            ],
           status: Deeprails::WorkflowEventDetailResponse::Status::OrSymbol,
           threshold_type:
             Deeprails::WorkflowEventDetailResponse::ThresholdType::OrSymbol,
@@ -175,10 +203,12 @@ module Deeprails
               Deeprails::WorkflowEventDetailResponse::Capability::OrHash
             ],
           custom_hallucination_threshold_values: T::Hash[Symbol, Float],
-          files: T::Array[Deeprails::WorkflowEventDetailResponse::File::OrHash]
+          files: T::Array[Deeprails::WorkflowEventDetailResponse::File::OrHash],
+          max_improvement_attempts: Integer
         ).returns(T.attached_class)
       end
       def self.new(
+        analysis_of_failures:,
         # History of evaluations for the event.
         evaluation_history:,
         # Evaluation result consisting of average scores and rationales for each of the
@@ -193,8 +223,14 @@ module Deeprails
         improved_model_output:,
         # Type of improvement action used to improve the event.
         improvement_action:,
-        # Status of the improvement tool used to improve the event.
+        # Status of the improvement tool used to improve the event. `improvement_required`
+        # indicates that the evaluation is complete and the improvement action is needed
+        # but is not taking place. `improved` and `improvement_failed` indicate when the
+        # improvement action concludes, successfully and unsuccessfully, respectively.
+        # `no_improvement_required` means that the first evaluation passed all its
+        # metrics!
         improvement_tool_status:,
+        key_improvements:,
         # Status of the event.
         status:,
         # Type of thresholds used to evaluate the event.
@@ -204,21 +240,25 @@ module Deeprails
         # Mapping of guardrail metric names to tolerance values. Values are strings
         # (`low`, `medium`, `high`) representing automatic tolerance levels.
         automatic_hallucination_tolerance_levels: nil,
-        # Extended AI capabilities available to the event, if any. Can be `web_search`
-        # and/or `file_search`.
+        # Extended AI capabilities available to the event, if any. Can be `web_search`,
+        # `file_search`, and/or `context_awareness`.
         capabilities: nil,
         # Mapping of guardrail metric names to threshold values. Values are floating point
         # numbers (0.0-1.0) representing custom thresholds.
         custom_hallucination_threshold_values: nil,
         # List of files available to the event, if any. Will only be present if
         # `file_search` is enabled.
-        files: nil
+        files: nil,
+        # The maximum number of improvement attempts to be applied to one event before it
+        # is considered failed.
+        max_improvement_attempts: nil
       )
       end
 
       sig do
         override.returns(
           {
+            analysis_of_failures: T::Array[String],
             evaluation_history:
               T::Array[
                 Deeprails::WorkflowEventDetailResponse::EvaluationHistory
@@ -233,6 +273,8 @@ module Deeprails
               T.nilable(
                 Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::TaggedSymbol
               ),
+            key_improvements:
+              T::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement],
             status:
               Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol,
             threshold_type:
@@ -246,7 +288,8 @@ module Deeprails
             capabilities:
               T::Array[Deeprails::WorkflowEventDetailResponse::Capability],
             custom_hallucination_threshold_values: T::Hash[Symbol, Float],
-            files: T::Array[Deeprails::WorkflowEventDetailResponse::File]
+            files: T::Array[Deeprails::WorkflowEventDetailResponse::File],
+            max_improvement_attempts: Integer
           }
         )
       end
@@ -262,6 +305,12 @@ module Deeprails
             )
           end
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :analysis_of_failures
+
+        sig { params(analysis_of_failures: String).void }
+        attr_writer :analysis_of_failures
+
         sig { returns(T.nilable(String)) }
         attr_reader :attempt
 
@@ -304,6 +353,29 @@ module Deeprails
         sig { params(guardrail_metrics: T::Array[String]).void }
         attr_writer :guardrail_metrics
 
+        sig do
+          returns(
+            T.nilable(
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :improvement_tool_status
+
+        sig do
+          params(
+            improvement_tool_status:
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::OrSymbol
+          ).void
+        end
+        attr_writer :improvement_tool_status
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :key_improvements
+
+        sig { params(key_improvements: T::Array[String]).void }
+        attr_writer :key_improvements
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :model_input
 
@@ -316,12 +388,6 @@ module Deeprails
         sig { params(model_output: String).void }
         attr_writer :model_output
 
-        sig { returns(T.nilable(Time)) }
-        attr_reader :modified_at
-
-        sig { params(modified_at: Time).void }
-        attr_writer :modified_at
-
         sig { returns(T.nilable(String)) }
         attr_reader :nametag
 
@@ -342,6 +408,7 @@ module Deeprails
 
         sig do
           params(
+            analysis_of_failures: String,
             attempt: String,
             created_at: Time,
             error_message: String,
@@ -349,15 +416,18 @@ module Deeprails
             evaluation_status: String,
             evaluation_total_cost: Float,
             guardrail_metrics: T::Array[String],
+            improvement_tool_status:
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::OrSymbol,
+            key_improvements: T::Array[String],
             model_input: T::Hash[Symbol, T.anything],
             model_output: String,
-            modified_at: Time,
             nametag: String,
             progress: Integer,
             run_mode: String
           ).returns(T.attached_class)
         end
         def self.new(
+          analysis_of_failures: nil,
           attempt: nil,
           created_at: nil,
           error_message: nil,
@@ -365,9 +435,10 @@ module Deeprails
           evaluation_status: nil,
           evaluation_total_cost: nil,
           guardrail_metrics: nil,
+          improvement_tool_status: nil,
+          key_improvements: nil,
           model_input: nil,
           model_output: nil,
-          modified_at: nil,
           nametag: nil,
           progress: nil,
           run_mode: nil
@@ -377,6 +448,7 @@ module Deeprails
         sig do
           override.returns(
             {
+              analysis_of_failures: String,
               attempt: String,
               created_at: Time,
               error_message: String,
@@ -384,9 +456,11 @@ module Deeprails
               evaluation_status: String,
               evaluation_total_cost: Float,
               guardrail_metrics: T::Array[String],
+              improvement_tool_status:
+                Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol,
+              key_improvements: T::Array[String],
               model_input: T::Hash[Symbol, T.anything],
               model_output: String,
-              modified_at: Time,
               nametag: String,
               progress: Integer,
               run_mode: String
@@ -395,6 +469,50 @@ module Deeprails
         end
         def to_hash
         end
+
+        module ImprovementToolStatus
+          extend Deeprails::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IMPROVED =
+            T.let(
+              :improved,
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol
+            )
+          IMPROVEMENT_FAILED =
+            T.let(
+              :improvement_failed,
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol
+            )
+          NO_IMPROVEMENT_REQUIRED =
+            T.let(
+              :no_improvement_required,
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol
+            )
+          IMPROVEMENT_REQUIRED =
+            T.let(
+              :improvement_required,
+              Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       # Type of improvement action used to improve the event.
@@ -437,7 +555,12 @@ module Deeprails
         end
       end
 
-      # Status of the improvement tool used to improve the event.
+      # Status of the improvement tool used to improve the event. `improvement_required`
+      # indicates that the evaluation is complete and the improvement action is needed
+      # but is not taking place. `improved` and `improvement_failed` indicate when the
+      # improvement action concludes, successfully and unsuccessfully, respectively.
+      # `no_improvement_required` means that the first evaluation passed all its
+      # metrics!
       module ImprovementToolStatus
         extend Deeprails::Internal::Type::Enum
 
@@ -455,9 +578,14 @@ module Deeprails
             :improved,
             Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::TaggedSymbol
           )
-        FAILED_ON_MAX_RETRIES =
+        IMPROVEMENT_FAILED =
+          T.let(
+            :improvement_failed,
+            Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::TaggedSymbol
+          )
+        NO_IMPROVEMENT_REQUIRED =
           T.let(
-            :"failed on max retries",
+            :no_improvement_required,
             Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::TaggedSymbol
           )
         IMPROVEMENT_REQUIRED =
@@ -477,6 +605,32 @@ module Deeprails
         end
       end
 
+      class KeyImprovement < Deeprails::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Deeprails::WorkflowEventDetailResponse::KeyImprovement,
+              Deeprails::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :key_improvement
+
+        sig { params(key_improvement: T::Array[String]).void }
+        attr_writer :key_improvement
+
+        sig do
+          params(key_improvement: T::Array[String]).returns(T.attached_class)
+        end
+        def self.new(key_improvement: nil)
+        end
+
+        sig { override.returns({ key_improvement: T::Array[String] }) }
+        def to_hash
+        end
+      end
+
       # Status of the event.
       module Status
         extend Deeprails::Internal::Type::Enum
@@ -631,19 +785,45 @@ module Deeprails
         sig { params(file_size: Integer).void }
         attr_writer :file_size
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :presigned_url
+
+        sig { params(presigned_url: String).void }
+        attr_writer :presigned_url
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :presigned_url_expires_at
+
+        sig { params(presigned_url_expires_at: Time).void }
+        attr_writer :presigned_url_expires_at
+
         sig do
           params(
             file_id: String,
             file_name: String,
-            file_size: Integer
+            file_size: Integer,
+            presigned_url: String,
+            presigned_url_expires_at: Time
           ).returns(T.attached_class)
         end
-        def self.new(file_id: nil, file_name: nil, file_size: nil)
+        def self.new(
+          file_id: nil,
+          file_name: nil,
+          file_size: nil,
+          presigned_url: nil,
+          presigned_url_expires_at: nil
+        )
         end
 
         sig do
           override.returns(
-            { file_id: String, file_name: String, file_size: Integer }
+            {
+              file_id: String,
+              file_name: String,
+              file_size: Integer,
+              presigned_url: String,
+              presigned_url_expires_at: Time
+            }
           )
         end
         def to_hash

data/rbi/deeprails/models/workflow_event_response.rbi

@@ -8,6 +8,10 @@ module Deeprails
           T.any(Deeprails::WorkflowEventResponse, Deeprails::Internal::AnyHash)
         end
 
+      # The ID of the billing request for the event.
+      sig { returns(String) }
+      attr_accessor :billing_request_id
+
       # The time the event was created in UTC.
       sig { returns(Time) }
       attr_accessor :created_at
@@ -26,6 +30,7 @@ module Deeprails
 
       sig do
         params(
+          billing_request_id: String,
           created_at: Time,
           event_id: String,
           status: Deeprails::WorkflowEventResponse::Status::OrSymbol,
@@ -33,6 +38,8 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        # The ID of the billing request for the event.
+        billing_request_id:,
         # The time the event was created in UTC.
         created_at:,
         # A unique workflow event ID.
@@ -47,6 +54,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            billing_request_id: String,
             created_at: Time,
             event_id: String,
             status: Deeprails::WorkflowEventResponse::Status::TaggedSymbol,

data/rbi/deeprails/models.rbi

@@ -11,6 +11,9 @@ module Deeprails
 
   DefendRetrieveWorkflowParams = Deeprails::Models::DefendRetrieveWorkflowParams
 
+  DefendSubmitAndStreamEventParams =
+    Deeprails::Models::DefendSubmitAndStreamEventParams
+
   DefendSubmitEventParams = Deeprails::Models::DefendSubmitEventParams
 
   DefendUpdateResponse = Deeprails::Models::DefendUpdateResponse