deeprails 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee919b4b7355075fd7166bd63ffa82cb21d9593633f89ea46f07fc6ea9bba9e5
-  data.tar.gz: f7571dc221d9b1dfade476d9f82ec5ff6d6ff06210633d2b719c9fb187bb4e0b
+  metadata.gz: 5ec170552015a190316efdd44dfb6afd54be45edee2c484465512b97fb30dbee
+  data.tar.gz: 350afc446f1a5a9901867a1ff294c1a43db4368807baf3f57c09b0e7980e4c3d
 SHA512:
-  metadata.gz: 66998c7bcb53ee7678e66375b37a9e7f71b0620f2c97891cf3f8f56196a15b3f4fa3f0e159403f7c5c09bd5a3fb36db0310c75137fe6ab9a29b0c535efcf270a
-  data.tar.gz: 6e8b371ff4bdaa0f8ed19edf9eb833e6a0813f48ea6f5d94d5a033ddd73745d96eac693cf0073d18f907d57790181e2c9b82601e30719e4531bc0131de67ea5d
+  metadata.gz: 686858c77cd34c76d7071f1c67bfbb24b03b787f051cc02e3b237ee6f9f1e499359304830732d0e55e8d0f90ef0c1bdae0a784ea3ae74617c788bd048524de6a
+  data.tar.gz: a2276ada84dcd2f1e22e3b9df4c41959ee6debba2ecc39bcf6519e517faf80555ad6e2b39852f09888f3c3cab12a85fd03b6211d12773ccf61535df157e3ad9d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.13.0 (2025-11-11)
+
+Full Changelog: [v0.12.0...v0.13.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.12.0...v0.13.0)
+
+### Features
+
+* **api:** add retrieve monitor event and examples ([3179cc0](https://github.com/deeprails/deeprails-ruby-sdk/commit/3179cc06df9d92f96abdb4f162887697e133c688))
+
 ## 0.12.0 (2025-11-10)
 
 Full Changelog: [v0.11.0...v0.12.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.11.0...v0.12.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "deeprails", "~> 0.12.0"
+gem "deeprails", "~> 0.13.0"
 ```
 
 <!-- x-release-please-end -->
@@ -33,7 +33,7 @@ deeprails = Deeprails::Client.new(
 defend_create_response = deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  threshold_type: "automatic",
+  threshold_type: "custom",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true
 )
@@ -50,7 +50,7 @@ begin
   defend = deeprails.defend.create_workflow(
     improvement_action: "fixit",
     name: "Push Alert Workflow",
-    threshold_type: "automatic",
+    threshold_type: "custom",
     custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
     web_search: true
   )
@@ -99,7 +99,7 @@ deeprails = Deeprails::Client.new(
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  threshold_type: "automatic",
+  threshold_type: "custom",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true,
   request_options: {max_retries: 5}
@@ -120,7 +120,7 @@ deeprails = Deeprails::Client.new(
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  threshold_type: "automatic",
+  threshold_type: "custom",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true,
   request_options: {timeout: 5}
@@ -158,7 +158,7 @@ defend_create_response =
   deeprails.defend.create_workflow(
     improvement_action: "fixit",
     name: "Push Alert Workflow",
-    threshold_type: "automatic",
+    threshold_type: "custom",
     custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
     web_search: true,
     request_options: {
@@ -209,7 +209,7 @@ You can provide typesafe request parameters like so:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  threshold_type: "automatic",
+  threshold_type: "custom",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true
 )
@@ -222,7 +222,7 @@ Or, equivalently:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  threshold_type: "automatic",
+  threshold_type: "custom",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true
 )
@@ -231,7 +231,7 @@ deeprails.defend.create_workflow(
 params = Deeprails::DefendCreateWorkflowParams.new(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  threshold_type: "automatic",
+  threshold_type: "custom",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true
 )

data/lib/deeprails/models/defend_response.rb

@@ -4,96 +4,92 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Defend#retrieve_workflow
     class DefendResponse < Deeprails::Internal::Type::BaseModel
-      # @!attribute name
-      #   Name of the workflow.
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute workflow_id
-      #   A unique workflow ID.
-      #
-      #   @return [String]
-      required :workflow_id, String
-
       # @!attribute automatic_hallucination_tolerance_levels
       #   Mapping of guardrail metric names to tolerance values. Values can be strings
       #   (`low`, `medium`, `high`) for automatic tolerance levels.
       #
-      #   @return [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}, nil]
-      optional :automatic_hallucination_tolerance_levels,
+      #   @return [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}]
+      required :automatic_hallucination_tolerance_levels,
                -> { Deeprails::Internal::Type::HashOf[enum: Deeprails::DefendResponse::AutomaticHallucinationToleranceLevel] }
 
       # @!attribute capabilities
       #   Extended AI capabilities available to the event, if any. Can be `web_search`
       #   and/or `file_search`.
       #
-      #   @return [Array<Deeprails::Models::DefendResponse::Capability>, nil]
-      optional :capabilities, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Capability] }
+      #   @return [Array<Deeprails::Models::DefendResponse::Capability>]
+      required :capabilities, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Capability] }
 
       # @!attribute created_at
       #   The time the workflow was created in UTC.
       #
-      #   @return [Time, nil]
-      optional :created_at, Time
+      #   @return [Time]
+      required :created_at, Time
 
       # @!attribute custom_hallucination_threshold_values
       #   Mapping of guardrail metric names to threshold values. Values can be floating
       #   point numbers (0.0-1.0) for custom thresholds.
       #
-      #   @return [Hash{Symbol=>Float}, nil]
-      optional :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
+      #   @return [Hash{Symbol=>Float}]
+      required :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
 
       # @!attribute description
       #   Description for the workflow.
       #
-      #   @return [String, nil]
-      optional :description, String
+      #   @return [String]
+      required :description, String
 
       # @!attribute events
       #   An array of events associated with this workflow.
       #
-      #   @return [Array<Deeprails::Models::DefendResponse::Event>, nil]
-      optional :events, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Event] }
+      #   @return [Array<Deeprails::Models::DefendResponse::Event>]
+      required :events, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::Event] }
 
       # @!attribute files
       #   List of files associated with the workflow. If this is not empty, models can
       #   search these files when performing evaluations or remediations
       #
-      #   @return [Array<Deeprails::Models::DefendResponse::File>, nil]
-      optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::File] }
+      #   @return [Array<Deeprails::Models::DefendResponse::File>]
+      required :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::DefendResponse::File] }
 
-      # @!attribute stats
+      # @!attribute name
+      #   Name of the workflow.
       #
-      #   @return [Deeprails::Models::DefendResponse::Stats, nil]
-      optional :stats, -> { Deeprails::DefendResponse::Stats }
+      #   @return [String]
+      required :name, String
 
       # @!attribute status
       #   Status of the selected workflow. May be `inactive` or `active`. Inactive
       #   workflows will not accept events.
       #
-      #   @return [Symbol, Deeprails::Models::DefendResponse::Status, nil]
-      optional :status, enum: -> { Deeprails::DefendResponse::Status }
+      #   @return [Symbol, Deeprails::Models::DefendResponse::Status]
+      required :status, enum: -> { Deeprails::DefendResponse::Status }
 
       # @!attribute threshold_type
       #   Type of thresholds used to evaluate the event.
       #
-      #   @return [Symbol, Deeprails::Models::DefendResponse::ThresholdType, nil]
-      optional :threshold_type, enum: -> { Deeprails::DefendResponse::ThresholdType }
+      #   @return [Symbol, Deeprails::Models::DefendResponse::ThresholdType]
+      required :threshold_type, enum: -> { Deeprails::DefendResponse::ThresholdType }
 
       # @!attribute updated_at
       #   The most recent time the workflow was updated in UTC.
       #
-      #   @return [Time, nil]
-      optional :updated_at, Time
+      #   @return [Time]
+      required :updated_at, Time
 
-      # @!method initialize(name:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, created_at: nil, custom_hallucination_threshold_values: nil, description: nil, events: nil, files: nil, stats: nil, status: nil, threshold_type: nil, updated_at: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Deeprails::Models::DefendResponse} for more details.
+      # @!attribute workflow_id
+      #   A unique workflow ID.
       #
-      #   @param name [String] Name of the workflow.
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!attribute stats
       #
-      #   @param workflow_id [String] A unique workflow ID.
+      #   @return [Deeprails::Models::DefendResponse::Stats, nil]
+      optional :stats, -> { Deeprails::DefendResponse::Stats }
+
+      # @!method initialize(automatic_hallucination_tolerance_levels:, capabilities:, created_at:, custom_hallucination_threshold_values:, description:, events:, files:, name:, status:, threshold_type:, updated_at:, workflow_id:, stats: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendResponse} for more details.
       #
       #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendResponse::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metric names to tolerance values. Values can be strings (`l
       #
@@ -109,13 +105,17 @@ module Deeprails
       #
       #   @param files [Array<Deeprails::Models::DefendResponse::File>] List of files associated with the workflow. If this is not empty, models can sea
       #
-      #   @param stats [Deeprails::Models::DefendResponse::Stats]
+      #   @param name [String] Name of the workflow.
       #
       #   @param status [Symbol, Deeprails::Models::DefendResponse::Status] Status of the selected workflow. May be `inactive` or `active`. Inactive workf
       #
       #   @param threshold_type [Symbol, Deeprails::Models::DefendResponse::ThresholdType] Type of thresholds used to evaluate the event.
       #
       #   @param updated_at [Time] The most recent time the workflow was updated in UTC.
+      #
+      #   @param workflow_id [String] A unique workflow ID.
+      #
+      #   @param stats [Deeprails::Models::DefendResponse::Stats]
 
       module AutomaticHallucinationToleranceLevel
         extend Deeprails::Internal::Type::Enum
@@ -303,6 +303,33 @@ module Deeprails
         #   @param file_size [Integer]
       end
 
+      # Status of the selected workflow. May be `inactive` or `active`. Inactive
+      # workflows will not accept events.
+      #
+      # @see Deeprails::Models::DefendResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        INACTIVE = :inactive
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Type of thresholds used to evaluate the event.
+      #
+      # @see Deeprails::Models::DefendResponse#threshold_type
+      module ThresholdType
+        extend Deeprails::Internal::Type::Enum
+
+        CUSTOM = :custom
+        AUTOMATIC = :automatic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Deeprails::Models::DefendResponse#stats
       class Stats < Deeprails::Internal::Type::BaseModel
         # @!attribute outputs_below_threshold
@@ -330,33 +357,6 @@ module Deeprails
         #
         #   @param outputs_processed [Integer] Total number of AI outputs processed by the workflow.
       end
-
-      # Status of the selected workflow. May be `inactive` or `active`. Inactive
-      # workflows will not accept events.
-      #
-      # @see Deeprails::Models::DefendResponse#status
-      module Status
-        extend Deeprails::Internal::Type::Enum
-
-        INACTIVE = :inactive
-        ACTIVE = :active
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Type of thresholds used to evaluate the event.
-      #
-      # @see Deeprails::Models::DefendResponse#threshold_type
-      module ThresholdType
-        extend Deeprails::Internal::Type::Enum
-
-        CUSTOM = :custom
-        AUTOMATIC = :automatic
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/deeprails/models/monitor_detail_response.rb

@@ -4,109 +4,95 @@ module Deeprails
   module Models
     # @see Deeprails::Resources::Monitor#retrieve
     class MonitorDetailResponse < Deeprails::Internal::Type::BaseModel
-      # @!attribute monitor_id
-      #   A unique monitor ID.
-      #
-      #   @return [String]
-      required :monitor_id, String
-
-      # @!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,
+      #   @return [Array<Deeprails::Models::MonitorDetailResponse::Capability>]
+      required :capabilities,
                -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::Capability] }
 
       # @!attribute created_at
       #   The time the monitor was created in UTC.
       #
-      #   @return [Time, nil]
-      optional :created_at, Time
-
-      # @!attribute description
-      #   Description of this monitor.
-      #
-      #   @return [String, nil]
-      optional :description, String
+      #   @return [Time]
+      required :created_at, Time
 
       # @!attribute evaluations
       #   An array of all evaluations performed by this monitor. Each one corresponds to a
       #   separate monitor event.
       #
-      #   @return [Array<Deeprails::Models::MonitorDetailResponse::Evaluation>, nil]
-      optional :evaluations,
+      #   @return [Array<Deeprails::Models::MonitorDetailResponse::Evaluation>]
+      required :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] }
+      #   @return [Array<Deeprails::Models::MonitorDetailResponse::File>]
+      required :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::MonitorDetailResponse::File] }
+
+      # @!attribute monitor_id
+      #   A unique monitor ID.
+      #
+      #   @return [String]
+      required :monitor_id, String
+
+      # @!attribute name
+      #   Name of this monitor.
+      #
+      #   @return [String]
+      required :name, String
 
       # @!attribute stats
       #   Contains five fields used for stats of this monitor: total evaluations,
       #   completed evaluations, failed evaluations, queued evaluations, and in progress
       #   evaluations.
       #
