deeprails 0.11.0 → 0.12.0

data/lib/deeprails/models/monitor_detail_response.rb

@@ -10,19 +10,26 @@ module Deeprails
       #   @return [String]
       required :monitor_id, 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::MonitorDetailResponse::MonitorStatus]
-      required :monitor_status, enum: -> { Deeprails::MonitorDetailResponse::MonitorStatus }
-
       # @!attribute name
       #   Name of this monitor.
       #
       #   @return [String]
       required :name, String
 
+      # @!attribute status
+      #   Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      #   longer record and evaluate events.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorDetailResponse::Status]
+      required :status, enum: -> { Deeprails::MonitorDetailResponse::Status }
+
+      # @!attribute capabilities
+      #   An array of capabilities associated with this monitor.
+      #
+      #   @return [Array<Deeprails::Models::MonitorDetailResponse::Capability>, nil]
+      optional :capabilities,
+               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::Capability] }
+
       # @!attribute created_at
       #   The time the monitor was created in UTC.
       #
@@ -43,6 +50,12 @@ module Deeprails
       optional :evaluations,
                -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::Evaluation] }
 
+      # @!attribute files
+      #   An array of files associated with this monitor.
+      #
+      #   @return [Array<Deeprails::Models::MonitorDetailResponse::File>, nil]
+      optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::File] }
+
       # @!attribute stats
       #   Contains five fields used for stats of this monitor: total evaluations,
       #   completed evaluations, failed evaluations, queued evaluations, and in progress
@@ -57,39 +70,35 @@ module Deeprails
       #   @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:, monitor_status:, name:, created_at: nil, description: nil, evaluations: nil, stats: nil, updated_at: nil, user_id: nil)
+      # @!method initialize(monitor_id:, name:, status:, capabilities: nil, created_at: nil, description: nil, evaluations: nil, files: nil, stats: nil, updated_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::MonitorDetailResponse} for more details.
       #
       #   @param monitor_id [String] A unique monitor ID.
       #
-      #   @param monitor_status [Symbol, Deeprails::Models::MonitorDetailResponse::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
-      #
       #   @param name [String] Name of this monitor.
       #
+      #   @param status [Symbol, Deeprails::Models::MonitorDetailResponse::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+      #
+      #   @param capabilities [Array<Deeprails::Models::MonitorDetailResponse::Capability>] An array of capabilities associated with this monitor.
+      #
       #   @param created_at [Time] The time the monitor was created in UTC.
       #
       #   @param description [String] Description of this monitor.
       #
       #   @param evaluations [Array<Deeprails::Models::MonitorDetailResponse::Evaluation>] An array of all evaluations performed by this monitor. Each one corresponds to
       #
+      #   @param files [Array<Deeprails::Models::MonitorDetailResponse::File>] An array of files associated with this monitor.
+      #
       #   @param stats [Deeprails::Models::MonitorDetailResponse::Stats] Contains five fields used for stats of this monitor: total evaluations, complete
       #
       #   @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::MonitorDetailResponse#monitor_status
-      module MonitorStatus
+      # @see Deeprails::Models::MonitorDetailResponse#status
+      module Status
         extend Deeprails::Internal::Type::Enum
 
         ACTIVE = :active
@@ -99,13 +108,18 @@ module Deeprails
         #   @return [Array<Symbol>]
       end
 
-      class Evaluation < Deeprails::Internal::Type::BaseModel
-        # @!attribute eval_id
-        #   A unique evaluation ID.
+      class Capability < Deeprails::Internal::Type::BaseModel
+        # @!attribute capability
+        #   The type of capability.
         #
-        #   @return [String]
-        required :eval_id, String
+        #   @return [String, nil]
+        optional :capability, String
 
+        # @!method initialize(capability: nil)
+        #   @param capability [String] The type of capability.
+      end
+
+      class Evaluation < Deeprails::Internal::Type::BaseModel
         # @!attribute evaluation_status
         #   Status of the evaluation.
         #
@@ -139,24 +153,12 @@ module Deeprails
         #   @return [Time, nil]
         optional :created_at, Time
 
-        # @!attribute end_timestamp
-        #   The time the evaluation completed in UTC.
-        #
-        #   @return [Time, nil]
-        optional :end_timestamp, Time
-
         # @!attribute error_message
-        #   Description of the error causing the evaluation to fail, if any.
+        #   Error message if the evaluation failed.
         #
         #   @return [String, nil]
         optional :error_message, String
 
-        # @!attribute error_timestamp
-        #   The time the error causing the evaluation to fail was recorded.
-        #
-        #   @return [Time, nil]
-        optional :error_timestamp, Time
-
         # @!attribute evaluation_result
         #   Evaluation result consisting of average scores and rationales for each of the
         #   evaluated guardrail metrics.
