deeprails 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27fa10a22615062a47a7c91fd063f80d87318da5d6bb5e375174fd9cb4b7e6b7
-  data.tar.gz: 24192097ccfe647482b666ece995279bc428774789bff6a62f678bb5da37356d
+  metadata.gz: 11883d9b5384d524592e17369d91cef2d4eef69b5a3ff4036646115b40fc02b8
+  data.tar.gz: 94c8277d39e00367ba6f95d8f7c3d026c96d616f4c95ca50ffeafc190dfdd408
 SHA512:
-  metadata.gz: 1648800bce667593e627487f6f46b9a70d5958327d002178b9cd84f330e8399d37709774488bec9e84402afc1b9553c7512497eb31237c570e4cf55f1563ec36
-  data.tar.gz: 37dc7effa1649426ac95e881aafc84fed9b7c1dad3490969a8c4e9df6ad575ff54b7b37f21d98df82cdab0c7210cb02e86f54ab6cb261a9e50b6b15af5783cc0
+  metadata.gz: 1ce43b415bddf92bb9a6ba48a622436d8115b9a2e8beda4e036bb1630efc230e8f8b5edd8e96f171e23ca981c517cb375e88974c7103b46c23ef60f2183abab5
+  data.tar.gz: 3bc92a1bc7a37f8bddfd2da84018a14077a10308c85277cb2741a143a4ba316b648a713691bc4fe0e6e7920f35b94cb1816025dbbaf5c624b81f51253d5a937c

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 0.24.0 (2026-03-25)
+
+Full Changelog: [v0.23.0...v0.24.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.23.0...v0.24.0)
+
+### Features
+
+* **api:** manual updates ([5ef9233](https://github.com/deeprails/deeprails-ruby-sdk/commit/5ef9233307f25347f1fe5cb31d919b775e86018c))
+* **api:** update run mode lists ([4dd6b35](https://github.com/deeprails/deeprails-ruby-sdk/commit/4dd6b35cfd44db08d215bcffcd82e0df013fdbc1))
+
+
+### Bug Fixes
+
+* **client:** always add content-length to post body, even when empty ([a13ed48](https://github.com/deeprails/deeprails-ruby-sdk/commit/a13ed487ebe8d61e23a91427b59568098fa9c509))
+* **client:** loosen json header parsing ([5b586e4](https://github.com/deeprails/deeprails-ruby-sdk/commit/5b586e42540c7495a5a7a90b046f97bd80937a6a))
+* properly mock time in ruby ci tests ([3d4a050](https://github.com/deeprails/deeprails-ruby-sdk/commit/3d4a05086397ebee972f3731c32c546a8680c359))
+
+
+### Chores
+
+* **ci:** add build step ([214a42f](https://github.com/deeprails/deeprails-ruby-sdk/commit/214a42f734b006bc8b121c1e7024e48978d0435c))
+* **ci:** skip uploading artifacts on stainless-internal branches ([31cf2d4](https://github.com/deeprails/deeprails-ruby-sdk/commit/31cf2d4fc4f7cf22594abb421e85fc596bfebfe1))
+* **docs:** remove www prefix ([5809c7c](https://github.com/deeprails/deeprails-ruby-sdk/commit/5809c7c3e4f530b4229837034c41fe991627cebe))
+* **internal:** codegen related update ([963603e](https://github.com/deeprails/deeprails-ruby-sdk/commit/963603e86d5835158ef84320a712c4f688369924))
+* **internal:** codegen related update ([729ecae](https://github.com/deeprails/deeprails-ruby-sdk/commit/729ecaebf5923f1c8fb3534af065422d57c93489))
+* **internal:** codegen related update ([5d6fdf8](https://github.com/deeprails/deeprails-ruby-sdk/commit/5d6fdf835fb9189c925b6a4b7e6ab5be0bb5f6c6))
+* **internal:** codegen related update ([3c60669](https://github.com/deeprails/deeprails-ruby-sdk/commit/3c606699d83fa50f2e89502c829bd2a3270848dc))
+* **internal:** remove mock server code ([6da3225](https://github.com/deeprails/deeprails-ruby-sdk/commit/6da3225fe66a6f2e1519b3a5eba404483e0c7092))
+* **internal:** tweak CI branches ([ce92004](https://github.com/deeprails/deeprails-ruby-sdk/commit/ce920042eb923f09c87bfb8d7c0b92e79cc817fd))
+* update mock server docs ([d247ade](https://github.com/deeprails/deeprails-ruby-sdk/commit/d247ade6db1f06e5d56a815cac033b0c5ed7e3c7))
+
 ## 0.23.0 (2026-01-20)
 
 Full Changelog: [v0.22.0...v0.23.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.22.0...v0.23.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "deeprails", "~> 0.23.0"
+gem "deeprails", "~> 0.24.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/deeprails/internal/transport/pooled_net_requester.rb

@@ -75,7 +75,7 @@ module Deeprails
 
             case body
             in nil
-              nil
+              req["content-length"] ||= 0 unless req["transfer-encoding"]
             in String
               req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
               req.body_stream = Deeprails::Internal::Util::ReadIOAdapter.new(body, &blk)

data/lib/deeprails/internal/util.rb

@@ -485,11 +485,42 @@ module Deeprails
       end
 
       # @type [Regexp]
-      JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
+      JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
       # @type [Regexp]
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

data/lib/deeprails/models/defend_retrieve_event_params.rb

@@ -12,8 +12,14 @@ module Deeprails
       #   @return [String]
       required :workflow_id, String
 
-      # @!method initialize(workflow_id:, request_options: {})
+      # @!attribute event_id
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!method initialize(workflow_id:, event_id:, request_options: {})
       #   @param workflow_id [String]
+      #   @param event_id [String]
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/deeprails/models/defend_retrieve_workflow_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute workflow_id
+      #
+      #   @return [String]
+      required :workflow_id, String
+
       # @!attribute limit
       #   Limit the number of returned events associated with this workflow. Defaults
       #   to 10.
@@ -14,10 +19,12 @@ module Deeprails
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(limit: nil, request_options: {})
+      # @!method initialize(workflow_id:, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendRetrieveWorkflowParams} for more details.
       #
+      #   @param workflow_id [String]
+      #
       #   @param limit [Integer] Limit the number of returned events associated with this workflow. Defaults to
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]

data/lib/deeprails/models/defend_submit_and_stream_event_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute workflow_id
+      #
+      #   @return [String]
+      required :workflow_id, String
+
       # @!attribute model_input
       #   The input provided to the model (e.g., prompt, messages).
       #
@@ -26,15 +31,17 @@ module Deeprails
       required :model_used, String
 
       # @!attribute run_mode
-      #   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.
       #
       #   @return [Symbol, Deeprails::Models::DefendSubmitAndStreamEventParams::RunMode]
       required :run_mode, enum: -> { Deeprails::DefendSubmitAndStreamEventParams::RunMode }
 
       # @!attribute stream
-      #   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.
       #
       #   @return [Boolean, nil]
       optional :stream, Deeprails::Internal::Type::Boolean
@@ -45,35 +52,37 @@ module Deeprails
       #   @return [String, nil]
       optional :nametag, String
 
-      # @!method initialize(model_input:, model_output:, model_used:, run_mode:, stream: nil, nametag: nil, request_options: {})
+      # @!method initialize(workflow_id:, model_input:, model_output:, model_used:, run_mode:, stream: nil, nametag: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendSubmitAndStreamEventParams} for more details.
       #
+      #   @param workflow_id [String]
+      #
       #   @param model_input [Hash{Symbol=>Object}] The input provided to the model (e.g., prompt, messages).
       #
       #   @param model_output [String] The output generated by the model to be evaluated.
       #
       #   @param model_used [String] The model that generated the output (e.g., "gpt-4", "claude-3").
       #
-      #   @param run_mode [Symbol, Deeprails::Models::DefendSubmitAndStreamEventParams::RunMode] The evaluation run mode. Streaming only supports fast, precision, and
-      #   precision\_
+      #   @param run_mode [Symbol, Deeprails::Models::DefendSubmitAndStreamEventParams::RunMode] The evaluation run mode. Streaming is supported on all run modes except precisio
       #
-      #   @param stream [Boolean] Enable SSE streaming for real-time token feedback. Only supported for single-mod
+      #   @param stream [Boolean] Enable SSE streaming for real-time token feedback. Supported on all run modes ex
       #
       #   @param nametag [String] Optional tag to identify this event.
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
 
-      # 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
 
+        SUPER_FAST = :super_fast
         FAST = :fast
         PRECISION = :precision
         PRECISION_CODEX = :precision_codex
-        PRECISION_MAX = :precision_max
-        PRECISION_MAX_CODEX = :precision_max_codex
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/deeprails/models/defend_submit_event_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute workflow_id
+      #
+      #   @return [String]
+      required :workflow_id, String
+
       # @!attribute model_input
       #   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,
@@ -30,8 +35,11 @@ module Deeprails
       # @!attribute run_mode
       #   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.
       #
       #   @return [Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode]
       required :run_mode, enum: -> { Deeprails::DefendSubmitEventParams::RunMode }
@@ -42,10 +50,12 @@ module Deeprails
       #   @return [String, nil]
       optional :nametag, String
 
-      # @!method initialize(model_input:, model_output:, model_used:, run_mode:, nametag: nil, request_options: {})
+      # @!method initialize(workflow_id:, model_input:, model_output:, model_used:, run_mode:, nametag: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendSubmitEventParams} for more details.
       #
+      #   @param workflow_id [String]
+      #
       #   @param model_input [Deeprails::Models::DefendSubmitEventParams::ModelInput] A dictionary of inputs sent to the LLM to generate output. The dictionary must c
       #
       #   @param model_output [String] Output generated by the LLM to be evaluated.
@@ -126,16 +136,20 @@ 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
 
-        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
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/deeprails/models/defend_update_workflow_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute workflow_id
+      #
+      #   @return [String]
+      required :workflow_id, String
+
       # @!attribute automatic_hallucination_tolerance_levels
       #   New mapping of guardrail metrics to hallucination tolerance levels (either
       #   `low`, `medium`, or `high`) to be used when `threshold_type` is set to
@@ -84,10 +89,12 @@ module Deeprails
       #   @return [Boolean, nil]
       optional :web_search, Deeprails::Internal::Type::Boolean
 
-      # @!method initialize(automatic_hallucination_tolerance_levels: nil, context_awareness: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, improvement_action: nil, max_improvement_attempts: nil, name: nil, threshold_type: nil, web_search: nil, request_options: {})
+      # @!method initialize(workflow_id:, automatic_hallucination_tolerance_levels: nil, context_awareness: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, improvement_action: nil, max_improvement_attempts: nil, name: nil, threshold_type: nil, web_search: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendUpdateWorkflowParams} for more details.
       #
+      #   @param workflow_id [String]
+      #
       #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendUpdateWorkflowParams::AutomaticHallucinationToleranceLevel}] New mapping of guardrail metrics to hallucination tolerance levels
       #
       #   @param context_awareness [Boolean] Whether to enable context awareness for this workflow's evaluations.

data/lib/deeprails/models/monitor_detail_response.rb

@@ -131,6 +131,7 @@ module Deeprails
         # @!attribute run_mode
         #   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.
         #
         #   @return [Symbol, Deeprails::Models::MonitorDetailResponse::Evaluation::RunMode]
         required :run_mode, enum: -> { Deeprails::MonitorDetailResponse::Evaluation::RunMode }
@@ -294,15 +295,18 @@ 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.
         #
         # @see Deeprails::Models::MonitorDetailResponse::Evaluation#run_mode
         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
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/deeprails/models/monitor_event_detail_response.rb

@@ -158,10 +158,12 @@ module Deeprails
       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
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/deeprails/models/monitor_retrieve_event_params.rb

@@ -12,8 +12,14 @@ module Deeprails
       #   @return [String]
       required :monitor_id, String
 
-      # @!method initialize(monitor_id:, request_options: {})
+      # @!attribute event_id
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!method initialize(monitor_id:, event_id:, request_options: {})
       #   @param monitor_id [String]
+      #   @param event_id [String]
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/deeprails/models/monitor_retrieve_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute monitor_id
+      #
+      #   @return [String]
+      required :monitor_id, String
+
       # @!attribute limit
       #   Limit the number of returned evaluations associated with this monitor. Defaults
       #   to 10.
@@ -14,10 +19,12 @@ module Deeprails
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(limit: nil, request_options: {})
+      # @!method initialize(monitor_id:, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::MonitorRetrieveParams} for more details.
       #
+      #   @param monitor_id [String]
+      #
       #   @param limit [Integer] Limit the number of returned evaluations associated with this monitor. Defaults
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]

data/lib/deeprails/models/monitor_submit_event_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute monitor_id
+      #
+      #   @return [String]
+      required :monitor_id, String
+
       # @!attribute model_input
       #   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,
@@ -30,16 +35,21 @@ module Deeprails
       # @!attribute run_mode
       #   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.
       #
       #   @return [Symbol, Deeprails::Models::MonitorSubmitEventParams::RunMode, nil]
       optional :run_mode, enum: -> { Deeprails::MonitorSubmitEventParams::RunMode }
 
-      # @!method initialize(model_input:, model_output:, nametag: nil, run_mode: nil, request_options: {})
+      # @!method initialize(monitor_id:, model_input:, model_output:, nametag: nil, run_mode: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::MonitorSubmitEventParams} for more details.
       #
+      #   @param monitor_id [String]
+      #
       #   @param model_input [Deeprails::Models::MonitorSubmitEventParams::ModelInput] A dictionary of inputs sent to the LLM to generate output. The dictionary must c
       #
       #   @param model_output [String] Output generated by the LLM to be evaluated.
@@ -118,16 +128,20 @@ 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
 
-        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
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/deeprails/models/monitor_update_params.rb

@@ -7,6 +7,11 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      # @!attribute monitor_id
+      #
+      #   @return [String]
+      required :monitor_id, String
+
       # @!attribute description
       #   New description of the monitor.
       #
@@ -47,10 +52,12 @@ module Deeprails
       #   @return [Boolean, nil]
       optional :web_search, Deeprails::Internal::Type::Boolean
 
-      # @!method initialize(description: nil, file_search: nil, guardrail_metrics: nil, name: nil, status: nil, web_search: nil, request_options: {})
+      # @!method initialize(monitor_id:, description: nil, file_search: nil, guardrail_metrics: nil, name: nil, status: nil, web_search: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::MonitorUpdateParams} for more details.
       #
+      #   @param monitor_id [String]
+      #
       #   @param description [String] New description of the monitor.
       #
       #   @param file_search [Array<String>] An array of file IDs to search in the monitor's evaluations. Files must be uploa

data/lib/deeprails/models/workflow_event_detail_response.rb

@@ -63,8 +63,9 @@ module Deeprails
 
       # @!attribute key_improvements
       #
-      #   @return [Array<Object>]
-      required :key_improvements, Deeprails::Internal::Type::ArrayOf[Deeprails::Internal::Type::Unknown]
+      #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::KeyImprovement>]
+      required :key_improvements,
+               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::KeyImprovement] }
 
       # @!attribute status
       #   Status of the event.
@@ -141,7 +142,7 @@ module Deeprails
       #
       #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil] Status of the improvement tool used to improve the event. `improvement_required`
       #
-      #   @param key_improvements [Array<Object>]
+      #   @param key_improvements [Array<Deeprails::Models::WorkflowEventDetailResponse::KeyImprovement>]
       #
       #   @param status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::Status] Status of the event.
       #
@@ -301,6 +302,16 @@ module Deeprails
         #   @return [Array<Symbol>]
       end
 
+      class KeyImprovement < Deeprails::Internal::Type::BaseModel
+        # @!attribute key_improvement
+        #
+        #   @return [Array<String>, nil]
+        optional :key_improvement, Deeprails::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(key_improvement: nil)
+        #   @param key_improvement [Array<String>]
+      end
+
       # Status of the event.
       #
       # @see Deeprails::Models::WorkflowEventDetailResponse#status

data/lib/deeprails/resources/defend.rb

@@ -92,10 +92,11 @@ module Deeprails
       # @see Deeprails::Models::DefendRetrieveWorkflowParams
       def retrieve_workflow(workflow_id, params = {})
         parsed, options = Deeprails::DefendRetrieveWorkflowParams.dump_request(params)
+        query = Deeprails::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["defend/%1$s", workflow_id],
-          query: parsed,
+          query: query,
           model: Deeprails::DefendResponse,
           options: options
         )
@@ -104,8 +105,8 @@ module Deeprails
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::DefendSubmitAndStreamEventParams} for more details.
       #
-      # 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.
       #
       # @overload submit_and_stream_event_streaming(workflow_id, model_input:, model_output:, model_used:, run_mode:, stream: nil, nametag: nil, request_options: {})
       #
@@ -117,9 +118,9 @@ module Deeprails
       #
       # @param model_used [String] Body param: The model that generated the output (e.g., "gpt-4", "claude-3").
       #
-      # @param run_mode [Symbol, Deeprails::Models::DefendSubmitAndStreamEventParams::RunMode] Body param: The evaluation run mode. Streaming only supports fast, precision, an
+      # @param run_mode [Symbol, Deeprails::Models::DefendSubmitAndStreamEventParams::RunMode] Body param: The evaluation run mode. Streaming is supported on all run modes exc
       #
-      # @param stream [Boolean] Query param: Enable SSE streaming for real-time token feedback. Only supported f
+      # @param stream [Boolean] Query param: Enable SSE streaming for real-time token feedback. Supported on all
       #
       # @param nametag [String] Body param: Optional tag to identify this event.
       #
@@ -129,12 +130,13 @@ module Deeprails
       #
       # @see Deeprails::Models::DefendSubmitAndStreamEventParams
       def submit_and_stream_event_streaming(workflow_id, params)
-        parsed, options = Deeprails::DefendSubmitAndStreamEventParams.dump_request(params)
         query_params = [:stream]
+        parsed, options = Deeprails::DefendSubmitAndStreamEventParams.dump_request(params)
+        query = Deeprails::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :post,
           path: ["defend/%1$s/events?stream=true", workflow_id],
-          query: parsed.slice(*query_params),
+          query: query,
           headers: {"accept" => "text/event-stream"},
           body: parsed.except(*query_params),
           stream: Deeprails::Internal::Stream,

data/lib/deeprails/resources/monitor.rb

@@ -58,10 +58,11 @@ module Deeprails
       # @see Deeprails::Models::MonitorRetrieveParams
       def retrieve(monitor_id, params = {})
         parsed, options = Deeprails::MonitorRetrieveParams.dump_request(params)
+        query = Deeprails::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["monitor/%1$s", monitor_id],
-          query: parsed,
+          query: query,
           model: Deeprails::MonitorDetailResponse,
           options: options
         )

data/lib/deeprails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deeprails
-  VERSION = "0.23.0"
+  VERSION = "0.24.0"
 end