deeprails 0.18.0 → 0.24.0

data/rbi/deeprails/models/monitor_create_params.rbi

@@ -26,6 +26,18 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :name
 
+      # 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
+      # monitor'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
+
       # Description of the new monitor.
       sig { returns(T.nilable(String)) }
       attr_reader :description
@@ -53,6 +65,7 @@ module Deeprails
           guardrail_metrics:
             T::Array[Deeprails::MonitorCreateParams::GuardrailMetric::OrSymbol],
           name: String,
+          context_awareness: T::Boolean,
           description: String,
           file_search: T::Array[String],
           web_search: T::Boolean,
@@ -67,6 +80,13 @@ module Deeprails
         guardrail_metrics:,
         # Name of the new monitor.
         name:,
+        # 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
+        # monitor's evaluations. Defaults to false.
+        context_awareness: nil,
         # Description of the new monitor.
         description: nil,
         # An array of file IDs to search in the monitor's evaluations. Files must be
@@ -86,6 +106,7 @@ module Deeprails
                 Deeprails::MonitorCreateParams::GuardrailMetric::OrSymbol
               ],
             name: String,
+            context_awareness: T::Boolean,
             description: String,
             file_search: T::Array[String],
             web_search: T::Boolean,

data/rbi/deeprails/models/monitor_detail_response.rbi

@@ -8,7 +8,8 @@ module Deeprails
           T.any(Deeprails::MonitorDetailResponse, Deeprails::Internal::AnyHash)
         end
 
-      # An array of capabilities associated with this monitor.
+      # An array of extended AI capabilities associated with this monitor. Can be
+      # `web_search`, `file_search`, and/or `context_awareness`.
       sig { returns(T::Array[Deeprails::MonitorDetailResponse::Capability]) }
       attr_accessor :capabilities
 
@@ -77,7 +78,8 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
-        # An array of capabilities associated with this monitor.
+        # An array of extended AI capabilities associated with this monitor. Can be
+        # `web_search`, `file_search`, and/or `context_awareness`.
         capabilities:,
         # The time the monitor was created in UTC.
         created_at:,
@@ -170,8 +172,9 @@ module Deeprails
         attr_accessor :evaluation_status
 
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least a `user_prompt` field or a `system_prompt` field. For
-        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+        # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
+        # `ground_truth` should be provided. When `context_awareness` is enabled,
+        # `context` should be provided.
         sig do
           returns(Deeprails::MonitorDetailResponse::Evaluation::ModelInput)
         end
@@ -191,6 +194,7 @@ module Deeprails
 
         # Run mode for the evaluation. The run mode allows the user to optimize for speed,
         # accuracy, and cost by determining which models are used to evaluate the event.
+        # Note: `super_fast` do not support Web Search or File Search capabilities.
         sig do
           returns(
             Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
@@ -290,13 +294,15 @@ module Deeprails
           # Status of the evaluation.
           evaluation_status:,
           # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-          # contain at least a `user_prompt` field or a `system_prompt` field. For
-          # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+          # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
+          # `ground_truth` should be provided. When `context_awareness` is enabled,
+          # `context` should be provided.
           model_input:,
           # Output generated by the LLM to be evaluated.
           model_output:,
           # Run mode for the evaluation. The run mode allows the user to optimize for speed,
           # accuracy, and cost by determining which models are used to evaluate the event.
+          # Note: `super_fast` do not support Web Search or File Search capabilities.
           run_mode:,
           # The time the evaluation was created in UTC.
           created_at: nil,
@@ -403,6 +409,36 @@ module Deeprails
               )
             end
 
+          # The user prompt used to generate the output.
+          sig { returns(String) }
+          attr_accessor :user_prompt
+
+          # 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.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Deeprails::MonitorDetailResponse::Evaluation::ModelInput::Context
+                ]
+              )
+            )
+          end
+          attr_reader :context
+
+          sig do
+            params(
+              context:
+                T::Array[
+                  Deeprails::MonitorDetailResponse::Evaluation::ModelInput::Context::OrHash
+                ]
+            ).void
+          end
+          attr_writer :context
+
           # The ground truth for evaluating Ground Truth Adherence guardrail.
           sig { returns(T.nilable(String)) }
           attr_reader :ground_truth