@@ -178,18 +180,6 @@ module Deeprails
         optional :guardrail_metrics,
                  -> { Deeprails::Internal::Type::ArrayOf[enum: Deeprails::MonitorDetailResponse::Evaluation::GuardrailMetric] }
 
-        # @!attribute model_used
-        #   Model ID used to generate the output, like `gpt-4o` or `o3`.
-        #
-        #   @return [String, nil]
-        optional :model_used, String
-
-        # @!attribute modified_at
-        #   The most recent time the evaluation was modified in UTC.
-        #
-        #   @return [Time, nil]
-        optional :modified_at, Time
-
         # @!attribute nametag
         #   An optional, user-defined tag for the evaluation.
         #
@@ -203,18 +193,10 @@ module Deeprails
         #   @return [Integer, nil]
         optional :progress, Integer
 
-        # @!attribute start_timestamp
-        #   The time the evaluation started in UTC.
-        #
-        #   @return [Time, nil]
-        optional :start_timestamp, Time
-
-        # @!method initialize(eval_id:, evaluation_status:, model_input:, model_output:, run_mode:, created_at: nil, end_timestamp: nil, error_message: nil, error_timestamp: nil, evaluation_result: nil, evaluation_total_cost: nil, guardrail_metrics: nil, model_used: nil, modified_at: nil, nametag: nil, progress: nil, start_timestamp: nil)
+        # @!method initialize(evaluation_status:, model_input:, model_output:, run_mode:, created_at: nil, error_message: nil, evaluation_result: nil, evaluation_total_cost: nil, guardrail_metrics: nil, nametag: nil, progress: nil)
         #   Some parameter documentations has been truncated, see
         #   {Deeprails::Models::MonitorDetailResponse::Evaluation} for more details.
         #
-        #   @param eval_id [String] A unique evaluation ID.
-        #
         #   @param evaluation_status [Symbol, Deeprails::Models::MonitorDetailResponse::Evaluation::EvaluationStatus] Status of the evaluation.
         #
         #   @param model_input [Deeprails::Models::MonitorDetailResponse::Evaluation::ModelInput] A dictionary of inputs sent to the LLM to generate output. The dictionary must c
@@ -225,11 +207,7 @@ module Deeprails
         #
         #   @param created_at [Time] The time the evaluation was created in UTC.
         #
-        #   @param end_timestamp [Time] The time the evaluation completed in UTC.
-        #
-        #   @param error_message [String] Description of the error causing the evaluation to fail, if any.
-        #
-        #   @param error_timestamp [Time] The time the error causing the evaluation to fail was recorded.
+        #   @param error_message [String] Error message if the evaluation failed.
         #
         #   @param evaluation_result [Hash{Symbol=>Object}] Evaluation result consisting of average scores and rationales for each of the ev
         #
@@ -237,15 +215,9 @@ module Deeprails
         #
         #   @param guardrail_metrics [Array<Symbol, Deeprails::Models::MonitorDetailResponse::Evaluation::GuardrailMetric>] An array of guardrail metrics that the model input and output pair will be evalu
         #
-        #   @param model_used [String] Model ID used to generate the output, like `gpt-4o` or `o3`.
-        #
-        #   @param modified_at [Time] The most recent time the evaluation was modified in UTC.
-        #
         #   @param nametag [String] An optional, user-defined tag for the evaluation.
         #
         #   @param progress [Integer] Evaluation progress. Values range between 0 and 100; 100 corresponds to a compl
-        #
-        #   @param start_timestamp [Time] The time the evaluation started in UTC.
 
         # Status of the evaluation.
         #
@@ -326,6 +298,33 @@ module Deeprails
         end
       end
 
+      class File < Deeprails::Internal::Type::BaseModel
+        # @!attribute file_id
+        #   The ID of the file.
+        #
+        #   @return [String, nil]
+        optional :file_id, String
+
+        # @!attribute file_name
+        #   The name of the file.
+        #
+        #   @return [String, nil]
+        optional :file_name, String
+
+        # @!attribute file_size
+        #   The size of the file in bytes.
+        #
+        #   @return [Integer, nil]
+        optional :file_size, Integer
+
+        # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
+        #   @param file_id [String] The ID of the file.
+        #
+        #   @param file_name [String] The name of the file.
+        #
+        #   @param file_size [Integer] The size of the file in bytes.
+      end
+
       # @see Deeprails::Models::MonitorDetailResponse#stats
       class Stats < Deeprails::Internal::Type::BaseModel
         # @!attribute completed_evaluations

