deeprails 0.23.0 → 0.24.0

data/rbi/deeprails/internal/util.rbi

@@ -296,11 +296,31 @@ module Deeprails
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Deeprails::Internal::AnyHash).returns(
+            Deeprails::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Deeprails::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/deeprails/models/defend_retrieve_event_params.rbi

@@ -17,18 +17,26 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :workflow_id
 
+      sig { returns(String) }
+      attr_accessor :event_id
+
       sig do
         params(
           workflow_id: String,
+          event_id: String,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(workflow_id:, request_options: {})
+      def self.new(workflow_id:, event_id:, request_options: {})
       end
 
       sig do
         override.returns(
-          { workflow_id: String, request_options: Deeprails::RequestOptions }
+          {
+            workflow_id: String,
+            event_id: String,
+            request_options: Deeprails::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/deeprails/models/defend_retrieve_workflow_params.rbi

@@ -14,6 +14,9 @@ module Deeprails
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :workflow_id
+
       # Limit the number of returned events associated with this workflow. Defaults
       # to 10.
       sig { returns(T.nilable(Integer)) }
@@ -24,11 +27,13 @@ module Deeprails
 
       sig do
         params(
+          workflow_id: String,
           limit: Integer,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        workflow_id:,
         # Limit the number of returned events associated with this workflow. Defaults
         # to 10.
         limit: nil,
@@ -38,7 +43,11 @@ module Deeprails
 
       sig do
         override.returns(
-          { limit: Integer, request_options: Deeprails::RequestOptions }
+          {
+            workflow_id: String,
+            limit: Integer,
+            request_options: Deeprails::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/deeprails/models/defend_submit_and_stream_event_params.rbi

@@ -14,6 +14,9 @@ module Deeprails
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :workflow_id
+
       # The input provided to the model (e.g., prompt, messages).
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :model_input
@@ -26,15 +29,17 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :model_used
 
-      # The evaluation run mode. Streaming only supports fast, precision, and
-      # precision_codex.
+      # The evaluation run mode. Streaming is supported on all run modes except
+      # precision_max and precision_max_codex. Note: super_fast does not support Web
+      # Search or File Search — if your workflow has these enabled, use a different run
+      # mode or disable the capability on the workflow.
       sig do
         returns(Deeprails::DefendSubmitAndStreamEventParams::RunMode::OrSymbol)
       end
       attr_accessor :run_mode
 
-      # Enable SSE streaming for real-time token feedback. Only supported for
-      # single-model run modes (fast, precision, precision_codex).
+      # Enable SSE streaming for real-time token feedback. Supported on all run modes
+      # except precision_max and precision_max_codex.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :stream
 
@@ -50,6 +55,7 @@ module Deeprails
 
       sig do
         params(
+          workflow_id: String,
           model_input: T::Hash[Symbol, T.anything],
           model_output: String,
           model_used: String,
@@ -61,17 +67,20 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        workflow_id:,
         # The input provided to the model (e.g., prompt, messages).
         model_input:,
         # The output generated by the model to be evaluated.
         model_output:,
         # The model that generated the output (e.g., "gpt-4", "claude-3").
         model_used:,
-        # The evaluation run mode. Streaming only supports fast, precision, and
-        # precision_codex.
+        # The evaluation run mode. Streaming is supported on all run modes except
+        # precision_max and precision_max_codex. Note: super_fast does not support Web
+        # Search or File Search — if your workflow has these enabled, use a different run
+        # mode or disable the capability on the workflow.
         run_mode:,
-        # Enable SSE streaming for real-time token feedback. Only supported for
-        # single-model run modes (fast, precision, precision_codex).
+        # Enable SSE streaming for real-time token feedback. Supported on all run modes
+        # except precision_max and precision_max_codex.
         stream: nil,
         # Optional tag to identify this event.
         nametag: nil,
@@ -82,6 +91,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            workflow_id: String,
             model_input: T::Hash[Symbol, T.anything],
             model_output: String,
             model_used: String,
@@ -96,8 +106,10 @@ module Deeprails
       def to_hash
       end
 
-      # The evaluation run mode. Streaming only supports fast, precision, and
-      # precision_codex.
+      # The evaluation run mode. Streaming is supported on all run modes except
+      # precision_max and precision_max_codex. Note: super_fast does not support Web
+      # Search or File Search — if your workflow has these enabled, use a different run
+      # mode or disable the capability on the workflow.
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
@@ -107,6 +119,11 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        SUPER_FAST =
+          T.let(
+            :super_fast,
+            Deeprails::DefendSubmitAndStreamEventParams::RunMode::TaggedSymbol
+          )
         FAST =
           T.let(
             :fast,
@@ -122,16 +139,6 @@ module Deeprails
             :precision_codex,
             Deeprails::DefendSubmitAndStreamEventParams::RunMode::TaggedSymbol
           )
-        PRECISION_MAX =
-          T.let(
-            :precision_max,
-            Deeprails::DefendSubmitAndStreamEventParams::RunMode::TaggedSymbol
-          )
-        PRECISION_MAX_CODEX =
-          T.let(
-            :precision_max_codex,
-            Deeprails::DefendSubmitAndStreamEventParams::RunMode::TaggedSymbol
-          )
 
         sig do
           override.returns(

data/rbi/deeprails/models/defend_submit_event_params.rbi

@@ -14,6 +14,9 @@ module Deeprails
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :workflow_id
+
       # 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.
@@ -37,8 +40,11 @@ module Deeprails
 
       # 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 include `precision_plus_codex`, `precision_plus`,
-      # `precision`, `smart`, and `economy`. Defaults to `smart`.
+      # 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.
       sig { returns(Deeprails::DefendSubmitEventParams::RunMode::OrSymbol) }
       attr_accessor :run_mode
 
@@ -51,6 +57,7 @@ module Deeprails
 
       sig do
         params(
+          workflow_id: String,
           model_input: Deeprails::DefendSubmitEventParams::ModelInput::OrHash,
           model_output: String,
           model_used: String,
@@ -60,6 +67,7 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        workflow_id:,
         # 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.
@@ -70,8 +78,11 @@ module Deeprails
         model_used:,
         # 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 include `precision_plus_codex`, `precision_plus`,
-        # `precision`, `smart`, and `economy`. Defaults to `smart`.
+        # 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.
         run_mode:,
         # An optional, user-defined tag for the event.
         nametag: nil,
@@ -82,6 +93,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            workflow_id: String,
             model_input: Deeprails::DefendSubmitEventParams::ModelInput,
             model_output: String,
             model_used: String,
@@ -233,8 +245,11 @@ module Deeprails
 
       # 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 include `precision_plus_codex`, `precision_plus`,
-      # `precision`, `smart`, and `economy`. Defaults to `smart`.
+      # 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.
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
@@ -244,14 +259,14 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PRECISION_PLUS_CODEX =
+        SUPER_FAST =
           T.let(
-            :precision_plus_codex,
+            :super_fast,
             Deeprails::DefendSubmitEventParams::RunMode::TaggedSymbol
           )
-        PRECISION_PLUS =
+        FAST =
           T.let(
-            :precision_plus,
+            :fast,
             Deeprails::DefendSubmitEventParams::RunMode::TaggedSymbol
           )
         PRECISION =
@@ -259,14 +274,19 @@ module Deeprails
             :precision,
             Deeprails::DefendSubmitEventParams::RunMode::TaggedSymbol
           )
-        SMART =
+        PRECISION_CODEX =
+          T.let(
+            :precision_codex,
+            Deeprails::DefendSubmitEventParams::RunMode::TaggedSymbol
+          )
+        PRECISION_MAX =
           T.let(
-            :smart,
+            :precision_max,
             Deeprails::DefendSubmitEventParams::RunMode::TaggedSymbol
           )
-        ECONOMY =
+        PRECISION_MAX_CODEX =
           T.let(
-            :economy,
+            :precision_max_codex,
             Deeprails::DefendSubmitEventParams::RunMode::TaggedSymbol
           )
 

data/rbi/deeprails/models/defend_update_workflow_params.rbi

@@ -14,6 +14,9 @@ module Deeprails
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :workflow_id
+
       # New mapping of guardrail metrics to hallucination tolerance levels (either
       # `low`, `medium`, or `high`) to be used when `threshold_type` is set to
       # `automatic`. Possible metrics are `completeness`, `instruction_adherence`,
@@ -145,6 +148,7 @@ module Deeprails
 
       sig do
         params(
+          workflow_id: String,
           automatic_hallucination_tolerance_levels:
             T::Hash[
               Symbol,
@@ -165,6 +169,7 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        workflow_id:,
         # New mapping of guardrail metrics to hallucination tolerance levels (either
         # `low`, `medium`, or `high`) to be used when `threshold_type` is set to
         # `automatic`. Possible metrics are `completeness`, `instruction_adherence`,
@@ -208,6 +213,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            workflow_id: String,
             automatic_hallucination_tolerance_levels:
               T::Hash[
                 Symbol,

data/rbi/deeprails/models/monitor_detail_response.rbi

@@ -194,6 +194,7 @@ module Deeprails
 
         # Run mode for the evaluation. The run mode allows the user to optimize for speed,
         # accuracy, and cost by determining which models are used to evaluate the event.
+        # Note: `super_fast` do not support Web Search or File Search capabilities.
         sig do
           returns(
             Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
@@ -301,6 +302,7 @@ module Deeprails
           model_output:,
           # Run mode for the evaluation. The run mode allows the user to optimize for speed,
           # accuracy, and cost by determining which models are used to evaluate the event.
+          # Note: `super_fast` do not support Web Search or File Search capabilities.
           run_mode:,
           # The time the evaluation was created in UTC.
           created_at: nil,
@@ -540,6 +542,7 @@ module Deeprails
 
         # Run mode for the evaluation. The run mode allows the user to optimize for speed,
         # accuracy, and cost by determining which models are used to evaluate the event.
+        # Note: `super_fast` do not support Web Search or File Search capabilities.
         module RunMode
           extend Deeprails::Internal::Type::Enum
 
@@ -552,9 +555,14 @@ module Deeprails
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          PRECISION_PLUS =
+          SUPER_FAST =
             T.let(
-              :precision_plus,
+              :super_fast,
+              Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
+            )
+          FAST =
+            T.let(
+              :fast,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
           PRECISION =
@@ -562,14 +570,19 @@ module Deeprails
               :precision,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
-          SMART =
+          PRECISION_CODEX =
+            T.let(
+              :precision_codex,
+              Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
+            )
+          PRECISION_MAX =
             T.let(
-              :smart,
+              :precision_max,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
-          ECONOMY =
+          PRECISION_MAX_CODEX =
             T.let(
-              :economy,
+              :precision_max_codex,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
 

data/rbi/deeprails/models/monitor_event_detail_response.rbi

@@ -305,9 +305,14 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PRECISION_PLUS =
+        SUPER_FAST =
           T.let(
-            :precision_plus,
+            :super_fast,
+            Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
+          )
+        FAST =
+          T.let(
+            :fast,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
         PRECISION =
@@ -315,14 +320,19 @@ module Deeprails
             :precision,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
-        SMART =
+        PRECISION_CODEX =
+          T.let(
+            :precision_codex,
+            Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
+          )
+        PRECISION_MAX =
           T.let(
-            :smart,
+            :precision_max,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
-        ECONOMY =
+        PRECISION_MAX_CODEX =
           T.let(
-            :economy,
+            :precision_max_codex,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
 

data/rbi/deeprails/models/monitor_retrieve_event_params.rbi

@@ -17,18 +17,26 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :monitor_id
 
+      sig { returns(String) }
+      attr_accessor :event_id
+
       sig do
         params(
           monitor_id: String,
+          event_id: String,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(monitor_id:, request_options: {})
+      def self.new(monitor_id:, event_id:, request_options: {})
       end
 
       sig do
         override.returns(
-          { monitor_id: String, request_options: Deeprails::RequestOptions }
+          {
+            monitor_id: String,
+            event_id: String,
+            request_options: Deeprails::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/deeprails/models/monitor_retrieve_params.rbi

@@ -11,6 +11,9 @@ module Deeprails
           T.any(Deeprails::MonitorRetrieveParams, Deeprails::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
       # Limit the number of returned evaluations associated with this monitor. Defaults
       # to 10.
       sig { returns(T.nilable(Integer)) }
@@ -21,11 +24,13 @@ module Deeprails
 
       sig do
         params(
+          monitor_id: String,
           limit: Integer,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        monitor_id:,
         # Limit the number of returned evaluations associated with this monitor. Defaults
         # to 10.
         limit: nil,
@@ -35,7 +40,11 @@ module Deeprails
 
       sig do
         override.returns(
-          { limit: Integer, request_options: Deeprails::RequestOptions }
+          {
+            monitor_id: String,
+            limit: Integer,
+            request_options: Deeprails::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/deeprails/models/monitor_submit_event_params.rbi

@@ -14,6 +14,9 @@ module Deeprails
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
       # A dictionary of inputs sent to the LLM to generate output. The dictionary must
       # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
       # `ground_truth` should be provided.
@@ -40,8 +43,11 @@ module Deeprails
 
       # Run mode for the monitor 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 include `precision_plus_codex`, `precision_plus`,
-      # `precision`, `smart`, and `economy`. Defaults to `smart`.
+      # 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 monitor has these capabilities enabled, use a different run
+      # mode or edit the monitor to disable them.
       sig do
         returns(
           T.nilable(Deeprails::MonitorSubmitEventParams::RunMode::OrSymbol)
@@ -58,6 +64,7 @@ module Deeprails
 
       sig do
         params(
+          monitor_id: String,
           model_input: Deeprails::MonitorSubmitEventParams::ModelInput::OrHash,
           model_output: String,
           nametag: String,
@@ -66,6 +73,7 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        monitor_id:,
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
         # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
         # `ground_truth` should be provided.
@@ -76,8 +84,11 @@ module Deeprails
         nametag: nil,
         # Run mode for the monitor 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 include `precision_plus_codex`, `precision_plus`,
-        # `precision`, `smart`, and `economy`. Defaults to `smart`.
+        # 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 monitor has these capabilities enabled, use a different run
+        # mode or edit the monitor to disable them.
         run_mode: nil,
         request_options: {}
       )
@@ -86,6 +97,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            monitor_id: String,
             model_input: Deeprails::MonitorSubmitEventParams::ModelInput,
             model_output: String,
             nametag: String,
@@ -236,8 +248,11 @@ module Deeprails
 
       # Run mode for the monitor 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 include `precision_plus_codex`, `precision_plus`,
-      # `precision`, `smart`, and `economy`. Defaults to `smart`.
+      # 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 monitor has these capabilities enabled, use a different run
+      # mode or edit the monitor to disable them.
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
@@ -247,14 +262,14 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PRECISION_PLUS_CODEX =
+        SUPER_FAST =
           T.let(
-            :precision_plus_codex,
+            :super_fast,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
-        PRECISION_PLUS =
+        FAST =
           T.let(
-            :precision_plus,
+            :fast,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
         PRECISION =
@@ -262,14 +277,19 @@ module Deeprails
             :precision,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
-        SMART =
+        PRECISION_CODEX =
+          T.let(
+            :precision_codex,
+            Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
+          )
+        PRECISION_MAX =
           T.let(
-            :smart,
+            :precision_max,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
-        ECONOMY =
+        PRECISION_MAX_CODEX =
           T.let(
-            :economy,
+            :precision_max_codex,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )