deeprails 0.6.0 → 0.8.0

data/rbi/deeprails/models/monitor_response.rbi

@@ -0,0 +1,142 @@
+# typed: strong
+
+module Deeprails
+  module Models
+    class MonitorResponse < Deeprails::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Deeprails::MonitorResponse, Deeprails::Internal::AnyHash)
+        end
+
+      # A unique monitor ID.
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
+      # Name of the monitor.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The time the monitor was created in UTC.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # Description of the monitor.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      sig do
+        returns(
+          T.nilable(Deeprails::MonitorResponse::MonitorStatus::TaggedSymbol)
+        )
+      end
+      attr_reader :monitor_status
+
+      sig do
+        params(
+          monitor_status: Deeprails::MonitorResponse::MonitorStatus::OrSymbol
+        ).void
+      end
+      attr_writer :monitor_status
+
+      # The most recent time the monitor was modified in UTC.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: Time).void }
+      attr_writer :updated_at
+
+      # User ID of the user who created the monitor.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_id
+
+      sig { params(user_id: String).void }
+      attr_writer :user_id
+
+      sig do
+        params(
+          monitor_id: String,
+          name: String,
+          created_at: Time,
+          description: String,
+          monitor_status: Deeprails::MonitorResponse::MonitorStatus::OrSymbol,
+          updated_at: Time,
+          user_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique monitor ID.
+        monitor_id:,
+        # Name of the monitor.
+        name:,
+        # The time the monitor was created in UTC.
+        created_at: nil,
+        # Description of the monitor.
+        description: nil,
+        # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+        # longer record and evaluate events.
+        monitor_status: nil,
+        # The most recent time the monitor was modified in UTC.
+        updated_at: nil,
+        # User ID of the user who created the monitor.
+        user_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            monitor_id: String,
+            name: String,
+            created_at: Time,
+            description: String,
+            monitor_status:
+              Deeprails::MonitorResponse::MonitorStatus::TaggedSymbol,
+            updated_at: Time,
+            user_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      module MonitorStatus
+        extend Deeprails::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Deeprails::MonitorResponse::MonitorStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Deeprails::MonitorResponse::MonitorStatus::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            Deeprails::MonitorResponse::MonitorStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Deeprails::MonitorResponse::MonitorStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/deeprails/models/monitor_submit_event_params.rbi

@@ -28,8 +28,8 @@ module Deeprails
       attr_accessor :guardrail_metrics
 
       # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      # contain at least a `user_prompt` or `system_prompt` field. For
-      # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+      # contain at least a `user_prompt` field or a `system_prompt` field. For
+      # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
       sig { returns(Deeprails::MonitorSubmitEventParams::ModelInput) }
       attr_reader :model_input
 
@@ -97,8 +97,8 @@ module Deeprails
         # `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` or `system_prompt` field. For
-        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        # 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:,
@@ -216,8 +216,8 @@ module Deeprails
         attr_writer :user_prompt
 
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least a `user_prompt` or `system_prompt` field. For
-        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        # contain at least a `user_prompt` field or a `system_prompt` field. For
+        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
         sig do
           params(
             ground_truth: String,

data/rbi/deeprails/models.rbi

@@ -1,8 +1,6 @@
 # typed: strong
 
 module Deeprails
-  APIResponse = Deeprails::Models::APIResponse
-
   DefendCreateWorkflowParams = Deeprails::Models::DefendCreateWorkflowParams
 
   DefendResponse = Deeprails::Models::DefendResponse
@@ -23,6 +21,12 @@ module Deeprails
 
   MonitorCreateParams = Deeprails::Models::MonitorCreateParams
 
+  MonitorDetailResponse = Deeprails::Models::MonitorDetailResponse
+
+  MonitorEventResponse = Deeprails::Models::MonitorEventResponse
+
+  MonitorResponse = Deeprails::Models::MonitorResponse
+
   MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
 
   MonitorSubmitEventParams = Deeprails::Models::MonitorSubmitEventParams

data/rbi/deeprails/resources/defend.rbi

@@ -18,7 +18,7 @@ module Deeprails
             ],
           custom_hallucination_threshold_values: T::Hash[Symbol, Float],
           description: String,
-          max_improvement_attempt: Integer,
+          max_improvement_attempts: Integer,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::DefendResponse)
       end
@@ -50,7 +50,7 @@ module Deeprails
         description: nil,
         # Max. number of improvement action retries until a given event passes the
         # guardrails. Defaults to 10.
-        max_improvement_attempt: nil,
+        max_improvement_attempts: nil,
         request_options: {}
       )
       end
