deeprails 0.6.0 → 0.8.0

data/lib/deeprails/resources/defend.rb

@@ -9,7 +9,7 @@ module Deeprails
       # Use this endpoint to create a new guardrail workflow with optional guardrail
       # thresholds and improvement actions
       #
-      # @overload create_workflow(improvement_action:, name:, type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, max_improvement_attempt: nil, request_options: {})
+      # @overload create_workflow(improvement_action:, name:, type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, max_improvement_attempts: nil, request_options: {})
       #
       # @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or guardrail metrics for the wo
       #
@@ -23,7 +23,7 @@ module Deeprails
       #
       # @param description [String] Description for the workflow.
       #
-      # @param max_improvement_attempt [Integer] Max. number of improvement action retries until a given event passes the guardra
+      # @param max_improvement_attempts [Integer] Max. number of improvement action retries until a given event passes the guardra
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/deeprails/resources/monitor.rb

@@ -14,7 +14,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::APIResponse]
+      # @return [Deeprails::Models::MonitorResponse]
       #
       # @see Deeprails::Models::MonitorCreateParams
       def create(params)
@@ -23,7 +23,7 @@ module Deeprails
           method: :post,
           path: "monitor",
           body: parsed,
-          model: Deeprails::APIResponse,
+          model: Deeprails::MonitorResponse,
           options: options
         )
       end
@@ -39,7 +39,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::MonitorRetrieveResponse]
+      # @return [Deeprails::Models::MonitorDetailResponse]
       #
       # @see Deeprails::Models::MonitorRetrieveParams
       def retrieve(monitor_id, params = {})
@@ -48,7 +48,7 @@ module Deeprails
           method: :get,
           path: ["monitor/%1$s", monitor_id],
           query: parsed,
-          model: Deeprails::Models::MonitorRetrieveResponse,
+          model: Deeprails::MonitorDetailResponse,
           options: options
         )
       end
@@ -71,7 +71,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::APIResponse]
+      # @return [Deeprails::Models::MonitorResponse]
       #
       # @see Deeprails::Models::MonitorUpdateParams
       def update(monitor_id, params = {})
@@ -80,7 +80,7 @@ module Deeprails
           method: :put,
           path: ["monitor/%1$s", monitor_id],
           body: parsed,
-          model: Deeprails::APIResponse,
+          model: Deeprails::MonitorResponse,
           options: options
         )
       end
@@ -109,7 +109,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::MonitorSubmitEventResponse]
+      # @return [Deeprails::Models::MonitorEventResponse]
       #
       # @see Deeprails::Models::MonitorSubmitEventParams
       def submit_event(monitor_id, params)
@@ -118,7 +118,7 @@ module Deeprails
           method: :post,
           path: ["monitor/%1$s/events", monitor_id],
           body: parsed,
-          model: Deeprails::Models::MonitorSubmitEventResponse,
+          model: Deeprails::MonitorEventResponse,
           options: options
         )
       end

data/lib/deeprails/version.rb

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

data/lib/deeprails.rb

@@ -50,7 +50,6 @@ 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/models/api_response"
 require_relative "deeprails/models/defend_create_workflow_params"
 require_relative "deeprails/models/defend_response"
 require_relative "deeprails/models/defend_retrieve_event_params"
@@ -61,10 +60,11 @@ require_relative "deeprails/models/evaluate_create_params"
 require_relative "deeprails/models/evaluate_retrieve_params"
 require_relative "deeprails/models/evaluation"
 require_relative "deeprails/models/monitor_create_params"
+require_relative "deeprails/models/monitor_detail_response"
+require_relative "deeprails/models/monitor_event_response"
+require_relative "deeprails/models/monitor_response"
 require_relative "deeprails/models/monitor_retrieve_params"
-require_relative "deeprails/models/monitor_retrieve_response"
 require_relative "deeprails/models/monitor_submit_event_params"
-require_relative "deeprails/models/monitor_submit_event_response"
 require_relative "deeprails/models/monitor_update_params"
 require_relative "deeprails/models/workflow_event_response"
 require_relative "deeprails/models"

data/rbi/deeprails/models/defend_create_workflow_params.rbi

@@ -88,10 +88,10 @@ module Deeprails
       # Max. number of improvement action retries until a given event passes the
       # guardrails. Defaults to 10.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_improvement_attempt
+      attr_reader :max_improvement_attempts
 
-      sig { params(max_improvement_attempt: Integer).void }
-      attr_writer :max_improvement_attempt
+      sig { params(max_improvement_attempts: Integer).void }
+      attr_writer :max_improvement_attempts
 
       sig do
         params(
@@ -106,7 +106,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(T.attached_class)
       end
@@ -138,7 +138,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
@@ -157,7 +157,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
           }
         )