data/lib/deeprails/models/monitor_event_detail_response.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    class MonitorEventDetailResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute capabilities
+      #   The capabilities associated with the monitor event.
+      #
+      #   @return [Array<Deeprails::Models::MonitorEventDetailResponse::Capability>, nil]
+      optional :capabilities,
+               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorEventDetailResponse::Capability] }
+
+      # @!attribute eval_time
+      #   The time spent on the evaluation in seconds.
+      #
+      #   @return [String, nil]
+      optional :eval_time, String
+
+      # @!attribute evaluation_result
+      #   The result of the evaluation of the monitor event.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+      # @!attribute event_id
+      #   A unique monitor event ID.
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
+      # @!attribute files
+      #   The files associated with the monitor event.
+      #
+      #   @return [Array<Deeprails::Models::MonitorEventDetailResponse::File>, nil]
+      optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorEventDetailResponse::File] }
+
+      # @!attribute guardrail_metrics
+      #   The guardrail metrics evaluated by the monitor event.
+      #
+      #   @return [Array<String>, nil]
+      optional :guardrail_metrics, Deeprails::Internal::Type::ArrayOf[String]
+
+      # @!attribute model_input
+      #   The model input used to create the monitor event.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :model_input, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+      # @!attribute model_output
+      #   The output evaluated by the monitor event.
+      #
+      #   @return [String, nil]
+      optional :model_output, String
+
+      # @!attribute monitor_id
+      #   Monitor ID associated with this event.
+      #
+      #   @return [String, nil]
+      optional :monitor_id, String
+
+      # @!attribute nametag
+      #   A human-readable tag for the monitor event.
+      #
+      #   @return [String, nil]
+      optional :nametag, String
+
+      # @!attribute run_mode
+      #   The run mode used to evaluate the monitor event.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorEventDetailResponse::RunMode, nil]
+      optional :run_mode, enum: -> { Deeprails::MonitorEventDetailResponse::RunMode }
+
+      # @!attribute status
+      #   Status of the monitor event's evaluation.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorEventDetailResponse::Status, nil]
+      optional :status, enum: -> { Deeprails::MonitorEventDetailResponse::Status }
+
+      # @!attribute timestamp
+      #   The time the monitor event was created in UTC.
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!method initialize(capabilities: nil, eval_time: nil, evaluation_result: nil, event_id: nil, files: nil, guardrail_metrics: nil, model_input: nil, model_output: nil, monitor_id: nil, nametag: nil, run_mode: nil, status: nil, timestamp: nil)
+      #   @param capabilities [Array<Deeprails::Models::MonitorEventDetailResponse::Capability>] The capabilities associated with the monitor event.
+      #
+      #   @param eval_time [String] The time spent on the evaluation in seconds.
+      #
+      #   @param evaluation_result [Hash{Symbol=>Object}] The result of the evaluation of the monitor event.
+      #
+      #   @param event_id [String] A unique monitor event ID.
+      #
+      #   @param files [Array<Deeprails::Models::MonitorEventDetailResponse::File>] The files associated with the monitor event.
+      #
+      #   @param guardrail_metrics [Array<String>] The guardrail metrics evaluated by the monitor event.
+      #
+      #   @param model_input [Hash{Symbol=>Object}] The model input used to create the monitor event.
+      #
+      #   @param model_output [String] The output evaluated by the monitor event.
+      #
+      #   @param monitor_id [String] Monitor ID associated with this event.
+      #
+      #   @param nametag [String] A human-readable tag for the monitor event.
+      #
+      #   @param run_mode [Symbol, Deeprails::Models::MonitorEventDetailResponse::RunMode] The run mode used to evaluate the monitor event.
+      #
+      #   @param status [Symbol, Deeprails::Models::MonitorEventDetailResponse::Status] Status of the monitor event's evaluation.
+      #
+      #   @param timestamp [Time] The time the monitor event was created in UTC.
+
+      class Capability < Deeprails::Internal::Type::BaseModel
+        # @!attribute capability
+        #   The type of capability.
+        #
+        #   @return [String, nil]
+        optional :capability, String
+
+        # @!method initialize(capability: nil)
+        #   @param capability [String] The type of capability.
+      end
+
+      class File < Deeprails::Internal::Type::BaseModel
+        # @!attribute file_id
+        #   The ID of the file.
+        #
+        #   @return [String, nil]
+        optional :file_id, String
+
+        # @!attribute file_name
+        #   The name of the file.
+        #
+        #   @return [String, nil]
+        optional :file_name, String
+
+        # @!attribute file_size
+        #   The size of the file in bytes.
+        #
+        #   @return [Integer, nil]
+        optional :file_size, Integer
+
+        # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
+        #   @param file_id [String] The ID of the file.
+        #
+        #   @param file_name [String] The name of the file.
+        #
+        #   @param file_size [Integer] The size of the file in bytes.
+      end
+
+      # The run mode used to evaluate the monitor event.
+      #
+      # @see Deeprails::Models::MonitorEventDetailResponse#run_mode
+      module RunMode
+        extend Deeprails::Internal::Type::Enum
+
+        PRECISION_PLUS = :precision_plus
+        PRECISION = :precision
+        SMART = :smart
+        ECONOMY = :economy
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of the monitor event's evaluation.
+      #
+      # @see Deeprails::Models::MonitorEventDetailResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        CANCELED = :canceled
+        QUEUED = :queued
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/monitor_event_response.rb