@@ -103,8 +103,8 @@ module Deeprails
         # Workflow ID associated with this event.
         workflow_id,
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least `user_prompt` or `system_prompt` field. For
-        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        # contain at least a `user_prompt` field or a `system_prompt` field. For the
+        # ground_truth_adherence guardrail metric, `ground_truth` should be provided.
         model_input:,
         # Output generated by the LLM to be evaluated.
         model_output:,

data/rbi/deeprails/resources/evaluate.rbi

@@ -21,8 +21,8 @@ module Deeprails
       end
       def create(
         # A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        # contain at least `user_prompt` or `system_prompt` field. For
-        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        # 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:,

data/rbi/deeprails/resources/monitor.rbi

@@ -10,7 +10,7 @@ module Deeprails
           name: String,
           description: String,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::APIResponse)
+        ).returns(Deeprails::MonitorResponse)
       end
       def create(
         # Name of the new monitor.
@@ -28,7 +28,7 @@ module Deeprails
           monitor_id: String,
           limit: Integer,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::Models::MonitorRetrieveResponse)
+        ).returns(Deeprails::MonitorDetailResponse)
       end
       def retrieve(
         # The ID of the monitor to retrieve.
@@ -49,7 +49,7 @@ module Deeprails
             Deeprails::MonitorUpdateParams::MonitorStatus::OrSymbol,
           name: String,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::APIResponse)
+        ).returns(Deeprails::MonitorResponse)
       end
       def update(
         # The ID of the monitor to edit.
@@ -80,7 +80,7 @@ module Deeprails
           nametag: String,
           run_mode: Deeprails::MonitorSubmitEventParams::RunMode::OrSymbol,
           request_options: Deeprails::RequestOptions::OrHash
-        ).returns(Deeprails::Models::MonitorSubmitEventResponse)
+        ).returns(Deeprails::MonitorEventResponse)
       end
       def submit_event(
         # The ID of the monitor associated with this event.
@@ -91,8 +91,8 @@ module Deeprails
         # `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` or `system_prompt` field. For
-        # ground_truth_aherence guadrail metric, `ground_truth` should be provided.
+        # 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:,

data/sig/deeprails/models/defend_create_workflow_params.rbs

@@ -8,7 +8,7 @@ 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_attempt: Integer
+        max_improvement_attempts: Integer
       }
       & Deeprails::Internal::Type::request_parameters
 
@@ -38,9 +38,9 @@ module Deeprails
 
       def description=: (String) -> String
 
-      attr_reader max_improvement_attempt: Integer?
+      attr_reader max_improvement_attempts: Integer?
 
-      def max_improvement_attempt=: (Integer) -> Integer
+      def max_improvement_attempts=: (Integer) -> Integer
 
       def initialize: (
         improvement_action: Deeprails::Models::DefendCreateWorkflowParams::improvement_action,
@@ -49,7 +49,7 @@ 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_attempt: Integer,
+        ?max_improvement_attempts: Integer,
         ?request_options: Deeprails::request_opts
       ) -> void
 
@@ -60,7 +60,7 @@ 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_attempt: Integer,
+        max_improvement_attempts: Integer,
         request_options: Deeprails::RequestOptions
       }
 

data/sig/deeprails/models/defend_response.rbs

@@ -7,7 +7,7 @@ module Deeprails
         created_at: Time,
         description: String,
         improvement_action: Deeprails::Models::DefendResponse::improvement_action,
-        max_improvement_attempt: Integer,
+        max_improvement_attempts: Integer,
         modified_at: Time,
         status: Deeprails::Models::DefendResponse::status,
         success_rate: Float
@@ -32,9 +32,9 @@ module Deeprails
         Deeprails::Models::DefendResponse::improvement_action
       ) -> Deeprails::Models::DefendResponse::improvement_action
 
-      attr_reader max_improvement_attempt: Integer?
+      attr_reader max_improvement_attempts: Integer?
 
-      def max_improvement_attempt=: (Integer) -> Integer
+      def max_improvement_attempts=: (Integer) -> Integer
 
       attr_reader modified_at: Time?
 
@@ -56,7 +56,7 @@ module Deeprails
         ?created_at: Time,
         ?description: String,
         ?improvement_action: Deeprails::Models::DefendResponse::improvement_action,
-        ?max_improvement_attempt: Integer,
+        ?max_improvement_attempts: Integer,
         ?modified_at: Time,
         ?status: Deeprails::Models::DefendResponse::status,
         ?success_rate: Float