@@ -417,48 +453,96 @@ module Deeprails
           sig { params(system_prompt: String).void }
           attr_writer :system_prompt
 
-          # The user prompt used to generate the output.
-          sig { returns(T.nilable(String)) }
-          attr_reader :user_prompt
-
-          sig { params(user_prompt: String).void }
-          attr_writer :user_prompt
-
           # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-          # contain at least a `user_prompt` field or a `system_prompt` field. For
-          # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+          # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
+          # `ground_truth` should be provided. When `context_awareness` is enabled,
+          # `context` should be provided.
           sig do
             params(
+              user_prompt: String,
+              context:
+                T::Array[
+                  Deeprails::MonitorDetailResponse::Evaluation::ModelInput::Context::OrHash
+                ],
               ground_truth: String,
-              system_prompt: String,
-              user_prompt: String
+              system_prompt: String
             ).returns(T.attached_class)
           end
           def self.new(
+            # The user prompt used to generate the output.
+            user_prompt:,
+            # 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.
+            context: nil,
             # The ground truth for evaluating Ground Truth Adherence guardrail.
             ground_truth: nil,
             # The system prompt used to generate the output.
-            system_prompt: nil,
-            # The user prompt used to generate the output.
-            user_prompt: nil
+            system_prompt: nil
           )
           end
 
           sig do
             override.returns(
               {
+                user_prompt: String,
+                context:
+                  T::Array[
+                    Deeprails::MonitorDetailResponse::Evaluation::ModelInput::Context
+                  ],
                 ground_truth: String,
-                system_prompt: String,
-                user_prompt: String
+                system_prompt: String
               }
             )
           end
           def to_hash
           end
+
+          class Context < Deeprails::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Deeprails::MonitorDetailResponse::Evaluation::ModelInput::Context,
+                  Deeprails::Internal::AnyHash
+                )
+              end
+
+            # The content of the message.
+            sig { returns(T.nilable(String)) }
+            attr_reader :content
+
+            sig { params(content: String).void }
+            attr_writer :content
+
+            # The role of the speaker.
+            sig { returns(T.nilable(String)) }
+            attr_reader :role
+
+            sig { params(role: String).void }
+            attr_writer :role
+
+            sig do
+              params(content: String, role: String).returns(T.attached_class)
+            end
+            def self.new(
+              # The content of the message.
+              content: nil,
+              # The role of the speaker.
+              role: nil
+            )
+            end
+
+            sig { override.returns({ content: String, role: String }) }
+            def to_hash
+            end
+          end
         end
 
         # Run mode for the evaluation. The run mode allows the user to optimize for speed,
         # accuracy, and cost by determining which models are used to evaluate the event.
+        # Note: `super_fast` do not support Web Search or File Search capabilities.
         module RunMode
           extend Deeprails::Internal::Type::Enum
 