data/rbi/deeprails/models/defend_response.rbi

@@ -53,10 +53,10 @@ module Deeprails
       # Max. number of improvement action retries until a given event passes the
       # guardrails.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_improvement_attempt
+      attr_reader :max_improvement_attempts
 
-      sig { params(max_improvement_attempt: Integer).void }
-      attr_writer :max_improvement_attempt
+      sig { params(max_improvement_attempts: Integer).void }
+      attr_writer :max_improvement_attempts
 
       # The most recent time the workflow was modified in UTC.
       sig { returns(T.nilable(Time)) }
@@ -90,7 +90,7 @@ module Deeprails
           description: String,
           improvement_action:
             Deeprails::DefendResponse::ImprovementAction::OrSymbol,
-          max_improvement_attempt: Integer,
+          max_improvement_attempts: Integer,
           modified_at: Time,
           status: Deeprails::DefendResponse::Status::OrSymbol,
           success_rate: Float
@@ -113,7 +113,7 @@ module Deeprails
         improvement_action: nil,
         # Max. number of improvement action retries until a given event passes the
         # guardrails.
-        max_improvement_attempt: nil,
+        max_improvement_attempts: nil,
         # The most recent time the workflow was modified in UTC.
         modified_at: nil,
         # Status of the selected workflow. May be `inactive` or `active`. Inactive
@@ -133,7 +133,7 @@ module Deeprails
             description: String,
             improvement_action:
               Deeprails::DefendResponse::ImprovementAction::TaggedSymbol,
-            max_improvement_attempt: Integer,
+            max_improvement_attempts: Integer,
             modified_at: Time,
             status: Deeprails::DefendResponse::Status::TaggedSymbol,
             success_rate: Float

data/rbi/deeprails/models/defend_submit_event_params.rbi

@@ -15,8 +15,8 @@ module Deeprails
         end
 
       # 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.
       sig { returns(Deeprails::DefendSubmitEventParams::ModelInput) }
       attr_reader :model_input
 
@@ -61,8 +61,8 @@ module Deeprails
       end
       def self.new(
         # 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:,
@@ -103,7 +103,7 @@ module Deeprails
             )
           end
 
-        # The ground truth for evaluating Ground Truth Adherence guardrail.
+        # The ground truth for evaluating the Ground Truth Adherence guardrail.
         sig { returns(T.nilable(String)) }
         attr_reader :ground_truth
 
