deeprails 0.23.0 → 0.24.0

data/rbi/deeprails/models/monitor_update_params.rbi

@@ -11,6 +11,9 @@ module Deeprails
           T.any(Deeprails::MonitorUpdateParams, Deeprails::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
       # New description of the monitor.
       sig { returns(T.nilable(String)) }
       attr_reader :description
@@ -73,6 +76,7 @@ module Deeprails
 
       sig do
         params(
+          monitor_id: String,
           description: String,
           file_search: T::Array[String],
           guardrail_metrics:
@@ -84,6 +88,7 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        monitor_id:,
         # New description of the monitor.
         description: nil,
         # An array of file IDs to search in the monitor's evaluations. Files must be
@@ -106,6 +111,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            monitor_id: String,
             description: String,
             file_search: T::Array[String],
             guardrail_metrics:

data/rbi/deeprails/models/workflow_event_detail_response.rbi

@@ -63,7 +63,11 @@ module Deeprails
       end
       attr_accessor :improvement_tool_status
 
-      sig { returns(T::Array[T.anything]) }
+      sig do
+        returns(
+          T::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement]
+        )
+      end
       attr_accessor :key_improvements
 
       # Status of the event.
@@ -181,7 +185,10 @@ module Deeprails
             T.nilable(
               Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::OrSymbol
             ),
-          key_improvements: T::Array[T.anything],
+          key_improvements:
+            T::Array[
+              Deeprails::WorkflowEventDetailResponse::KeyImprovement::OrHash
+            ],
           status: Deeprails::WorkflowEventDetailResponse::Status::OrSymbol,
           threshold_type:
             Deeprails::WorkflowEventDetailResponse::ThresholdType::OrSymbol,
@@ -266,7 +273,8 @@ module Deeprails
               T.nilable(
                 Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::TaggedSymbol
               ),
-            key_improvements: T::Array[T.anything],
+            key_improvements:
+              T::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement],
             status:
               Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol,
             threshold_type:
@@ -597,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

data/rbi/deeprails/resources/defend.rbi

@@ -106,8 +106,8 @@ module Deeprails
       )
       end
 
-      # Use this endpoint to create a new event for a guardrail workflow with real-time
-      # streaming feedback via Server-Sent Events (SSE).
+      # Use this endpoint to submit a model input and output pair to a workflow for
+      # evaluation with streaming responses.
       sig do
         params(
           workflow_id: String,
@@ -130,11 +130,13 @@ module Deeprails
         model_output:,
         # Body param: The model that generated the output (e.g., "gpt-4", "claude-3").
         model_used:,
-        # Body param: The evaluation run mode. Streaming only supports fast, precision,
-        # and precision_codex.
+        # Body param: 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:,
-        # Query param: Enable SSE streaming for real-time token feedback. Only supported
-        # for single-model run modes (fast, precision, precision_codex).
+        # Query param: Enable SSE streaming for real-time token feedback. Supported on all
+        # run modes except precision_max and precision_max_codex.
         stream: nil,
         # Body param: Optional tag to identify this event.
         nametag: nil,
@@ -168,8 +170,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,

data/rbi/deeprails/resources/monitor.rbi

@@ -141,8 +141,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: {}
       )

data/sig/deeprails/internal/util.rbs

@@ -106,6 +106,16 @@ module Deeprails
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/deeprails/models/defend_retrieve_event_params.rbs

@@ -1,7 +1,8 @@
 module Deeprails
   module Models
     type defend_retrieve_event_params =
-      { workflow_id: String } & Deeprails::Internal::Type::request_parameters
+      { workflow_id: String, event_id: String }
+      & Deeprails::Internal::Type::request_parameters
 
     class DefendRetrieveEventParams < Deeprails::Internal::Type::BaseModel
       extend Deeprails::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,17 @@ module Deeprails
 
       attr_accessor workflow_id: String
 
+      attr_accessor event_id: String
+
       def initialize: (
         workflow_id: String,
+        event_id: String,
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
         workflow_id: String,
+        event_id: String,
         request_options: Deeprails::RequestOptions
       }
     end

data/sig/deeprails/models/defend_retrieve_workflow_params.rbs

@@ -1,22 +1,27 @@
 module Deeprails
   module Models
     type defend_retrieve_workflow_params =
