deeprails 0.18.0 → 0.24.0

data/lib/deeprails/resources/monitor.rb

@@ -9,12 +9,14 @@ module Deeprails
       # Use this endpoint to create a new monitor to evaluate model inputs and outputs
       # using guardrails
       #
-      # @overload create(guardrail_metrics:, name:, description: nil, file_search: nil, web_search: nil, request_options: {})
+      # @overload create(guardrail_metrics:, name:, context_awareness: nil, description: nil, file_search: nil, web_search: nil, request_options: {})
       #
       # @param guardrail_metrics [Array<Symbol, Deeprails::Models::MonitorCreateParams::GuardrailMetric>] An array of guardrail metrics that the model input and output pair will be evalu
       #
       # @param name [String] Name of the new monitor.
       #
+      # @param context_awareness [Boolean] Context includes any structured information that directly relates to the model’s
+      #
       # @param description [String] Description of the new monitor.
       #
       # @param file_search [Array<String>] An array of file IDs to search in the monitor's evaluations. Files must be uploa
@@ -56,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
         )
@@ -68,19 +71,25 @@ module Deeprails
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::MonitorUpdateParams} for more details.
       #
-      # Use this endpoint to update the name, description, or status of an existing
-      # monitor
+      # Use this endpoint to update the name, status, and/or other details of an
+      # existing monitor.
       #
-      # @overload update(monitor_id, description: nil, name: nil, status: nil, request_options: {})
+      # @overload update(monitor_id, description: nil, file_search: nil, guardrail_metrics: nil, name: nil, status: nil, web_search: nil, request_options: {})
       #
       # @param monitor_id [String] The ID of the monitor to edit.
       #
-      # @param description [String] Description of the monitor.
+      # @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
       #
-      # @param name [String] Name of the monitor.
+      # @param guardrail_metrics [Array<Symbol, Deeprails::Models::MonitorUpdateParams::GuardrailMetric>] An array of the new guardrail metrics that model input and output pairs will be
+      #
+      # @param name [String] New name of the monitor.
       #
       # @param status [Symbol, Deeprails::Models::MonitorUpdateParams::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
       #
+      # @param web_search [Boolean] Whether to enable web search for this monitor's evaluations.
+      #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Deeprails::Models::MonitorUpdateResponse]

data/lib/deeprails/version.rb

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

data/lib/deeprails.rb

@@ -3,6 +3,7 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
@@ -43,6 +44,7 @@ require_relative "deeprails/internal/type/array_of"
 require_relative "deeprails/internal/type/hash_of"
 require_relative "deeprails/internal/type/base_model"
 require_relative "deeprails/internal/type/base_page"
+require_relative "deeprails/internal/type/base_stream"
 require_relative "deeprails/internal/type/request_parameters"
 require_relative "deeprails/internal"
 require_relative "deeprails/request_options"
@@ -51,11 +53,14 @@ require_relative "deeprails/errors"
 require_relative "deeprails/internal/transport/base_client"
 require_relative "deeprails/internal/transport/pooled_net_requester"
 require_relative "deeprails/client"
+require_relative "deeprails/internal/stream"
 require_relative "deeprails/models/defend_create_response"
 require_relative "deeprails/models/defend_create_workflow_params"
 require_relative "deeprails/models/defend_response"
 require_relative "deeprails/models/defend_retrieve_event_params"
 require_relative "deeprails/models/defend_retrieve_workflow_params"
+require_relative "deeprails/models/defend_submit_and_stream_event_params"
+require_relative "deeprails/models/defend_submit_and_stream_event_response"
 require_relative "deeprails/models/defend_submit_event_params"
 require_relative "deeprails/models/defend_update_response"
 require_relative "deeprails/models/defend_update_workflow_params"

data/manifest.yaml

@@ -1,5 +1,6 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb

data/rbi/deeprails/internal/stream.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Deeprails
+  module Internal
+    class Stream
+      Message =
+        type_member(:in) do
+          { fixed: Deeprails::Internal::Util::ServerSentEvent }
+        end
+      Elem = type_member(:out)
+
+      include Deeprails::Internal::Type::BaseStream
+
+      # @api private
+      sig { override.returns(T::Enumerable[Elem]) }
+      private def iterator
+      end
+    end
+  end
+end

data/rbi/deeprails/internal/transport/base_client.rbi

@@ -49,7 +49,15 @@ module Deeprails
                     ]
                   ]
                 ),