@@ -125,8 +125,8 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(
             ground_truth: String,
@@ -135,7 +135,7 @@ module Deeprails
           ).returns(T.attached_class)
         end
         def self.new(
-          # The ground truth for evaluating Ground Truth Adherence guardrail.
+          # The ground truth for evaluating the Ground Truth Adherence guardrail.
           ground_truth: nil,
           # The system prompt used to generate the output.
           system_prompt: nil,

data/rbi/deeprails/models/evaluate_create_params.rbi

@@ -12,8 +12,8 @@ module Deeprails
         end
 
       # 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.
       sig { returns(Deeprails::EvaluateCreateParams::ModelInput) }
       attr_reader :model_input
 
@@ -85,8 +85,8 @@ module Deeprails
       end
       def self.new(
         # 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:,
@@ -157,8 +157,8 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(
             ground_truth: String,

data/rbi/deeprails/models/evaluation.rbi

@@ -17,8 +17,8 @@ module Deeprails
       attr_accessor :evaluation_status
 
       # 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.
       sig { returns(Deeprails::Evaluation::ModelInput) }
       attr_reader :model_input
 
@@ -162,8 +162,8 @@ 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 `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:,
@@ -298,8 +298,8 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(
             ground_truth: String,

data/rbi/deeprails/models/monitor_detail_response.rbi

@@ -0,0 +1,251 @@
+# typed: strong
+
+module Deeprails
+  module Models
+    class MonitorDetailResponse < Deeprails::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Deeprails::MonitorDetailResponse, Deeprails::Internal::AnyHash)
+        end
+
+      # A unique monitor ID.
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      sig do
+        returns(Deeprails::MonitorDetailResponse::MonitorStatus::TaggedSymbol)
+      end
+      attr_accessor :monitor_status
+
+      # Name of this 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 this monitor.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # An array of all evaluations performed by this monitor. Each one corresponds to a
+      # separate monitor event.
+      sig { returns(T.nilable(T::Array[Deeprails::Evaluation])) }
+      attr_reader :evaluations
+
+      sig { params(evaluations: T::Array[Deeprails::Evaluation::OrHash]).void }
+      attr_writer :evaluations
+
+      # Contains five fields used for stats of this monitor: total evaluations,
+      # completed evaluations, failed evaluations, queued evaluations, and in progress
+      # evaluations.
+      sig { returns(T.nilable(Deeprails::MonitorDetailResponse::Stats)) }
+      attr_reader :stats
+
+      sig do
+        params(stats: Deeprails::MonitorDetailResponse::Stats::OrHash).void
+      end
+      attr_writer :stats
+
+      # 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,
+          monitor_status:
+            Deeprails::MonitorDetailResponse::MonitorStatus::OrSymbol,
+          name: String,
+          created_at: Time,
+          description: String,
+          evaluations: T::Array[Deeprails::Evaluation::OrHash],
+          stats: Deeprails::MonitorDetailResponse::Stats::OrHash,
+          updated_at: Time,
+          user_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique monitor ID.
+        monitor_id:,
+        # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+        # longer record and evaluate events.
+        monitor_status:,
+        # Name of this monitor.
+        name:,
+        # The time the monitor was created in UTC.
+        created_at: nil,
+        # Description of this monitor.
+        description: nil,
+        # An array of all evaluations performed by this monitor. Each one corresponds to a
+        # separate monitor event.
+        evaluations: nil,
+        # Contains five fields used for stats of this monitor: total evaluations,
+        # completed evaluations, failed evaluations, queued evaluations, and in progress
+        # evaluations.
+        stats: 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,
+            monitor_status:
+              Deeprails::MonitorDetailResponse::MonitorStatus::TaggedSymbol,
+            name: String,
+            created_at: Time,
+            description: String,
+            evaluations: T::Array[Deeprails::Evaluation],
+            stats: Deeprails::MonitorDetailResponse::Stats,
+            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::MonitorDetailResponse::MonitorStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            Deeprails::MonitorDetailResponse::MonitorStatus::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :inactive,
+            Deeprails::MonitorDetailResponse::MonitorStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Deeprails::MonitorDetailResponse::MonitorStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Stats < Deeprails::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Deeprails::MonitorDetailResponse::Stats,
+              Deeprails::Internal::AnyHash
+            )
+          end
+
+        # Number of evaluations that completed successfully.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :completed_evaluations
+
+        sig { params(completed_evaluations: Integer).void }
+        attr_writer :completed_evaluations
+
+        # Number of evaluations that failed.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :failed_evaluations
+
+        sig { params(failed_evaluations: Integer).void }
+        attr_writer :failed_evaluations
+
+        # Number of evaluations currently in progress.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :in_progress_evaluations
+
+        sig { params(in_progress_evaluations: Integer).void }
+        attr_writer :in_progress_evaluations
+
+        # Number of evaluations currently queued.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :queued_evaluations
+
+        sig { params(queued_evaluations: Integer).void }
+        attr_writer :queued_evaluations
+
+        # Total number of evaluations performed by this monitor.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :total_evaluations
+
+        sig { params(total_evaluations: Integer).void }
+        attr_writer :total_evaluations
+
+        # Contains five fields used for stats of this monitor: total evaluations,
+        # completed evaluations, failed evaluations, queued evaluations, and in progress
+        # evaluations.
+        sig do
+          params(
+            completed_evaluations: Integer,
+            failed_evaluations: Integer,
+            in_progress_evaluations: Integer,
+            queued_evaluations: Integer,
+            total_evaluations: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Number of evaluations that completed successfully.
+          completed_evaluations: nil,
+          # Number of evaluations that failed.
+          failed_evaluations: nil,
+          # Number of evaluations currently in progress.
+          in_progress_evaluations: nil,
+          # Number of evaluations currently queued.
+          queued_evaluations: nil,
+          # Total number of evaluations performed by this monitor.
+          total_evaluations: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              completed_evaluations: Integer,
+              failed_evaluations: Integer,
+              in_progress_evaluations: Integer,
+              queued_evaluations: Integer,
+              total_evaluations: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/deeprails/models/monitor_event_response.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Deeprails
+  module Models
+    class MonitorEventResponse < Deeprails::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Deeprails::MonitorEventResponse, Deeprails::Internal::AnyHash)
+        end
+
+      # A unique evaluation ID associated with this event.
+      sig { returns(String) }
+      attr_accessor :evaluation_id
+
+      # A unique monitor event ID.
+      sig { returns(String) }
+      attr_accessor :event_id
+
+      # Monitor ID associated with this event.
+      sig { returns(String) }
+      attr_accessor :monitor_id
+
+      # The time the monitor event was created in UTC.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      sig do
+        params(
+          evaluation_id: String,
+          event_id: String,
+          monitor_id: String,
+          created_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique evaluation ID associated with this event.
+        evaluation_id:,
+        # A unique monitor event ID.
+        event_id:,
+        # Monitor ID associated with this event.
+        monitor_id:,
+        # The time the monitor event was created in UTC.
+        created_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            evaluation_id: String,
+            event_id: String,
+            monitor_id: String,
+            created_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end