@@ -68,7 +68,7 @@ module Deeprails
         created_at: Time,
         description: String,
         improvement_action: Deeprails::Models::DefendResponse::improvement_action,
-        max_improvement_attempt: Integer,
+        max_improvement_attempts: Integer,
         modified_at: Time,
         status: Deeprails::Models::DefendResponse::status,
         success_rate: Float

data/sig/deeprails/models/monitor_detail_response.rbs

@@ -0,0 +1,134 @@
+module Deeprails
+  module Models
+    type monitor_detail_response =
+      {
+        monitor_id: String,
+        monitor_status: Deeprails::Models::MonitorDetailResponse::monitor_status,
+        name: String,
+        created_at: Time,
+        description: String,
+        evaluations: ::Array[Deeprails::Evaluation],
+        stats: Deeprails::MonitorDetailResponse::Stats,
+        updated_at: Time,
+        user_id: String
+      }
+
+    class MonitorDetailResponse < Deeprails::Internal::Type::BaseModel
+      attr_accessor monitor_id: String
+
+      attr_accessor monitor_status: Deeprails::Models::MonitorDetailResponse::monitor_status
+
+      attr_accessor name: String
+
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader evaluations: ::Array[Deeprails::Evaluation]?
+
+      def evaluations=: (
+        ::Array[Deeprails::Evaluation]
+      ) -> ::Array[Deeprails::Evaluation]
+
+      attr_reader stats: Deeprails::MonitorDetailResponse::Stats?
+
+      def stats=: (
+        Deeprails::MonitorDetailResponse::Stats
+      ) -> Deeprails::MonitorDetailResponse::Stats
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      attr_reader user_id: String?
+
+      def user_id=: (String) -> String
+
+      def initialize: (
+        monitor_id: String,
+        monitor_status: Deeprails::Models::MonitorDetailResponse::monitor_status,
+        name: String,
+        ?created_at: Time,
+        ?description: String,
+        ?evaluations: ::Array[Deeprails::Evaluation],
+        ?stats: Deeprails::MonitorDetailResponse::Stats,
+        ?updated_at: Time,
+        ?user_id: String
+      ) -> void
+
+      def to_hash: -> {
+        monitor_id: String,
+        monitor_status: Deeprails::Models::MonitorDetailResponse::monitor_status,
+        name: String,
+        created_at: Time,
+        description: String,
+        evaluations: ::Array[Deeprails::Evaluation],
+        stats: Deeprails::MonitorDetailResponse::Stats,
+        updated_at: Time,
+        user_id: String
+      }
+
+      type monitor_status = :active | :inactive
+
+      module MonitorStatus
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE: :active
+        INACTIVE: :inactive
+
+        def self?.values: -> ::Array[Deeprails::Models::MonitorDetailResponse::monitor_status]
+      end
+
+      type stats =
+        {
+          completed_evaluations: Integer,
+          failed_evaluations: Integer,
+          in_progress_evaluations: Integer,
+          queued_evaluations: Integer,
+          total_evaluations: Integer
+        }
+
+      class Stats < Deeprails::Internal::Type::BaseModel
+        attr_reader completed_evaluations: Integer?
+
+        def completed_evaluations=: (Integer) -> Integer
+
+        attr_reader failed_evaluations: Integer?
+
+        def failed_evaluations=: (Integer) -> Integer
+
+        attr_reader in_progress_evaluations: Integer?
+
+        def in_progress_evaluations=: (Integer) -> Integer
+
+        attr_reader queued_evaluations: Integer?
+
+        def queued_evaluations=: (Integer) -> Integer
+
+        attr_reader total_evaluations: Integer?
+
+        def total_evaluations=: (Integer) -> Integer
+
+        def initialize: (
+          ?completed_evaluations: Integer,
+          ?failed_evaluations: Integer,
+          ?in_progress_evaluations: Integer,
+          ?queued_evaluations: Integer,
+          ?total_evaluations: Integer
+        ) -> void
+
+        def to_hash: -> {
+          completed_evaluations: Integer,
+          failed_evaluations: Integer,
+          in_progress_evaluations: Integer,
+          queued_evaluations: Integer,
+          total_evaluations: Integer
+        }
+      end
+    end
+  end
+end

data/sig/deeprails/models/monitor_event_response.rbs

