deeprails 0.18.0 → 0.23.0

data/lib/deeprails/models/workflow_event_detail_response.rb

@@ -4,6 +4,11 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Defend#retrieve_event
     class WorkflowEventDetailResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute analysis_of_failures
+      #
+      #   @return [Array<String>]
+      required :analysis_of_failures, Deeprails::Internal::Type::ArrayOf[String]
+
       # @!attribute evaluation_history
       #   History of evaluations for the event.
       #
@@ -44,13 +49,23 @@ module Deeprails
       required :improvement_action, enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementAction }
 
       # @!attribute improvement_tool_status
-      #   Status of the improvement tool used to improve the event.
+      #   Status of the improvement tool used to improve the event. `improvement_required`
+      #   indicates that the evaluation is complete and the improvement action is needed
+      #   but is not taking place. `improved` and `improvement_failed` indicate when the
+      #   improvement action concludes, successfully and unsuccessfully, respectively.
+      #   `no_improvement_required` means that the first evaluation passed all its
+      #   metrics!
       #
       #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil]
       required :improvement_tool_status,
                enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus },
                nil?: true
 
+      # @!attribute key_improvements
+      #
+      #   @return [Array<Object>]
+      required :key_improvements, Deeprails::Internal::Type::ArrayOf[Deeprails::Internal::Type::Unknown]
+
       # @!attribute status
       #   Status of the event.
       #
@@ -78,8 +93,8 @@ module Deeprails
                -> { Deeprails::Internal::Type::HashOf[enum: Deeprails::WorkflowEventDetailResponse::AutomaticHallucinationToleranceLevel] }
 
       # @!attribute capabilities
-      #   Extended AI capabilities available to the event, if any. Can be `web_search`
-      #   and/or `file_search`.
+      #   Extended AI capabilities available to the event, if any. Can be `web_search`,
+      #   `file_search`, and/or `context_awareness`.
       #
       #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::Capability>, nil]
       optional :capabilities,
@@ -99,10 +114,19 @@ module Deeprails
       #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::File>, nil]
       optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::File] }
 
-      # @!method initialize(evaluation_history:, evaluation_result:, event_id:, filtered:, improved_model_output:, improvement_action:, improvement_tool_status:, status:, threshold_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, files: nil)
+      # @!attribute max_improvement_attempts
+      #   The maximum number of improvement attempts to be applied to one event before it
+      #   is considered failed.
+      #
+      #   @return [Integer, nil]
+      optional :max_improvement_attempts, Integer
+
+      # @!method initialize(analysis_of_failures:, evaluation_history:, evaluation_result:, event_id:, filtered:, improved_model_output:, improvement_action:, improvement_tool_status:, key_improvements:, status:, threshold_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, files: nil, max_improvement_attempts: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::WorkflowEventDetailResponse} for more details.
       #
+      #   @param analysis_of_failures [Array<String>]
+      #
       #   @param evaluation_history [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>] History of evaluations for the event.
       #
       #   @param evaluation_result [Hash{Symbol=>Object}] Evaluation result consisting of average scores and rationales for each of the ev
@@ -115,7 +139,9 @@ module Deeprails
       #
       #   @param improvement_action [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementAction] Type of improvement action used to improve the event.
       #
-      #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil] Status of the improvement tool used to improve the event.
+      #   @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 status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::Status] Status of the event.
       #
@@ -125,13 +151,20 @@ module Deeprails
       #
       #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::WorkflowEventDetailResponse::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metric names to tolerance values. Values are strings (`low`
       #
-      #   @param capabilities [Array<Deeprails::Models::WorkflowEventDetailResponse::Capability>] Extended AI capabilities available to the event, if any. Can be `web_search` and
+      #   @param capabilities [Array<Deeprails::Models::WorkflowEventDetailResponse::Capability>] Extended AI capabilities available to the event, if any. Can be `web_search`, `f
       #
       #   @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metric names to threshold values. Values are floating point
       #
       #   @param files [Array<Deeprails::Models::WorkflowEventDetailResponse::File>] List of files available to the event, if any. Will only be present if `file_sear
+      #
+      #   @param max_improvement_attempts [Integer] The maximum number of improvement attempts to be applied to one event before it
 
       class EvaluationHistory < Deeprails::Internal::Type::BaseModel
+        # @!attribute analysis_of_failures
+        #
+        #   @return [String, nil]
+        optional :analysis_of_failures, String
+
         # @!attribute attempt
         #
         #   @return [String, nil]
@@ -167,6 +200,17 @@ module Deeprails
         #   @return [Array<String>, nil]
         optional :guardrail_metrics, Deeprails::Internal::Type::ArrayOf[String]
 