-      #   @return [Deeprails::Models::MonitorDetailResponse::Stats, nil]
-      optional :stats, -> { Deeprails::MonitorDetailResponse::Stats }
+      #   @return [Deeprails::Models::MonitorDetailResponse::Stats]
+      required :stats, -> { Deeprails::MonitorDetailResponse::Stats }
+
+      # @!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 updated_at
       #   The most recent time the monitor was modified in UTC.
       #
-      #   @return [Time, nil]
-      optional :updated_at, Time
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   Description of this monitor.
+      #
+      #   @return [String, nil]
+      optional :description, String
 
-      # @!method initialize(monitor_id:, name:, status:, capabilities: nil, created_at: nil, description: nil, evaluations: nil, files: nil, stats: nil, updated_at: nil)
+      # @!method initialize(capabilities:, created_at:, evaluations:, files:, monitor_id:, name:, stats:, status:, updated_at:, description: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::MonitorDetailResponse} for more details.
       #
-      #   @param monitor_id [String] A unique monitor ID.
-      #
-      #   @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 monitor_id [String] A unique monitor ID.
+      #
+      #   @param name [String] Name of this monitor.
+      #
       #   @param stats [Deeprails::Models::MonitorDetailResponse::Stats] Contains five fields used for stats of this monitor: total evaluations, complete
       #