@@ -0,0 +1,37 @@
+module Deeprails
+  module Models
+    type monitor_event_response =
+      {
+        evaluation_id: String,
+        event_id: String,
+        monitor_id: String,
+        created_at: Time
+      }
+
+    class MonitorEventResponse < Deeprails::Internal::Type::BaseModel
+      attr_accessor evaluation_id: String
+
+      attr_accessor event_id: String
+
+      attr_accessor monitor_id: String
+
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      def initialize: (
+        evaluation_id: String,
+        event_id: String,
+        monitor_id: String,
+        ?created_at: Time
+      ) -> void
+
+      def to_hash: -> {
+        evaluation_id: String,
+        event_id: String,
+        monitor_id: String,
+        created_at: Time
+      }
+    end
+  end
+end

data/sig/deeprails/models/monitor_response.rbs

@@ -0,0 +1,73 @@
+module Deeprails
+  module Models
+    type monitor_response =
+      {
+        monitor_id: String,
+        name: String,
+        created_at: Time,
+        description: String,
+        monitor_status: Deeprails::Models::MonitorResponse::monitor_status,
+        updated_at: Time,
+        user_id: String
+      }
+
+    class MonitorResponse < Deeprails::Internal::Type::BaseModel
+      attr_accessor monitor_id: String
+
+      attr_accessor name: String
+
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader monitor_status: Deeprails::Models::MonitorResponse::monitor_status?
+
+      def monitor_status=: (
+        Deeprails::Models::MonitorResponse::monitor_status
+      ) -> Deeprails::Models::MonitorResponse::monitor_status
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      attr_reader user_id: String?
+
+      def user_id=: (String) -> String
+
+      def initialize: (
+        monitor_id: String,
+        name: String,
+        ?created_at: Time,
+        ?description: String,
+        ?monitor_status: Deeprails::Models::MonitorResponse::monitor_status,
+        ?updated_at: Time,
+        ?user_id: String
+      ) -> void
+
+      def to_hash: -> {
+        monitor_id: String,
+        name: String,
+        created_at: Time,
+        description: String,
+        monitor_status: Deeprails::Models::MonitorResponse::monitor_status,
+        updated_at: Time,
+        user_id: String
+      }
+
+      type monitor_status = :active | :inactive
+
+      module MonitorStatus
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE: :active
+        INACTIVE: :inactive
+
+        def self?.values: -> ::Array[Deeprails::Models::MonitorResponse::monitor_status]
+      end
+    end
+  end
+end

data/sig/deeprails/models.rbs

@@ -1,6 +1,4 @@
 module Deeprails
-  class APIResponse = Deeprails::Models::APIResponse
-
   class DefendCreateWorkflowParams = Deeprails::Models::DefendCreateWorkflowParams
 
   class DefendResponse = Deeprails::Models::DefendResponse
@@ -21,6 +19,12 @@ module Deeprails
 
   class MonitorCreateParams = Deeprails::Models::MonitorCreateParams
 
+  class MonitorDetailResponse = Deeprails::Models::MonitorDetailResponse
+
+  class MonitorEventResponse = Deeprails::Models::MonitorEventResponse
+
+  class MonitorResponse = Deeprails::Models::MonitorResponse
+
   class MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
 
   class MonitorSubmitEventParams = Deeprails::Models::MonitorSubmitEventParams

data/sig/deeprails/resources/defend.rbs

@@ -8,7 +8,7 @@ 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_attempt: Integer,
+        ?max_improvement_attempts: Integer,
         ?request_options: Deeprails::request_opts
       ) -> Deeprails::DefendResponse
 

data/sig/deeprails/resources/monitor.rbs

@@ -5,13 +5,13 @@ module Deeprails
         name: String,
         ?description: String,
         ?request_options: Deeprails::request_opts
-      ) -> Deeprails::APIResponse
+      ) -> Deeprails::MonitorResponse
 
       def retrieve: (
         String monitor_id,
         ?limit: Integer,
         ?request_options: Deeprails::request_opts
-      ) -> Deeprails::Models::MonitorRetrieveResponse
+      ) -> Deeprails::MonitorDetailResponse
 
       def update: (
         String monitor_id,
@@ -19,7 +19,7 @@ module Deeprails
         ?monitor_status: Deeprails::Models::MonitorUpdateParams::monitor_status,
         ?name: String,
         ?request_options: Deeprails::request_opts
-      ) -> Deeprails::APIResponse
+      ) -> Deeprails::MonitorResponse
 
       def submit_event: (
         String monitor_id,
@@ -30,7 +30,7 @@ module Deeprails
         ?nametag: String,
         ?run_mode: Deeprails::Models::MonitorSubmitEventParams::run_mode,
         ?request_options: Deeprails::request_opts
-      ) -> Deeprails::Models::MonitorSubmitEventResponse
+      ) -> Deeprails::MonitorEventResponse
 
       def initialize: (client: Deeprails::Client) -> void
     end