+        # @!attribute improvement_tool_status
+        #
+        #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus, nil]
+        optional :improvement_tool_status,
+                 enum: -> { Deeprails::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus }
+
+        # @!attribute key_improvements
+        #
+        #   @return [Array<String>, nil]
+        optional :key_improvements, Deeprails::Internal::Type::ArrayOf[String]
+
         # @!attribute model_input
         #
         #   @return [Hash{Symbol=>Object}, nil]
@@ -177,11 +221,6 @@ module Deeprails
         #   @return [String, nil]
         optional :model_output, String
 
-        # @!attribute modified_at
-        #
-        #   @return [Time, nil]
-        optional :modified_at, Time
-
         # @!attribute nametag
         #
         #   @return [String, nil]
@@ -197,7 +236,8 @@ module Deeprails
         #   @return [String, nil]
         optional :run_mode, String
 
-        # @!method initialize(attempt: nil, created_at: nil, error_message: nil, evaluation_result: nil, evaluation_status: nil, evaluation_total_cost: nil, guardrail_metrics: nil, model_input: nil, model_output: nil, modified_at: nil, nametag: nil, progress: nil, run_mode: nil)
+        # @!method initialize(analysis_of_failures: nil, attempt: nil, created_at: nil, error_message: nil, evaluation_result: nil, evaluation_status: nil, evaluation_total_cost: nil, guardrail_metrics: nil, improvement_tool_status: nil, key_improvements: nil, model_input: nil, model_output: nil, nametag: nil, progress: nil, run_mode: nil)
+        #   @param analysis_of_failures [String]
         #   @param attempt [String]
         #   @param created_at [Time]
         #   @param error_message [String]
@@ -205,12 +245,26 @@ module Deeprails
         #   @param evaluation_status [String]
         #   @param evaluation_total_cost [Float]
         #   @param guardrail_metrics [Array<String>]
+        #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory::ImprovementToolStatus]
+        #   @param key_improvements [Array<String>]
         #   @param model_input [Hash{Symbol=>Object}]
         #   @param model_output [String]
-        #   @param modified_at [Time]
         #   @param nametag [String]
         #   @param progress [Integer]
         #   @param run_mode [String]
+
+        # @see Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory#improvement_tool_status
+        module ImprovementToolStatus
+          extend Deeprails::Internal::Type::Enum
+
+          IMPROVED = :improved
+          IMPROVEMENT_FAILED = :improvement_failed
+          NO_IMPROVEMENT_REQUIRED = :no_improvement_required
+          IMPROVEMENT_REQUIRED = :improvement_required
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # Type of improvement action used to improve the event.
@@ -227,14 +281,20 @@ module Deeprails
         #   @return [Array<Symbol>]
       end
 
-      # Status of the improvement tool used to improve the event.
+      # Status of the improvement tool used to improve the event. `improvement_required`
+      # indicates that the evaluation is complete and the improvement action is needed
+      # but is not taking place. `improved` and `improvement_failed` indicate when the
+      # improvement action concludes, successfully and unsuccessfully, respectively.
+      # `no_improvement_required` means that the first evaluation passed all its
+      # metrics!
       #
       # @see Deeprails::Models::WorkflowEventDetailResponse#improvement_tool_status
       module ImprovementToolStatus
         extend Deeprails::Internal::Type::Enum
 
         IMPROVED = :improved
-        FAILED_ON_MAX_RETRIES = :"failed on max retries"
+        IMPROVEMENT_FAILED = :improvement_failed
+        NO_IMPROVEMENT_REQUIRED = :no_improvement_required
         IMPROVEMENT_REQUIRED = :improvement_required
 
         # @!method self.values
@@ -304,10 +364,22 @@ module Deeprails
         #   @return [Integer, nil]
         optional :file_size, Integer
 
-        # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
+        # @!attribute presigned_url
+        #
+        #   @return [String, nil]
+        optional :presigned_url, String
+
+        # @!attribute presigned_url_expires_at
+        #
+        #   @return [Time, nil]
+        optional :presigned_url_expires_at, Time
+
+        # @!method initialize(file_id: nil, file_name: nil, file_size: nil, presigned_url: nil, presigned_url_expires_at: nil)
         #   @param file_id [String]
         #   @param file_name [String]
         #   @param file_size [Integer]
+        #   @param presigned_url [String]
+        #   @param presigned_url_expires_at [Time]
       end
     end
   end

data/lib/deeprails/models/workflow_event_response.rb

@@ -4,6 +4,12 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Defend#submit_event
     class WorkflowEventResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute billing_request_id
+      #   The ID of the billing request for the event.
+      #
+      #   @return [String]
+      required :billing_request_id, String
+
       # @!attribute created_at
       #   The time the event was created in UTC.
       #
@@ -28,7 +34,9 @@ module Deeprails
       #   @return [String]
       required :workflow_id, String
 