@@ -471,9 +555,14 @@ module Deeprails
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          PRECISION_PLUS =
+          SUPER_FAST =
             T.let(
-              :precision_plus,
+              :super_fast,
+              Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
+            )
+          FAST =
+            T.let(
+              :fast,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
           PRECISION =
@@ -481,14 +570,19 @@ module Deeprails
               :precision,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
-          SMART =
+          PRECISION_CODEX =
+            T.let(
+              :precision_codex,
+              Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
+            )
+          PRECISION_MAX =
             T.let(
-              :smart,
+              :precision_max,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
-          ECONOMY =
+          PRECISION_MAX_CODEX =
             T.let(
-              :economy,
+              :precision_max_codex,
               Deeprails::MonitorDetailResponse::Evaluation::RunMode::TaggedSymbol
             )
 

data/rbi/deeprails/models/monitor_event_detail_response.rbi

@@ -11,7 +11,8 @@ module Deeprails
           )
         end
 
-      # The capabilities associated with the monitor event.
+      # The extended AI capabilities associated with the monitor event. Can be
+      # `web_search`, `file_search`, and/or `context_awareness`.
       sig do
         returns(
           T.nilable(T::Array[Deeprails::MonitorEventDetailResponse::Capability])
@@ -156,7 +157,8 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
-        # The capabilities associated with the monitor event.
+        # The extended AI capabilities associated with the monitor event. Can be
+        # `web_search`, `file_search`, and/or `context_awareness`.
         capabilities: nil,
         # The time spent on the evaluation in seconds.
         eval_time: nil,
@@ -303,9 +305,14 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PRECISION_PLUS =
+        SUPER_FAST =
           T.let(
-            :precision_plus,
+            :super_fast,
+            Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
+          )
+        FAST =
+          T.let(
+            :fast,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
         PRECISION =
@@ -313,14 +320,19 @@ module Deeprails
             :precision,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
-        SMART =
+        PRECISION_CODEX =
+          T.let(
+            :precision_codex,
+            Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
+          )
+        PRECISION_MAX =
           T.let(
-            :smart,
+            :precision_max,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
-        ECONOMY =
+        PRECISION_MAX_CODEX =
           T.let(
-            :economy,
+            :precision_max_codex,
             Deeprails::MonitorEventDetailResponse::RunMode::TaggedSymbol
           )
 

data/rbi/deeprails/models/monitor_retrieve_event_params.rbi

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

data/rbi/deeprails/models/monitor_retrieve_params.rbi

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

data/rbi/deeprails/models/monitor_submit_event_params.rbi

@@ -14,9 +14,12 @@ module Deeprails
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
       # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      # contain at least a `user_prompt` field or a `system_prompt` field. For
-      # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+      # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
+      # `ground_truth` should be provided.
       sig { returns(Deeprails::MonitorSubmitEventParams::ModelInput) }
       attr_reader :model_input
 
@@ -40,8 +43,11 @@ module Deeprails
 
       # Run mode for the monitor event. The run mode allows the user to optimize for
       # speed, accuracy, and cost by determining which models are used to evaluate the
-      # event. Available run modes include `precision_plus`, `precision`, `smart`, and
-      # `economy`. Defaults to `smart`.
+      # event. Available run modes (fastest to most thorough): `super_fast`, `fast`,
+      # `precision`, `precision_codex`, `precision_max`, and `precision_max_codex`.
+      # Defaults to `fast`. Note: `super_fast` does not support Web Search or File
+      # Search — if your monitor has these capabilities enabled, use a different run
+      # mode or edit the monitor to disable them.
       sig do
         returns(
           T.nilable(Deeprails::MonitorSubmitEventParams::RunMode::OrSymbol)
@@ -58,6 +64,7 @@ module Deeprails
 
       sig do
         params(
+          monitor_id: String,
           model_input: Deeprails::MonitorSubmitEventParams::ModelInput::OrHash,
           model_output: String,
           nametag: String,
@@ -66,9 +73,10 @@ module Deeprails
         ).returns(T.attached_class)
       end
       def self.new(
+        monitor_id:,
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least a `user_prompt` field or a `system_prompt` field. For
-        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+        # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
+        # `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
@@ -76,8 +84,11 @@ module Deeprails
         nametag: nil,
         # Run mode for the monitor event. The run mode allows the user to optimize for
         # speed, accuracy, and cost by determining which models are used to evaluate the
-        # event. Available run modes include `precision_plus`, `precision`, `smart`, and
-        # `economy`. Defaults to `smart`.
+        # event. Available run modes (fastest to most thorough): `super_fast`, `fast`,
+        # `precision`, `precision_codex`, `precision_max`, and `precision_max_codex`.
+        # Defaults to `fast`. Note: `super_fast` does not support Web Search or File
+        # Search — if your monitor has these capabilities enabled, use a different run
+        # mode or edit the monitor to disable them.
         run_mode: nil,
         request_options: {}
       )
@@ -86,6 +97,7 @@ module Deeprails
       sig do
         override.returns(
           {
+            monitor_id: String,
             model_input: Deeprails::MonitorSubmitEventParams::ModelInput,
             model_output: String,
             nametag: String,
@@ -106,6 +118,34 @@ module Deeprails
             )
           end
 
+        # The user prompt used to generate the output.
+        sig { returns(String) }
+        attr_accessor :user_prompt
+
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Deeprails::MonitorSubmitEventParams::ModelInput::Context]
+            )
+          )
+        end
+        attr_reader :context
+
+        sig do
+          params(
+            context:
+              T::Array[
+                Deeprails::MonitorSubmitEventParams::ModelInput::Context::OrHash
+              ]
+          ).void
+        end
+        attr_writer :context
+
         # The ground truth for evaluating Ground Truth Adherence guardrail.
         sig { returns(T.nilable(String)) }
         attr_reader :ground_truth
@@ -120,46 +160,99 @@ module Deeprails
         sig { params(system_prompt: String).void }
         attr_writer :system_prompt
 
-        # The user prompt used to generate the output.
-        sig { returns(T.nilable(String)) }
-        attr_reader :user_prompt
-
-        sig { params(user_prompt: String).void }
-        attr_writer :user_prompt
-
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least a `user_prompt` field or a `system_prompt` field. For
-        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
+        # contain a `user_prompt` field. For ground_truth_adherence guardrail metric,
+        # `ground_truth` should be provided.
         sig do
           params(
+            user_prompt: String,
+            context:
+              T::Array[
+                Deeprails::MonitorSubmitEventParams::ModelInput::Context::OrHash
+              ],
             ground_truth: String,
-            system_prompt: String,
-            user_prompt: String
+            system_prompt: String
           ).returns(T.attached_class)
         end
         def self.new(
+          # The user prompt used to generate the output.
+          user_prompt:,
+          # 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.
+          context: nil,
           # The ground truth for evaluating Ground Truth Adherence guardrail.
           ground_truth: nil,
           # The system prompt used to generate the output.
-          system_prompt: nil,
-          # The user prompt used to generate the output.
-          user_prompt: nil
+          system_prompt: nil
         )
         end
 
         sig do
           override.returns(
-            { ground_truth: String, system_prompt: String, user_prompt: String }
+            {
+              user_prompt: String,
+              context:
+                T::Array[
+                  Deeprails::MonitorSubmitEventParams::ModelInput::Context
+                ],
+              ground_truth: String,
+              system_prompt: String
+            }
           )
         end
         def to_hash
         end
+
+        class Context < Deeprails::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Deeprails::MonitorSubmitEventParams::ModelInput::Context,
+                Deeprails::Internal::AnyHash
+              )
+            end
+
+          # The content of the message.
+          sig { returns(T.nilable(String)) }
+          attr_reader :content
+
+          sig { params(content: String).void }
+          attr_writer :content
+
+          # The role of the speaker.
+          sig { returns(T.nilable(String)) }
+          attr_reader :role
+
+          sig { params(role: String).void }
+          attr_writer :role
+
+          sig do
+            params(content: String, role: String).returns(T.attached_class)
+          end
+          def self.new(
+            # The content of the message.
+            content: nil,
+            # The role of the speaker.
+            role: nil
+          )
+          end
+
+          sig { override.returns({ content: String, role: String }) }
+          def to_hash
+          end
+        end
       end
 
       # 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`, `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
 
@@ -169,9 +262,14 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        PRECISION_PLUS =
+        SUPER_FAST =
           T.let(
-            :precision_plus,
+            :super_fast,
+            Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
+          )
+        FAST =
+          T.let(
+            :fast,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
         PRECISION =
@@ -179,14 +277,19 @@ module Deeprails
             :precision,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
-        SMART =
+        PRECISION_CODEX =
+          T.let(
+            :precision_codex,
+            Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
+          )
+        PRECISION_MAX =
           T.let(
-            :smart,
+            :precision_max,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )
-        ECONOMY =
+        PRECISION_MAX_CODEX =
           T.let(
-            :economy,
+            :precision_max_codex,
             Deeprails::MonitorSubmitEventParams::RunMode::TaggedSymbol
           )