-      { limit: Integer } & Deeprails::Internal::Type::request_parameters
+      { workflow_id: String, limit: Integer }
+      & Deeprails::Internal::Type::request_parameters
 
     class DefendRetrieveWorkflowParams < Deeprails::Internal::Type::BaseModel
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor workflow_id: String
+
       attr_reader limit: Integer?
 
       def limit=: (Integer) -> Integer
 
       def initialize: (
+        workflow_id: String,
         ?limit: Integer,
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
+        workflow_id: String,
         limit: Integer,
         request_options: Deeprails::RequestOptions
       }

data/sig/deeprails/models/defend_submit_and_stream_event_params.rbs

@@ -2,6 +2,7 @@ module Deeprails
   module Models
     type defend_submit_and_stream_event_params =
       {
+        workflow_id: String,
         model_input: ::Hash[Symbol, top],
         model_output: String,
         model_used: String,
@@ -15,6 +16,8 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor workflow_id: String
+
       attr_accessor model_input: ::Hash[Symbol, top]
 
       attr_accessor model_output: String
@@ -32,6 +35,7 @@ module Deeprails
       def nametag=: (String) -> String
 
       def initialize: (
+        workflow_id: String,
         model_input: ::Hash[Symbol, top],
         model_output: String,
         model_used: String,
@@ -42,6 +46,7 @@ module Deeprails
       ) -> void
 
       def to_hash: -> {
+        workflow_id: String,
         model_input: ::Hash[Symbol, top],
         model_output: String,
         model_used: String,
@@ -51,21 +56,15 @@ module Deeprails
         request_options: Deeprails::RequestOptions
       }
 
-      type run_mode =
-        :fast
-        | :precision
-        | :precision_codex
-        | :precision_max
-        | :precision_max_codex
+      type run_mode = :super_fast | :fast | :precision | :precision_codex
 
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
+        SUPER_FAST: :super_fast
         FAST: :fast
         PRECISION: :precision
         PRECISION_CODEX: :precision_codex
-        PRECISION_MAX: :precision_max
-        PRECISION_MAX_CODEX: :precision_max_codex
 
         def self?.values: -> ::Array[Deeprails::Models::DefendSubmitAndStreamEventParams::run_mode]
       end

data/sig/deeprails/models/defend_submit_event_params.rbs

@@ -2,6 +2,7 @@ module Deeprails
   module Models
     type defend_submit_event_params =
       {
+        workflow_id: String,
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
@@ -14,6 +15,8 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor workflow_id: String
+
       attr_accessor model_input: Deeprails::DefendSubmitEventParams::ModelInput
 
       attr_accessor model_output: String
@@ -27,6 +30,7 @@ module Deeprails
       def nametag=: (String) -> String
 
       def initialize: (
+        workflow_id: String,
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
@@ -36,6 +40,7 @@ module Deeprails
       ) -> void
 
       def to_hash: -> {
+        workflow_id: String,
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
@@ -101,16 +106,22 @@ module Deeprails
       end
 
       type run_mode =
-        :precision_plus_codex | :precision_plus | :precision | :smart | :economy
+        :super_fast
+        | :fast
+        | :precision
+        | :precision_codex
+        | :precision_max
+        | :precision_max_codex
 
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
-        PRECISION_PLUS_CODEX: :precision_plus_codex
-        PRECISION_PLUS: :precision_plus
+        SUPER_FAST: :super_fast
+        FAST: :fast
         PRECISION: :precision
-        SMART: :smart
-        ECONOMY: :economy
+        PRECISION_CODEX: :precision_codex
+        PRECISION_MAX: :precision_max
+        PRECISION_MAX_CODEX: :precision_max_codex
 
         def self?.values: -> ::Array[Deeprails::Models::DefendSubmitEventParams::run_mode]
       end

data/sig/deeprails/models/defend_update_workflow_params.rbs

@@ -2,6 +2,7 @@ module Deeprails
   module Models
     type defend_update_workflow_params =
       {
+        workflow_id: String,
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendUpdateWorkflowParams::automatic_hallucination_tolerance_level],
         context_awareness: bool,
         custom_hallucination_threshold_values: ::Hash[Symbol, Float],
@@ -19,6 +20,8 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor workflow_id: String
+
       attr_reader automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendUpdateWorkflowParams::automatic_hallucination_tolerance_level]?
 
       def automatic_hallucination_tolerance_levels=: (
@@ -68,6 +71,7 @@ module Deeprails
       def web_search=: (bool) -> bool
 
       def initialize: (
+        workflow_id: String,
         ?automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendUpdateWorkflowParams::automatic_hallucination_tolerance_level],
         ?context_awareness: bool,
         ?custom_hallucination_threshold_values: ::Hash[Symbol, Float],
@@ -82,6 +86,7 @@ module Deeprails
       ) -> void
 
       def to_hash: -> {
+        workflow_id: String,
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendUpdateWorkflowParams::automatic_hallucination_tolerance_level],
         context_awareness: bool,
         custom_hallucination_threshold_values: ::Hash[Symbol, Float],

data/sig/deeprails/models/monitor_detail_response.rbs

@@ -228,15 +228,23 @@ module Deeprails
           end
         end
 
-        type run_mode = :precision_plus | :precision | :smart | :economy
+        type run_mode =
+          :super_fast
+          | :fast
+          | :precision
+          | :precision_codex
+          | :precision_max
+          | :precision_max_codex
 
         module RunMode
           extend Deeprails::Internal::Type::Enum
 
-          PRECISION_PLUS: :precision_plus
+          SUPER_FAST: :super_fast
+          FAST: :fast
           PRECISION: :precision
-          SMART: :smart
-          ECONOMY: :economy
+          PRECISION_CODEX: :precision_codex
+          PRECISION_MAX: :precision_max
+          PRECISION_MAX_CODEX: :precision_max_codex
 
           def self?.values: -> ::Array[Deeprails::Models::MonitorDetailResponse::Evaluation::run_mode]
         end

data/sig/deeprails/models/monitor_event_detail_response.rbs

@@ -150,15 +150,23 @@ module Deeprails
         }
       end
 
-      type run_mode = :precision_plus | :precision | :smart | :economy
+      type run_mode =
+        :super_fast
+        | :fast
+        | :precision
+        | :precision_codex
+        | :precision_max
+        | :precision_max_codex
 
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
-        PRECISION_PLUS: :precision_plus
+        SUPER_FAST: :super_fast
+        FAST: :fast
         PRECISION: :precision
-        SMART: :smart
-        ECONOMY: :economy
+        PRECISION_CODEX: :precision_codex
+        PRECISION_MAX: :precision_max
+        PRECISION_MAX_CODEX: :precision_max_codex
 
         def self?.values: -> ::Array[Deeprails::Models::MonitorEventDetailResponse::run_mode]
       end

data/sig/deeprails/models/monitor_retrieve_event_params.rbs

@@ -1,7 +1,8 @@
 module Deeprails
   module Models
     type monitor_retrieve_event_params =
-      { monitor_id: String } & Deeprails::Internal::Type::request_parameters
+      { monitor_id: String, event_id: String }
+      & Deeprails::Internal::Type::request_parameters
 
     class MonitorRetrieveEventParams < Deeprails::Internal::Type::BaseModel
       extend Deeprails::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,17 @@ module Deeprails
 
       attr_accessor monitor_id: String
 
+      attr_accessor event_id: String
+
       def initialize: (
         monitor_id: String,
+        event_id: String,
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
         monitor_id: String,
+        event_id: String,
         request_options: Deeprails::RequestOptions
       }
     end

data/sig/deeprails/models/monitor_retrieve_params.rbs

@@ -1,22 +1,27 @@
 module Deeprails
   module Models
     type monitor_retrieve_params =
-      { limit: Integer } & Deeprails::Internal::Type::request_parameters
+      { monitor_id: String, limit: Integer }
+      & Deeprails::Internal::Type::request_parameters
 
     class MonitorRetrieveParams < Deeprails::Internal::Type::BaseModel
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor monitor_id: String
+
       attr_reader limit: Integer?
 
       def limit=: (Integer) -> Integer
 
       def initialize: (
+        monitor_id: String,
         ?limit: Integer,
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
+        monitor_id: String,
         limit: Integer,
         request_options: Deeprails::RequestOptions
       }

data/sig/deeprails/models/monitor_submit_event_params.rbs

@@ -2,6 +2,7 @@ module Deeprails
   module Models
     type monitor_submit_event_params =
       {
+        monitor_id: String,
         model_input: Deeprails::MonitorSubmitEventParams::ModelInput,
         model_output: String,
         nametag: String,
@@ -13,6 +14,8 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor monitor_id: String
+
       attr_accessor model_input: Deeprails::MonitorSubmitEventParams::ModelInput
 
       attr_accessor model_output: String
@@ -28,6 +31,7 @@ module Deeprails
       ) -> Deeprails::Models::MonitorSubmitEventParams::run_mode
 
       def initialize: (
+        monitor_id: String,
         model_input: Deeprails::MonitorSubmitEventParams::ModelInput,
         model_output: String,
         ?nametag: String,
@@ -36,6 +40,7 @@ module Deeprails
       ) -> void
 
       def to_hash: -> {
+        monitor_id: String,
         model_input: Deeprails::MonitorSubmitEventParams::ModelInput,
         model_output: String,
         nametag: String,
@@ -100,16 +105,22 @@ module Deeprails
       end
 
       type run_mode =
-        :precision_plus_codex | :precision_plus | :precision | :smart | :economy
+        :super_fast
+        | :fast
+        | :precision
+        | :precision_codex
+        | :precision_max
+        | :precision_max_codex
 
       module RunMode
         extend Deeprails::Internal::Type::Enum
 
-        PRECISION_PLUS_CODEX: :precision_plus_codex
-        PRECISION_PLUS: :precision_plus
+        SUPER_FAST: :super_fast
+        FAST: :fast
         PRECISION: :precision
-        SMART: :smart
-        ECONOMY: :economy
+        PRECISION_CODEX: :precision_codex
+        PRECISION_MAX: :precision_max
+        PRECISION_MAX_CODEX: :precision_max_codex
 
         def self?.values: -> ::Array[Deeprails::Models::MonitorSubmitEventParams::run_mode]
       end

data/sig/deeprails/models/monitor_update_params.rbs

@@ -2,6 +2,7 @@ module Deeprails
   module Models
     type monitor_update_params =
       {
+        monitor_id: String,
         description: String,
         file_search: ::Array[String],
         guardrail_metrics: ::Array[Deeprails::Models::MonitorUpdateParams::guardrail_metric],
@@ -15,6 +16,8 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor monitor_id: String
+
       attr_reader description: String?
 
       def description=: (String) -> String
@@ -44,6 +47,7 @@ module Deeprails
       def web_search=: (bool) -> bool
 
       def initialize: (
+        monitor_id: String,
         ?description: String,
         ?file_search: ::Array[String],
         ?guardrail_metrics: ::Array[Deeprails::Models::MonitorUpdateParams::guardrail_metric],
@@ -54,6 +58,7 @@ module Deeprails
       ) -> void
 
       def to_hash: -> {
+        monitor_id: String,
         description: String,
         file_search: ::Array[String],
         guardrail_metrics: ::Array[Deeprails::Models::MonitorUpdateParams::guardrail_metric],

data/sig/deeprails/models/workflow_event_detail_response.rbs

@@ -10,7 +10,7 @@ module Deeprails
         improved_model_output: String,
         improvement_action: Deeprails::Models::WorkflowEventDetailResponse::improvement_action,
         improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?,
-        key_improvements: ::Array[top],
+        key_improvements: ::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement],
         status: Deeprails::Models::WorkflowEventDetailResponse::status,
         threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type,
         workflow_id: String,
@@ -38,7 +38,7 @@ module Deeprails
 
       attr_accessor improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?
 
-      attr_accessor key_improvements: ::Array[top]
+      attr_accessor key_improvements: ::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement]
 
       attr_accessor status: Deeprails::Models::WorkflowEventDetailResponse::status
 
@@ -83,7 +83,7 @@ module Deeprails
         improved_model_output: String,
         improvement_action: Deeprails::Models::WorkflowEventDetailResponse::improvement_action,
         improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?,
-        key_improvements: ::Array[top],
+        key_improvements: ::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement],
         status: Deeprails::Models::WorkflowEventDetailResponse::status,
         threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type,
         workflow_id: String,
@@ -103,7 +103,7 @@ module Deeprails
         improved_model_output: String,
         improvement_action: Deeprails::Models::WorkflowEventDetailResponse::improvement_action,
         improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?,
-        key_improvements: ::Array[top],
+        key_improvements: ::Array[Deeprails::WorkflowEventDetailResponse::KeyImprovement],
         status: Deeprails::Models::WorkflowEventDetailResponse::status,
         threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type,
         workflow_id: String,
@@ -279,6 +279,18 @@ module Deeprails
         def self?.values: -> ::Array[Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status]
       end
 
+      type key_improvement = { key_improvement: ::Array[String] }
+
+      class KeyImprovement < Deeprails::Internal::Type::BaseModel
+        attr_reader key_improvement: ::Array[String]?
+
+        def key_improvement=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (?key_improvement: ::Array[String]) -> void
+
+        def to_hash: -> { key_improvement: ::Array[String] }
+      end
+
       type status = :"In Progress" | :Completed
 
       module Status

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deeprails
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Deep Rails