-      # @!method initialize(created_at:, event_id:, status:, workflow_id:)
+      # @!method initialize(billing_request_id:, created_at:, event_id:, status:, workflow_id:)
+      #   @param billing_request_id [String] The ID of the billing request for the event.
+      #
       #   @param created_at [Time] The time the event was created in UTC.
       #
       #   @param event_id [String] A unique workflow event ID.

data/lib/deeprails/models.rb

@@ -49,6 +49,8 @@ module Deeprails
 
   DefendRetrieveWorkflowParams = Deeprails::Models::DefendRetrieveWorkflowParams
 
+  DefendSubmitAndStreamEventParams = Deeprails::Models::DefendSubmitAndStreamEventParams
+
   DefendSubmitEventParams = Deeprails::Models::DefendSubmitEventParams
 
   DefendUpdateResponse = Deeprails::Models::DefendUpdateResponse

data/lib/deeprails/resources/defend.rb

@@ -9,7 +9,7 @@ module Deeprails
       # Use this endpoint to create a new guardrail workflow by specifying guardrail
       # thresholds, an improvement action, and optional extended capabilities.
       #
-      # @overload create_workflow(improvement_action:, name:, threshold_type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {})
+      # @overload create_workflow(improvement_action:, name:, threshold_type:, automatic_hallucination_tolerance_levels: nil, context_awareness: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {})
       #
       # @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
       #
@@ -19,6 +19,8 @@ module Deeprails
       #
       # @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metrics to hallucination tolerance levels
       #
+      # @param context_awareness [Boolean] Context includes any structured information that directly relates to the model’s
+      #
       # @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metrics to floating point threshold values. Possible metric
       #
       # @param description [String] Description for the workflow.
@@ -99,6 +101,48 @@ module Deeprails
         )
       end
 
+      # 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).
+      #
+      # @overload submit_and_stream_event_streaming(workflow_id, model_input:, model_output:, model_used:, run_mode:, stream: nil, nametag: nil, request_options: {})
+      #
+      # @param workflow_id [String] Path param: The ID of the workflow to create the event for.
+      #
+      # @param model_input [Hash{Symbol=>Object}] Body param: The input provided to the model (e.g., prompt, messages).
+      #
+      # @param model_output [String] Body param: The output generated by the model to be evaluated.
+      #
+      # @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 stream [Boolean] Query param: Enable SSE streaming for real-time token feedback. Only supported f
+      #
+      # @param nametag [String] Body param: Optional tag to identify this event.
+      #
+      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Deeprails::Internal::Stream<String>]
+      #
+      # @see Deeprails::Models::DefendSubmitAndStreamEventParams
+      def submit_and_stream_event_streaming(workflow_id, params)
+        parsed, options = Deeprails::DefendSubmitAndStreamEventParams.dump_request(params)
+        query_params = [:stream]
+        @client.request(
+          method: :post,
+          path: ["defend/%1$s/events?stream=true", workflow_id],
+          query: parsed.slice(*query_params),
+          headers: {"accept" => "text/event-stream"},
+          body: parsed.except(*query_params),
+          stream: Deeprails::Internal::Stream,
+          model: String,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::DefendSubmitEventParams} for more details.
       #
@@ -135,15 +179,34 @@ module Deeprails
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Deeprails::Models::DefendUpdateWorkflowParams} for more details.
+      #
       # Use this endpoint to update an existing defend workflow if its details change.
       #
-      # @overload update_workflow(workflow_id, description: nil, name: nil, request_options: {})
+      # @overload update_workflow(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: {})
       #
       # @param workflow_id [String] The ID of the workflow to edit.
       #
-      # @param description [String] Description for the workflow.
+      # @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendUpdateWorkflowParams::AutomaticHallucinationToleranceLevel}] New mapping of guardrail metrics to hallucination tolerance levels
       #
-      # @param name [String] Name of the workflow.
+      # @param context_awareness [Boolean] Whether to enable context awareness for this workflow's evaluations.
+      #
+      # @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] New mapping of guardrail metrics to floating point threshold values to be used w
+      #
+      # @param description [String] New description for the workflow.
+      #
+      # @param file_search [Array<String>] An array of file IDs to search in the workflow's evaluations. Files must be uplo
+      #
+      # @param improvement_action [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::ImprovementAction] The new action used to improve outputs that fail one or more guardrail metrics f
+      #
+      # @param max_improvement_attempts [Integer] Max. number of improvement action attempts until a given event passes the guardr
+      #
+      # @param name [String] New name for the workflow.
+      #
+      # @param threshold_type [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::ThresholdType] New type of thresholds to use for the workflow, either `automatic` or `custom`.
+      #
+      # @param web_search [Boolean] Whether to enable web search for this workflow's evaluations.
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #

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
@@ -68,19 +70,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.23.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/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],