deeprails 0.7.0 → 0.9.0

data/lib/deeprails/models/monitor_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#create
+    class MonitorResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute monitor_id
+      #   A unique monitor ID.
+      #
+      #   @return [String]
+      required :monitor_id, String
+
+      # @!attribute name
+      #   Name of the monitor.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute created_at
+      #   The time the monitor was created in UTC.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #   Description of the monitor.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute monitor_status
+      #   Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      #   longer record and evaluate events.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorResponse::MonitorStatus, nil]
+      optional :monitor_status, enum: -> { Deeprails::MonitorResponse::MonitorStatus }
+
+      # @!attribute updated_at
+      #   The most recent time the monitor was modified in UTC.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!attribute user_id
+      #   User ID of the user who created the monitor.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(monitor_id:, name:, created_at: nil, description: nil, monitor_status: nil, updated_at: nil, user_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::MonitorResponse} for more details.
+      #
+      #   @param monitor_id [String] A unique monitor ID.
+      #
+      #   @param name [String] Name of the monitor.
+      #
+      #   @param created_at [Time] The time the monitor was created in UTC.
+      #
+      #   @param description [String] Description of the monitor.
+      #
+      #   @param monitor_status [Symbol, Deeprails::Models::MonitorResponse::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+      #
+      #   @param updated_at [Time] The most recent time the monitor was modified in UTC.
+      #
+      #   @param user_id [String] User ID of the user who created the monitor.
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      #
+      # @see Deeprails::Models::MonitorResponse#monitor_status
+      module MonitorStatus
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/monitor_submit_event_params.rb

@@ -19,7 +19,7 @@ module Deeprails
 
       # @!attribute model_input
       #   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
+      #   contain at least a `user_prompt` field or a `system_prompt` field. For
       #   ground_truth_adherence guardrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::MonitorSubmitEventParams::ModelInput]
@@ -105,7 +105,7 @@ module Deeprails
 
         # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
         #   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
+        #   contain at least a `user_prompt` field or a `system_prompt` field. For
         #   ground_truth_adherence guardrail metric, `ground_truth` should be provided.
         #
         #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.

data/lib/deeprails/models.rb

@@ -39,8 +39,6 @@ module Deeprails
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
-  APIResponse = Deeprails::Models::APIResponse
-
   DefendCreateWorkflowParams = Deeprails::Models::DefendCreateWorkflowParams
 
   DefendResponse = Deeprails::Models::DefendResponse
@@ -53,13 +51,13 @@ module Deeprails
 
   DefendUpdateWorkflowParams = Deeprails::Models::DefendUpdateWorkflowParams
 
-  EvaluateCreateParams = Deeprails::Models::EvaluateCreateParams
+  MonitorCreateParams = Deeprails::Models::MonitorCreateParams
 
-  EvaluateRetrieveParams = Deeprails::Models::EvaluateRetrieveParams
+  MonitorDetailResponse = Deeprails::Models::MonitorDetailResponse
 
-  Evaluation = Deeprails::Models::Evaluation
+  MonitorEventResponse = Deeprails::Models::MonitorEventResponse
 
-  MonitorCreateParams = Deeprails::Models::MonitorCreateParams
+  MonitorResponse = Deeprails::Models::MonitorResponse
 
   MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
 

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.7.0"
+  VERSION = "0.9.0"
 end

data/lib/deeprails.rb

@@ -50,24 +50,20 @@ 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"
 require_relative "deeprails/models/defend_retrieve_workflow_params"
 require_relative "deeprails/models/defend_submit_event_params"
 require_relative "deeprails/models/defend_update_workflow_params"
-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"
 require_relative "deeprails/resources/defend"
-require_relative "deeprails/resources/evaluate"
 require_relative "deeprails/resources/monitor"

data/rbi/deeprails/client.rbi

@@ -19,9 +19,6 @@ module Deeprails
     sig { returns(Deeprails::Resources::Monitor) }
     attr_reader :monitor
 
-    sig { returns(Deeprails::Resources::Evaluate) }
-    attr_reader :evaluate
-
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

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,7 +15,7 @@ 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 the
+      # 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,7 +61,7 @@ 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 the
+        # 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.
@@ -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,7 +125,7 @@ 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 the
+        # 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(
@@ -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,