deeprails 0.9.0 → 0.11.0

data/rbi/deeprails/models/file_upload_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Deeprails
+  module Models
+    class FileUploadParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Deeprails::FileUploadParams, Deeprails::Internal::AnyHash)
+        end
+
+      # The contents of the file to upload.
+      sig { returns(Deeprails::Internal::FileInput) }
+      attr_accessor :file
+
+      sig do
+        params(
+          file: Deeprails::Internal::FileInput,
+          request_options: Deeprails::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The contents of the file to upload.
+        file:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            file: Deeprails::Internal::FileInput,
+            request_options: Deeprails::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/deeprails/models/monitor_create_params.rbi

@@ -11,6 +11,17 @@ module Deeprails
           T.any(Deeprails::MonitorCreateParams, Deeprails::Internal::AnyHash)
         end
 
+      # An array of guardrail metrics that the model input and output pair will be
+      # evaluated on. For non-enterprise users, these will be limited to `correctness`,
+      # `completeness`, `instruction_adherence`, `context_adherence`,
+      # `ground_truth_adherence`, and/or `comprehensive_safety`.
+      sig do
+        returns(
+          T::Array[Deeprails::MonitorCreateParams::GuardrailMetric::OrSymbol]
+        )
+      end
+      attr_accessor :guardrail_metrics
+
       # Name of the new monitor.
       sig { returns(String) }
       attr_accessor :name
@@ -22,18 +33,47 @@ module Deeprails
       sig { params(description: String).void }
       attr_writer :description
 
+      # An array of file IDs to search in the monitor's evaluations. Files must be
+      # uploaded via the DeepRails API first.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :file_search
+
+      sig { params(file_search: T::Array[String]).void }
+      attr_writer :file_search
+
+      # Whether to enable web search for this monitor's evaluations. Defaults to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :web_search
+
+      sig { params(web_search: T::Boolean).void }
+      attr_writer :web_search
+
       sig do
         params(
+          guardrail_metrics:
+            T::Array[Deeprails::MonitorCreateParams::GuardrailMetric::OrSymbol],
           name: String,
           description: String,
+          file_search: T::Array[String],
+          web_search: T::Boolean,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # An array of guardrail metrics that the model input and output pair will be
+        # evaluated on. For non-enterprise users, these will be limited to `correctness`,
+        # `completeness`, `instruction_adherence`, `context_adherence`,
+        # `ground_truth_adherence`, and/or `comprehensive_safety`.
+        guardrail_metrics:,
         # Name of the new monitor.
         name:,
         # Description of the new monitor.
         description: nil,
+        # An array of file IDs to search in the monitor's evaluations. Files must be
+        # uploaded via the DeepRails API first.
+        file_search: nil,
+        # Whether to enable web search for this monitor's evaluations. Defaults to false.
+        web_search: nil,
         request_options: {}
       )
       end
@@ -41,14 +81,71 @@ module Deeprails
       sig do
         override.returns(
           {
+            guardrail_metrics:
+              T::Array[
+                Deeprails::MonitorCreateParams::GuardrailMetric::OrSymbol
+              ],
             name: String,
             description: String,
+            file_search: T::Array[String],
+            web_search: T::Boolean,
             request_options: Deeprails::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      module GuardrailMetric
+        extend Deeprails::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Deeprails::MonitorCreateParams::GuardrailMetric)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CORRECTNESS =
+          T.let(
+            :correctness,
+            Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+          )
+        COMPLETENESS =
+          T.let(
+            :completeness,
+            Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+          )
+        INSTRUCTION_ADHERENCE =
+          T.let(
+            :instruction_adherence,
+            Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+          )
+        CONTEXT_ADHERENCE =
+          T.let(
+            :context_adherence,
+            Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+          )
+        GROUND_TRUTH_ADHERENCE =
+          T.let(
+            :ground_truth_adherence,
+            Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+          )
+        COMPREHENSIVE_SAFETY =
+          T.let(
+            :comprehensive_safety,
+            Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Deeprails::MonitorCreateParams::GuardrailMetric::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/deeprails/models/monitor_submit_event_params.rbi

@@ -14,19 +14,6 @@ module Deeprails
           )
         end
 
-      # An array of guardrail metrics that the model input and output pair will be
-      # evaluated on. For non-enterprise users, these will be limited to `correctness`,
-      # `completeness`, `instruction_adherence`, `context_adherence`,
-      # `ground_truth_adherence`, and/or `comprehensive_safety`.
-      sig do
-        returns(
-          T::Array[
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::OrSymbol
-          ]
-        )
-      end
-      attr_accessor :guardrail_metrics
-
       # 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.
@@ -44,13 +31,6 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :model_output
 
-      # Model ID used to generate the output, like `gpt-4o` or `o3`.
-      sig { returns(T.nilable(String)) }
-      attr_reader :model_used
-
-      sig { params(model_used: String).void }
-      attr_writer :model_used
-
       # An optional, user-defined tag for the event.
       sig { returns(T.nilable(String)) }
       attr_reader :nametag
@@ -78,32 +58,20 @@ module Deeprails
 
       sig do
         params(
-          guardrail_metrics:
-            T::Array[
-              Deeprails::MonitorSubmitEventParams::GuardrailMetric::OrSymbol
-            ],
           model_input: Deeprails::MonitorSubmitEventParams::ModelInput::OrHash,
           model_output: String,
-          model_used: String,
           nametag: String,
           run_mode: Deeprails::MonitorSubmitEventParams::RunMode::OrSymbol,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # An array of guardrail metrics that the model input and output pair will be
-        # evaluated on. For non-enterprise users, these will be limited to `correctness`,
-        # `completeness`, `instruction_adherence`, `context_adherence`,
-        # `ground_truth_adherence`, and/or `comprehensive_safety`.
-        guardrail_metrics:,
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
-        # Model ID used to generate the output, like `gpt-4o` or `o3`.
-        model_used: nil,
         # An optional, user-defined tag for the event.
         nametag: nil,
         # Run mode for the monitor event. The run mode allows the user to optimize for
@@ -118,13 +86,8 @@ module Deeprails
       sig do
         override.returns(
           {
-            guardrail_metrics:
-              T::Array[
-                Deeprails::MonitorSubmitEventParams::GuardrailMetric::OrSymbol
-              ],
             model_input: Deeprails::MonitorSubmitEventParams::ModelInput,
             model_output: String,
-            model_used: String,
             nametag: String,
             run_mode: Deeprails::MonitorSubmitEventParams::RunMode::OrSymbol,
             request_options: Deeprails::RequestOptions
@@ -134,57 +97,6 @@ module Deeprails
       def to_hash
       end
 
-      module GuardrailMetric
-        extend Deeprails::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Deeprails::MonitorSubmitEventParams::GuardrailMetric)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        CORRECTNESS =
-          T.let(
-            :correctness,
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-          )
-        COMPLETENESS =
-          T.let(
-            :completeness,
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-          )
-        INSTRUCTION_ADHERENCE =
-          T.let(
-            :instruction_adherence,
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-          )
-        CONTEXT_ADHERENCE =
-          T.let(
-            :context_adherence,
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-          )
-        GROUND_TRUTH_ADHERENCE =
-          T.let(
-            :ground_truth_adherence,
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-          )
-        COMPREHENSIVE_SAFETY =
-          T.let(
-            :comprehensive_safety,
-            Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Deeprails::MonitorSubmitEventParams::GuardrailMetric::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
       class ModelInput < Deeprails::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/deeprails/models.rbi

@@ -13,6 +13,10 @@ module Deeprails
 
   DefendUpdateWorkflowParams = Deeprails::Models::DefendUpdateWorkflowParams
 
+  FileResponse = Deeprails::Models::FileResponse
+
+  FileUploadParams = Deeprails::Models::FileUploadParams
+
   MonitorCreateParams = Deeprails::Models::MonitorCreateParams
 
   MonitorDetailResponse = Deeprails::Models::MonitorDetailResponse

data/rbi/deeprails/resources/defend.rbi

@@ -18,7 +18,9 @@ module Deeprails
             ],
           custom_hallucination_threshold_values: T::Hash[Symbol, Float],
           description: String,
+          file_search: T::Array[String],
           max_improvement_attempts: Integer,
+          web_search: T::Boolean,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::DefendResponse)
       end
@@ -48,9 +50,14 @@ module Deeprails
         custom_hallucination_threshold_values: nil,
         # Description for the workflow.
         description: nil,
+        # An array of file IDs to search in the workflow's evaluations. Files must be
+        # uploaded via the DeepRails API first.
+        file_search: nil,
         # Max. number of improvement action retries until a given event passes the
         # guardrails. Defaults to 10.
         max_improvement_attempts: nil,
+        # Whether to enable web search for this workflow's evaluations. Defaults to false.
+        web_search: nil,
         request_options: {}
       )
       end

data/rbi/deeprails/resources/files.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Deeprails
+  module Resources
+    class Files
+      # Use this endpoint to upload a file to the DeepRails API
+      sig do
+        params(
+          file: Deeprails::Internal::FileInput,
+          request_options: Deeprails::RequestOptions::OrHash
+        ).returns(Deeprails::FileResponse)
+      end
+      def upload(
+        # The contents of the file to upload.
+        file:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Deeprails::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/deeprails/resources/monitor.rbi

@@ -7,16 +7,30 @@ module Deeprails
       # using guardrails
       sig do
         params(
+          guardrail_metrics:
+            T::Array[Deeprails::MonitorCreateParams::GuardrailMetric::OrSymbol],
           name: String,
           description: String,
+          file_search: T::Array[String],
+          web_search: T::Boolean,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::MonitorResponse)
       end
       def create(
+        # An array of guardrail metrics that the model input and output pair will be
+        # evaluated on. For non-enterprise users, these will be limited to `correctness`,
+        # `completeness`, `instruction_adherence`, `context_adherence`,
+        # `ground_truth_adherence`, and/or `comprehensive_safety`.
+        guardrail_metrics:,
         # Name of the new monitor.
         name:,
         # Description of the new monitor.
         description: nil,
+        # An array of file IDs to search in the monitor's evaluations. Files must be
+        # uploaded via the DeepRails API first.
+        file_search: nil,
+        # Whether to enable web search for this monitor's evaluations. Defaults to false.
+        web_search: nil,
         request_options: {}
       )
       end
@@ -70,13 +84,8 @@ module Deeprails
       sig do
         params(
           monitor_id: String,
-          guardrail_metrics:
-            T::Array[
-              Deeprails::MonitorSubmitEventParams::GuardrailMetric::OrSymbol
-            ],
           model_input: Deeprails::MonitorSubmitEventParams::ModelInput::OrHash,
           model_output: String,
-          model_used: String,
           nametag: String,
           run_mode: Deeprails::MonitorSubmitEventParams::RunMode::OrSymbol,
           request_options: Deeprails::RequestOptions::OrHash
@@ -85,19 +94,12 @@ module Deeprails
       def submit_event(
         # The ID of the monitor associated with this event.
         monitor_id,
-        # An array of guardrail metrics that the model input and output pair will be
-        # evaluated on. For non-enterprise users, these will be limited to `correctness`,
-        # `completeness`, `instruction_adherence`, `context_adherence`,
-        # `ground_truth_adherence`, and/or `comprehensive_safety`.
-        guardrail_metrics:,
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,
-        # Model ID used to generate the output, like `gpt-4o` or `o3`.
-        model_used: nil,
         # An optional, user-defined tag for the event.
         nametag: nil,
         # Run mode for the monitor event. The run mode allows the user to optimize for

data/sig/deeprails/client.rbs

@@ -14,6 +14,8 @@ module Deeprails
 
     attr_reader monitor: Deeprails::Resources::Monitor
 
+    attr_reader files: Deeprails::Resources::Files
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/deeprails/models/defend_create_workflow_params.rbs

@@ -8,7 +8,9 @@ module Deeprails
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level],
         custom_hallucination_threshold_values: ::Hash[Symbol, Float],
         description: String,
-        max_improvement_attempts: Integer
+        file_search: ::Array[String],
+        max_improvement_attempts: Integer,
+        web_search: bool
       }
       & Deeprails::Internal::Type::request_parameters
 
@@ -38,10 +40,18 @@ module Deeprails
 
       def description=: (String) -> String
 
+      attr_reader file_search: ::Array[String]?
+
+      def file_search=: (::Array[String]) -> ::Array[String]
+
       attr_reader max_improvement_attempts: Integer?
 
       def max_improvement_attempts=: (Integer) -> Integer
 
+      attr_reader web_search: bool?
+
+      def web_search=: (bool) -> bool
+
       def initialize: (
         improvement_action: Deeprails::Models::DefendCreateWorkflowParams::improvement_action,
         name: String,
@@ -49,7 +59,9 @@ module Deeprails
         ?automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level],
         ?custom_hallucination_threshold_values: ::Hash[Symbol, Float],
         ?description: String,
+        ?file_search: ::Array[String],
         ?max_improvement_attempts: Integer,
+        ?web_search: bool,
         ?request_options: Deeprails::request_opts
       ) -> void
 
@@ -60,7 +72,9 @@ module Deeprails
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::DefendCreateWorkflowParams::automatic_hallucination_tolerance_level],
         custom_hallucination_threshold_values: ::Hash[Symbol, Float],
         description: String,
+        file_search: ::Array[String],
         max_improvement_attempts: Integer,
+        web_search: bool,
         request_options: Deeprails::RequestOptions
       }
 