@@ -4,12 +4,6 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Monitor#submit_event
     class MonitorEventResponse < Deeprails::Internal::Type::BaseModel
-      # @!attribute evaluation_id
-      #   A unique evaluation ID associated with this event.
-      #
-      #   @return [String]
-      required :evaluation_id, String
-
       # @!attribute event_id
       #   A unique monitor event ID.
       #
@@ -28,9 +22,7 @@ module Deeprails
       #   @return [Time, nil]
       optional :created_at, Time
 
-      # @!method initialize(evaluation_id:, event_id:, monitor_id:, created_at: nil)
-      #   @param evaluation_id [String] A unique evaluation ID associated with this event.
-      #
+      # @!method initialize(event_id:, monitor_id:, created_at: nil)
       #   @param event_id [String] A unique monitor event ID.
       #
       #   @param monitor_id [String] Monitor ID associated with this event.

data/lib/deeprails/models/monitor_retrieve_params.rb

@@ -8,13 +8,17 @@ module Deeprails
       include Deeprails::Internal::Type::RequestParameters
 
       # @!attribute limit
-      #   Limit the returned events associated with this monitor. Defaults to 10.
+      #   Limit the number of returned evaluations associated with this monitor. Defaults
+      #   to 10.
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
       # @!method initialize(limit: nil, request_options: {})
-      #   @param limit [Integer] Limit the returned events associated with this monitor. Defaults to 10.
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::MonitorRetrieveParams} for more details.
+      #
+      #   @param limit [Integer] Limit the number of returned evaluations associated with this monitor. Defaults
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/deeprails/models/monitor_update_params.rb

@@ -13,34 +13,34 @@ module Deeprails
       #   @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::MonitorUpdateParams::MonitorStatus, nil]
-      optional :monitor_status, enum: -> { Deeprails::MonitorUpdateParams::MonitorStatus }
-
       # @!attribute name
       #   Name of the monitor.
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!method initialize(description: nil, monitor_status: nil, name: nil, request_options: {})
+      # @!attribute status
+      #   Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      #   longer record and evaluate events.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorUpdateParams::Status, nil]
+      optional :status, enum: -> { Deeprails::MonitorUpdateParams::Status }
+
+      # @!method initialize(description: nil, name: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::MonitorUpdateParams} for more details.
       #
       #   @param description [String] Description of the monitor.
       #
-      #   @param monitor_status [Symbol, Deeprails::Models::MonitorUpdateParams::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
-      #
       #   @param name [String] Name of the monitor.
       #
+      #   @param status [Symbol, Deeprails::Models::MonitorUpdateParams::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+      #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
 
       # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
       # longer record and evaluate events.
-      module MonitorStatus
+      module Status
         extend Deeprails::Internal::Type::Enum
 
         ACTIVE = :active

data/lib/deeprails/models/monitor_update_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#update
+    class MonitorUpdateResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute modified_at
+      #   The time the monitor was last modified in UTC.
+      #
+      #   @return [Time]
+      required :modified_at, Time
+
+      # @!attribute monitor_id
+      #   A unique monitor ID.
+      #
+      #   @return [String]
+      required :monitor_id, String
+
+      # @!attribute status
+      #   Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      #   longer record and evaluate events.
+      #
+      #   @return [Symbol, Deeprails::Models::MonitorUpdateResponse::Status]
+      required :status, enum: -> { Deeprails::MonitorUpdateResponse::Status }
+
+      # @!method initialize(modified_at:, monitor_id:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::MonitorUpdateResponse} for more details.
+      #
+      #   @param modified_at [Time] The time the monitor was last modified in UTC.
+      #
+      #   @param monitor_id [String] A unique monitor ID.
+      #
+      #   @param status [Symbol, Deeprails::Models::MonitorUpdateResponse::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      #
+      # @see Deeprails::Models::MonitorUpdateResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end