-              stream: T.nilable(T::Class[T.anything]),
+              stream:
+                T.nilable(
+                  T::Class[
+                    Deeprails::Internal::Type::BaseStream[
+                      T.anything,
+                      Deeprails::Internal::Type::BaseModel
+                    ]
+                  ]
+                ),
               model: T.nilable(Deeprails::Internal::Type::Converter::Input),
               options: T.nilable(Deeprails::RequestOptions::OrHash)
             }
@@ -269,7 +277,15 @@ module Deeprails
                   ]
                 ]
               ),
-            stream: T.nilable(T::Class[T.anything]),
+            stream:
+              T.nilable(
+                T::Class[
+                  Deeprails::Internal::Type::BaseStream[
+                    T.anything,
+                    Deeprails::Internal::Type::BaseModel
+                  ]
+                ]
+              ),
             model: T.nilable(Deeprails::Internal::Type::Converter::Input),
             options: T.nilable(Deeprails::RequestOptions::OrHash)
           ).returns(T.anything)

data/rbi/deeprails/internal/type/base_stream.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Deeprails
+  module Internal
+    module Type
+      # @api private
+      #
+      # This module provides a base implementation for streaming responses in the SDK.
+      module BaseStream
+        include Enumerable
+
+        Message = type_member(:in)
+        Elem = type_member(:out)
+
+        sig { returns(Integer) }
+        attr_reader :status
+
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :headers
+
+        sig { void }
+        def close
+        end
+
+        # @api private
+        sig { overridable.returns(T::Enumerable[Elem]) }
+        private def iterator
+        end
+
+        sig { params(blk: T.proc.params(arg0: Elem).void).void }
+        def each(&blk)
+        end
+
+        sig { returns(T::Enumerator[Elem]) }
+        def to_enum
+        end
+
+        # @api private
+        sig do
+          params(
+            model:
+              T.any(T::Class[T.anything], Deeprails::Internal::Type::Converter),
+            url: URI::Generic,
+            status: Integer,
+            headers: T::Hash[String, String],
+            response: Net::HTTPResponse,
+            unwrap:
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              ),
+            stream: T::Enumerable[Message]
+          ).void
+        end
+        def initialize(
+          model:,
+          url:,
+          status:,
+          headers:,
+          response:,
+          unwrap:,
+          stream:
+        )
+        end
+
+        # @api private
+        sig { returns(String) }
+        def inspect
+        end
+      end
+    end
+  end
+end

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_create_workflow_params.rbi

@@ -67,6 +67,18 @@ module Deeprails
       end
       attr_writer :automatic_hallucination_tolerance_levels
 
+      # Context includes any structured information that directly relates to the model’s
+      # input and expected output—e.g., the recent turn-by-turn history between an AI
+      # tutor and a student, facts or state passed through an agentic workflow, or other
+      # domain-specific signals your system already knows and wants the model to
+      # condition on. This field determines whether to enable context awareness for this
+      # workflow's evaluations. Defaults to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :context_awareness
+
+      sig { params(context_awareness: T::Boolean).void }
+      attr_writer :context_awareness
+
       # Mapping of guardrail metrics to floating point threshold values. Possible
       # metrics are `correctness`, `completeness`, `instruction_adherence`,
       # `context_adherence`, `ground_truth_adherence`, or `comprehensive_safety`.
@@ -122,6 +134,7 @@ module Deeprails
               Symbol,
               Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
             ],
+          context_awareness: T::Boolean,
           custom_hallucination_threshold_values: T::Hash[Symbol, Float],
           description: String,
           file_search: T::Array[String],
@@ -150,6 +163,13 @@ module Deeprails
         # `instruction_adherence`, `context_adherence`, `ground_truth_adherence`, or
         # `comprehensive_safety`.
         automatic_hallucination_tolerance_levels: nil,
+        # Context includes any structured information that directly relates to the model’s
+        # input and expected output—e.g., the recent turn-by-turn history between an AI
+        # tutor and a student, facts or state passed through an agentic workflow, or other
+        # domain-specific signals your system already knows and wants the model to
+        # condition on. This field determines whether to enable context awareness for this
+        # workflow's evaluations. Defaults to false.
+        context_awareness: nil,
         # Mapping of guardrail metrics to floating point threshold values. Possible
         # metrics are `correctness`, `completeness`, `instruction_adherence`,
         # `context_adherence`, `ground_truth_adherence`, or `comprehensive_safety`.
@@ -181,6 +201,7 @@ module Deeprails
                 Symbol,
                 Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
               ],
+            context_awareness: T::Boolean,
             custom_hallucination_threshold_values: T::Hash[Symbol, Float],
             description: String,
             file_search: T::Array[String],