data/sig/deeprails/models/file_response.rbs

@@ -0,0 +1,50 @@
+module Deeprails
+  module Models
+    type file_response =
+      {
+        created_at: Time,
+        file_id: String,
+        file_name: String,
+        file_path: String,
+        updated_at: Time
+      }
+
+    class FileResponse < Deeprails::Internal::Type::BaseModel
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_reader file_id: String?
+
+      def file_id=: (String) -> String
+
+      attr_reader file_name: String?
+
+      def file_name=: (String) -> String
+
+      attr_reader file_path: String?
+
+      def file_path=: (String) -> String
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      def initialize: (
+        ?created_at: Time,
+        ?file_id: String,
+        ?file_name: String,
+        ?file_path: String,
+        ?updated_at: Time
+      ) -> void
+
+      def to_hash: -> {
+        created_at: Time,
+        file_id: String,
+        file_name: String,
+        file_path: String,
+        updated_at: Time
+      }
+    end
+  end
+end

data/sig/deeprails/models/file_upload_params.rbs

@@ -0,0 +1,24 @@
+module Deeprails
+  module Models
+    type file_upload_params =
+      { file: Deeprails::Internal::file_input }
+      & Deeprails::Internal::Type::request_parameters
+
+    class FileUploadParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      attr_accessor file: Deeprails::Internal::file_input
+
+      def initialize: (
+        file: Deeprails::Internal::file_input,
+        ?request_options: Deeprails::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        file: Deeprails::Internal::file_input,
+        request_options: Deeprails::RequestOptions
+      }
+    end
+  end
+end