+      #   @param status [Symbol, Deeprails::Models::MonitorDetailResponse::Status] 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.
-
-      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
-      # longer record and evaluate events.
       #
-      # @see Deeprails::Models::MonitorDetailResponse#status
-      module Status
-        extend Deeprails::Internal::Type::Enum
-
-        ACTIVE = :active
-        INACTIVE = :inactive
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param description [String] Description of this monitor.
 
       class Capability < Deeprails::Internal::Type::BaseModel
         # @!attribute capability
@@ -372,6 +358,20 @@ module Deeprails
         #
         #   @param total_evaluations [Integer] Total number of evaluations performed by this monitor.
       end
+
+      # Status of the monitor. Can be `active` or `inactive`. Inactive monitors no
+      # longer record and evaluate events.
+      #
+      # @see Deeprails::Models::MonitorDetailResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/deeprails/models/monitor_event_detail_response.rb

@@ -2,6 +2,7 @@
 
 module Deeprails
   module Models
+    # @see Deeprails::Resources::Monitor#retrieve_event
     class MonitorEventDetailResponse < Deeprails::Internal::Type::BaseModel
       # @!attribute capabilities
       #   The capabilities associated with the monitor event.

data/lib/deeprails/models/monitor_retrieve_event_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Monitor#retrieve_event
+    class MonitorRetrieveEventParams < Deeprails::Internal::Type::BaseModel
+      extend Deeprails::Internal::Type::RequestParameters::Converter
+      include Deeprails::Internal::Type::RequestParameters
+
+      # @!attribute monitor_id
+      #
+      #   @return [String]
+      required :monitor_id, String
+
+      # @!method initialize(monitor_id:, request_options: {})
+      #   @param monitor_id [String]
+      #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end