data/sig/deeprails/models/monitor_create_params.rbs

@@ -1,30 +1,73 @@
 module Deeprails
   module Models
     type monitor_create_params =
-      { name: String, description: String }
+      {
+        guardrail_metrics: ::Array[Deeprails::Models::MonitorCreateParams::guardrail_metric],
+        name: String,
+        description: String,
+        file_search: ::Array[String],
+        web_search: bool
+      }
       & Deeprails::Internal::Type::request_parameters
 
     class MonitorCreateParams < Deeprails::Internal::Type::BaseModel
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
+      attr_accessor guardrail_metrics: ::Array[Deeprails::Models::MonitorCreateParams::guardrail_metric]
+
       attr_accessor name: String
 
       attr_reader description: String?
 
       def description=: (String) -> String
 
+      attr_reader file_search: ::Array[String]?
+
+      def file_search=: (::Array[String]) -> ::Array[String]
+
+      attr_reader web_search: bool?
+
+      def web_search=: (bool) -> bool
+
       def initialize: (
+        guardrail_metrics: ::Array[Deeprails::Models::MonitorCreateParams::guardrail_metric],
         name: String,
         ?description: String,
+        ?file_search: ::Array[String],
+        ?web_search: bool,
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
+        guardrail_metrics: ::Array[Deeprails::Models::MonitorCreateParams::guardrail_metric],
         name: String,
         description: String,
+        file_search: ::Array[String],
+        web_search: bool,
         request_options: Deeprails::RequestOptions
       }
+
+      type guardrail_metric =
+        :correctness
+        | :completeness
+        | :instruction_adherence
+        | :context_adherence
+        | :ground_truth_adherence
+        | :comprehensive_safety
+
+      module GuardrailMetric
+        extend Deeprails::Internal::Type::Enum
+
+        CORRECTNESS: :correctness
+        COMPLETENESS: :completeness
+        INSTRUCTION_ADHERENCE: :instruction_adherence
+        CONTEXT_ADHERENCE: :context_adherence
+        GROUND_TRUTH_ADHERENCE: :ground_truth_adherence
+        COMPREHENSIVE_SAFETY: :comprehensive_safety
+
+        def self?.values: -> ::Array[Deeprails::Models::MonitorCreateParams::guardrail_metric]
+      end
     end
   end
 end