deeprails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99529867238b3137b3164417b82f0ca730d8a58cac3aa93e8860196d700fa319
-  data.tar.gz: b2b025c486e864c36ab1ba31b2d4fbfb80425687d0c531cdbed7bf0740a8ad90
+  metadata.gz: df06a891cae5fe9af356f4a883a1d7cdfe032694c8ecb2c137e4a9b50d102052
+  data.tar.gz: e9608b32d1e68dd23abe32c56d3abde77b5fb895ce9f9d429e885b4aea46a163
 SHA512:
-  metadata.gz: 59b158ba57448e76cb9c0534552ee096eb6370cd86ecafb65ddf2ab087f75a7a87889507c50fe94c35c7cd261145591a5c408b833a5d020d2d61fa0474dcc2cc
-  data.tar.gz: eabae44d439fd4a6936402ab146c9489b5ec1616ea0a4a36ed4243b894b00aeea19ca15d00afbc701e2bbd1be087dc3b6a8b13dda58079e3e2b6276ae3eaa7d5
+  metadata.gz: 5458a4f2cfc15179a2380c88c5af82a5d54e56b05b1d5ae2f190796c1af93b20b0498bc4b1f3c4b2d9b03b1a3fa3dbf45565e9da5944b70376be06c46324b2df
+  data.tar.gz: 61c15fa86dbc9ebed224b38091ca0637bc7f6feadd6eea10847d57ed4ef0fe2600243d57bf2339c159a7b49078804157a38c0bd2f9305e9adaa5dccd3bbe5fd1

data/CHANGELOG.md

@@ -1,12 +1,33 @@
 # Changelog
 
-## 0.2.0 (2025-10-07)
+## 0.3.0 (2025-10-10)
+
+Full Changelog: [v0.2.1...v0.3.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.2.1...v0.3.0)
+
+### Features
+
+* **api:** manual updates ([986412f](https://github.com/deeprails/deeprails-ruby-sdk/commit/986412f6888691af0abdec609a5d456bdac2c1e9))
+
+## 0.2.1 (2025-10-09)
+
+Full Changelog: [v0.2.0...v0.2.1](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.2.0...v0.2.1)
+
+### Chores
+
+* ignore linter error for tests having large collections ([202c9e1](https://github.com/deeprails/deeprails-ruby-sdk/commit/202c9e1977aaebb7e09883564d4694a2d41e4416))
+
+## 0.2.0 (2025-10-08)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.1.0...v0.2.0)
 
 ### Features
 
-* **api:** manual updates ([40308c3](https://github.com/deeprails/deeprails-ruby-sdk/commit/40308c3e3ebfb15a6ab606a13f75e97656daff19))
+* **api:** adding code samples ([9597e09](https://github.com/deeprails/deeprails-ruby-sdk/commit/9597e09967d659172d52c3935b3dd8f3e0018783))
+
+
+### Chores
+
+* sync repo ([a33597d](https://github.com/deeprails/deeprails-ruby-sdk/commit/a33597d5677081f50207f926f9950d9914700fb3))
 
 ## 0.1.0 (2025-10-07)
 

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.2.0"
+gem "deeprails", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -48,7 +48,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 begin
   defend = deeprails.defend.create_workflow(
     improvement_action: "fixit",
-    metrics: {completeness: 0.85, instruction_adherence: 0.75},
+    metrics: {completeness: 0.8, instruction_adherence: 0.75},
     name: "Push Alert Workflow",
     type: "custom"
   )
@@ -96,7 +96,7 @@ deeprails = Deeprails::Client.new(
 # Or, configure per-request:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
-  metrics: {completeness: 0.85, instruction_adherence: 0.75},
+  metrics: {completeness: 0.8, instruction_adherence: 0.75},
   name: "Push Alert Workflow",
   type: "custom",
   request_options: {max_retries: 5}
@@ -116,7 +116,7 @@ deeprails = Deeprails::Client.new(
 # Or, configure per-request:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
-  metrics: {completeness: 0.85, instruction_adherence: 0.75},
+  metrics: {completeness: 0.8, instruction_adherence: 0.75},
   name: "Push Alert Workflow",
   type: "custom",
   request_options: {timeout: 5}
@@ -153,7 +153,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 defend_response =
   deeprails.defend.create_workflow(
     improvement_action: "fixit",
-    metrics: {completeness: 0.85, instruction_adherence: 0.75},
+    metrics: {completeness: 0.8, instruction_adherence: 0.75},
     name: "Push Alert Workflow",
     type: "custom",
     request_options: {

data/lib/deeprails/models/api_response.rb

@@ -11,7 +11,6 @@ module Deeprails
       required :success, Deeprails::Internal::Type::Boolean
 
       # @!attribute data
-      #   Response payload for creating or updating a monitor.
       #
       #   @return [Deeprails::Models::APIResponse::Data, nil]
       optional :data, -> { Deeprails::APIResponse::Data }
@@ -31,7 +30,7 @@ module Deeprails
       #
       #   @param success [Boolean] Represents whether the request was completed successfully.
       #
-      #   @param data [Deeprails::Models::APIResponse::Data] Response payload for creating or updating a monitor.
+      #   @param data [Deeprails::Models::APIResponse::Data]
       #
       #   @param message [String] The accompanying message for the request. Includes error details when applicable
 
@@ -84,8 +83,6 @@ module Deeprails
         #   Some parameter documentations has been truncated, see
         #   {Deeprails::Models::APIResponse::Data} for more details.
         #
-        #   Response payload for creating or updating a monitor.
-        #
         #   @param monitor_id [String] A unique monitor ID.
         #
         #   @param name [String] Name of the monitor.

data/lib/deeprails/models/defend_create_workflow_params.rb

@@ -10,7 +10,7 @@ module Deeprails
       # @!attribute improvement_action
       #   The action used to improve outputs that fail one or guardrail metrics for the
       #   workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      #   nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      #   nothing”. Regenerate runs the user's input prompt with minor induced variance.
       #   Fixit attempts to directly address the shortcomings of the output using the
       #   guardrail failure rationale. Do nothing does not attempt any improvement.
       #
@@ -87,7 +87,7 @@ module Deeprails
 
       # The action used to improve outputs that fail one or guardrail metrics for the
       # workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # nothing”. Regenerate runs the user's input prompt with minor induced variance.
       # Fixit attempts to directly address the shortcomings of the output using the
       # guardrail failure rationale. Do nothing does not attempt any improvement.
       module ImprovementAction

data/lib/deeprails/models/defend_response.rb

@@ -31,7 +31,7 @@ module Deeprails
       # @!attribute improvement_action
       #   The action used to improve outputs that fail one or more guardrail metrics for
       #   the workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      #   nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      #   nothing”. Regenerate runs the user's input prompt with minor induced variance.
       #   Fixit attempts to directly address the shortcomings of the output using the
       #   guardrail failure rationale. Do nothing does not attempt any improvement.
       #
@@ -68,8 +68,6 @@ module Deeprails
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendResponse} for more details.
       #
-      #   Response payload for guardrail workflow operations.
-      #
       #   @param name [String] Name of the workflow.
       #
       #   @param workflow_id [String] A unique workflow ID.
@@ -90,7 +88,7 @@ module Deeprails
 
       # The action used to improve outputs that fail one or more guardrail metrics for
       # the workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # nothing”. Regenerate runs the user's input prompt with minor induced variance.
       # Fixit attempts to directly address the shortcomings of the output using the
       # guardrail failure rationale. Do nothing does not attempt any improvement.
       #

data/lib/deeprails/models/defend_submit_event_params.rb

@@ -27,12 +27,6 @@ module Deeprails
       #   @return [String]
       required :model_used, String
 
-      # @!attribute nametag
-      #   An optional, user-defined tag for the event.
-      #
-      #   @return [String]
-      required :nametag, String
-
       # @!attribute run_mode
       #   Run mode for the workflow event. The run mode allows the user to optimize for
       #   speed, accuracy, and cost by determining which models are used to evaluate the
@@ -42,7 +36,13 @@ module Deeprails
       #   @return [Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode]
       required :run_mode, enum: -> { Deeprails::DefendSubmitEventParams::RunMode }
 
-      # @!method initialize(model_input:, model_output:, model_used:, nametag:, run_mode:, request_options: {})
+      # @!attribute nametag
+      #   An optional, user-defined tag for the event.
+      #
+      #   @return [String, nil]
+      optional :nametag, String
+
+      # @!method initialize(model_input:, model_output:, model_used:, run_mode:, nametag: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendSubmitEventParams} for more details.
       #
@@ -52,10 +52,10 @@ module Deeprails
       #
       #   @param model_used [String] Model ID used to generate the output, like `gpt-4o` or `o3`.
       #
-      #   @param nametag [String] An optional, user-defined tag for the event.
-      #
       #   @param run_mode [Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode] Run mode for the workflow event. The run mode allows the user to optimize for s
       #
+      #   @param nametag [String] An optional, user-defined tag for the event.
+      #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
 
       class ModelInput < Deeprails::Internal::Type::BaseModel

data/lib/deeprails/models/defend_update_workflow_params.rb

@@ -19,31 +19,12 @@ module Deeprails
       #   @return [String, nil]
       optional :name, String
 
-      # @!attribute type
-      #   Type of thresholds to use for the workflow, either `automatic` or `custom`.
-      #
-      #   @return [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::Type, nil]
-      optional :type, enum: -> { Deeprails::DefendUpdateWorkflowParams::Type }
-
-      # @!method initialize(description: nil, name: nil, type: nil, request_options: {})
+      # @!method initialize(description: nil, name: nil, request_options: {})
       #   @param description [String] Description for the workflow.
       #
       #   @param name [String] Name of the workflow.
       #
-      #   @param type [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::Type] Type of thresholds to use for the workflow, either `automatic` or `custom`.
-      #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
-
-      # Type of thresholds to use for the workflow, either `automatic` or `custom`.
-      module Type
-        extend Deeprails::Internal::Type::Enum
-
-        AUTOMATIC = :automatic
-        CUSTOM = :custom
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/deeprails/models/monitor_retrieve_response.rb

@@ -11,7 +11,6 @@ module Deeprails
       required :success, Deeprails::Internal::Type::Boolean
 
       # @!attribute data
-      #   Detailed response payload for retrieving a monitor and its evaluations.
       #
       #   @return [Deeprails::Models::MonitorRetrieveResponse::Data, nil]
       optional :data, -> { Deeprails::Models::MonitorRetrieveResponse::Data }
@@ -31,7 +30,7 @@ module Deeprails
       #
       #   @param success [Boolean] Represents whether the request was completed successfully.
       #
-      #   @param data [Deeprails::Models::MonitorRetrieveResponse::Data] Detailed response payload for retrieving a monitor and its evaluations.
+      #   @param data [Deeprails::Models::MonitorRetrieveResponse::Data]
       #
       #   @param message [String] The accompanying message for the request. Includes error details when applicable
 
@@ -99,8 +98,6 @@ module Deeprails
         #   Some parameter documentations has been truncated, see
         #   {Deeprails::Models::MonitorRetrieveResponse::Data} for more details.
         #
-        #   Detailed response payload for retrieving a monitor and its evaluations.
-        #
         #   @param monitor_id [String] A unique monitor ID.
         #
         #   @param monitor_status [Symbol, Deeprails::Models::MonitorRetrieveResponse::Data::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon

data/lib/deeprails/models/monitor_submit_event_response.rb

@@ -11,7 +11,6 @@ module Deeprails
       required :success, Deeprails::Internal::Type::Boolean
 
       # @!attribute data
-      #   Response payload for monitor event operations.
       #
       #   @return [Deeprails::Models::MonitorSubmitEventResponse::Data, nil]
       optional :data, -> { Deeprails::Models::MonitorSubmitEventResponse::Data }
@@ -31,9 +30,9 @@ module Deeprails
       #
       #   @param success [Boolean] Represents whether the request was completed successfully.
       #
-      #   @param data [Deeprails::Models::MonitorSubmitEventResponse::Data] Response payload for monitor event operations.
+      #   @param data [Deeprails::Models::MonitorSubmitEventResponse::Data]
       #
-      #   @param message [String] The accompanying message for the request. Includes error details when applicabl
+      #   @param message [String] The accompanying message for the request. Includes error details when applicable
 
       # @see Deeprails::Models::MonitorSubmitEventResponse#data
       class Data < Deeprails::Internal::Type::BaseModel
@@ -62,8 +61,6 @@ module Deeprails
         optional :created_at, Time
 
         # @!method initialize(evaluation_id:, event_id:, monitor_id:, created_at: nil)
-        #   Response payload for monitor event operations.
-        #
         #   @param evaluation_id [String] A unique evaluation ID associated with this event.
         #
         #   @param event_id [String] A unique monitor event ID.

data/lib/deeprails/models/workflow_event_response.rb

@@ -41,8 +41,6 @@ module Deeprails
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::WorkflowEventResponse} for more details.
       #
-      #   Response payload for workflow event operations.
-      #
       #   @param event_id [String] A unique workflow event ID.
       #
       #   @param workflow_id [String] Workflow ID associated with the event.

data/lib/deeprails/resources/defend.rb

@@ -6,8 +6,8 @@ module Deeprails
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::DefendCreateWorkflowParams} for more details.
       #
-      # Create a new guardrail workflow with optional guardrail thresholds and
-      # improvement actions.
+      # Use this endpoint to create a new guardrail workflow with optional guardrail
+      # thresholds and improvement actions
       #
       # @overload create_workflow(improvement_action:, metrics:, name:, type:, automatic_tolerance: nil, description: nil, max_retries: nil, request_options: {})
       #
@@ -41,7 +41,7 @@ module Deeprails
         )
       end
 
-      # Retrieve a specific event of a guardrail workflow.
+      # Use this endpoint to retrieve a specific event of a guardrail workflow
       #
       # @overload retrieve_event(event_id, workflow_id:, request_options: {})
       #
@@ -68,7 +68,7 @@ module Deeprails
         )
       end
 
-      # Retrieve the details for a specific guardrail workflow.
+      # Use this endpoint to retrieve the details for a specific defend workflow
       #
       # @overload retrieve_workflow(workflow_id, request_options: {})
       #
@@ -91,9 +91,10 @@ module Deeprails
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::DefendSubmitEventParams} for more details.
       #
-      # Submit a model input and output pair to a workflow for evaluation.
+      # Use this endpoint to submit a model input and output pair to a workflow for
+      # evaluation
       #
-      # @overload submit_event(workflow_id, model_input:, model_output:, model_used:, nametag:, run_mode:, request_options: {})
+      # @overload submit_event(workflow_id, model_input:, model_output:, model_used:, run_mode:, nametag: nil, request_options: {})
       #
       # @param workflow_id [String] Workflow ID associated with this event.
       #
@@ -103,10 +104,10 @@ module Deeprails
       #
       # @param model_used [String] Model ID used to generate the output, like `gpt-4o` or `o3`.
       #
-      # @param nametag [String] An optional, user-defined tag for the event.
-      #
       # @param run_mode [Symbol, Deeprails::Models::DefendSubmitEventParams::RunMode] Run mode for the workflow event. The run mode allows the user to optimize for s
       #
+      # @param nametag [String] An optional, user-defined tag for the event.
+      #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Deeprails::Models::WorkflowEventResponse]
@@ -123,9 +124,9 @@ module Deeprails
         )
       end
 
-      # Update an existing guardrail workflow.
+      # Use this endpoint to update an existing guardrail workflow
       #
-      # @overload update_workflow(workflow_id, description: nil, name: nil, type: nil, request_options: {})
+      # @overload update_workflow(workflow_id, description: nil, name: nil, request_options: {})
       #
       # @param workflow_id [String] The ID of the workflow to edit.
       #
@@ -133,8 +134,6 @@ module Deeprails
       #
       # @param name [String] Name of the workflow.
       #
-      # @param type [Symbol, Deeprails::Models::DefendUpdateWorkflowParams::Type] Type of thresholds to use for the workflow, either `automatic` or `custom`.
-      #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Deeprails::Models::DefendResponse]

data/lib/deeprails/resources/evaluate.rb

@@ -39,7 +39,7 @@ module Deeprails
         )
       end
 
-      # Retrieve the evaluation record for a given evaluation ID.
+      # Use this endpoint to retrieve the evaluation record for a given evaluation ID
       #
       # @overload retrieve(eval_id, request_options: {})
       #

data/lib/deeprails/resources/monitor.rb

@@ -3,7 +3,8 @@
 module Deeprails
   module Resources
     class Monitor
-      # Create a new monitor to evaluate model inputs and outputs using guardrails.
+      # Use this endpoint to create a new monitor to evaluate model inputs and outputs
+      # using guardrails
       #
       # @overload create(name:, description: nil, request_options: {})
       #
@@ -27,7 +28,8 @@ module Deeprails
         )
       end
 
-      # Retrieve the details and evaluations associated with a specific monitor.
+      # Use this endpoint to retrieve the details and evaluations associated with a
+      # specific monitor
       #
       # @overload retrieve(monitor_id, limit: nil, request_options: {})
       #
@@ -54,7 +56,8 @@ module Deeprails
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::MonitorUpdateParams} for more details.
       #
-      # Update the name, description, or status of an existing monitor.
+      # Use this endpoint to update the name, description, or status of an existing
+      # monitor
       #
       # @overload update(monitor_id, description: nil, monitor_status: nil, name: nil, request_options: {})
       #
@@ -85,7 +88,8 @@ module Deeprails
       # Some parameter documentations has been truncated, see
       # {Deeprails::Models::MonitorSubmitEventParams} for more details.
       #
-      # Submit a model input and output pair to a monitor for evaluation.
+      # Use this endpoint to submit a model input and output pair to a monitor for
+      # evaluation
       #
       # @overload submit_event(monitor_id, guardrail_metrics:, model_input:, model_output:, model_used: nil, nametag: nil, run_mode: nil, request_options: {})
       #

data/lib/deeprails/version.rb

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

data/rbi/deeprails/models/api_response.rbi

@@ -12,7 +12,6 @@ module Deeprails
       sig { returns(T::Boolean) }
       attr_accessor :success
 
-      # Response payload for creating or updating a monitor.
       sig { returns(T.nilable(Deeprails::APIResponse::Data)) }
       attr_reader :data
 
@@ -38,7 +37,6 @@ module Deeprails
       def self.new(
         # Represents whether the request was completed successfully.
         success:,
-        # Response payload for creating or updating a monitor.
         data: nil,
         # The accompanying message for the request. Includes error details when
         # applicable.
@@ -117,7 +115,6 @@ module Deeprails
         sig { params(user_id: String).void }
         attr_writer :user_id
 
-        # Response payload for creating or updating a monitor.
         sig do
           params(
             monitor_id: String,

data/rbi/deeprails/models/defend_create_workflow_params.rbi

@@ -16,7 +16,7 @@ module Deeprails
 
       # The action used to improve outputs that fail one or guardrail metrics for the
       # workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # nothing”. Regenerate runs the user's input prompt with minor induced variance.
       # Fixit attempts to directly address the shortcomings of the output using the
       # guardrail failure rationale. Do nothing does not attempt any improvement.
       sig do
@@ -101,7 +101,7 @@ module Deeprails
       def self.new(
         # The action used to improve outputs that fail one or guardrail metrics for the
         # workflow events. May be `regenerate`, `fixit`, or null which represents “do
-        # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+        # nothing”. Regenerate runs the user's input prompt with minor induced variance.
         # Fixit attempts to directly address the shortcomings of the output using the
         # guardrail failure rationale. Do nothing does not attempt any improvement.
         improvement_action:,
@@ -154,7 +154,7 @@ module Deeprails
 
       # The action used to improve outputs that fail one or guardrail metrics for the
       # workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # nothing”. Regenerate runs the user's input prompt with minor induced variance.
       # Fixit attempts to directly address the shortcomings of the output using the
       # guardrail failure rationale. Do nothing does not attempt any improvement.
       module ImprovementAction

data/rbi/deeprails/models/defend_response.rbi

@@ -32,7 +32,7 @@ module Deeprails
 
       # The action used to improve outputs that fail one or more guardrail metrics for
       # the workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # nothing”. Regenerate runs the user's input prompt with minor induced variance.
       # Fixit attempts to directly address the shortcomings of the output using the
       # guardrail failure rationale. Do nothing does not attempt any improvement.
       sig do
@@ -74,7 +74,6 @@ module Deeprails
       sig { params(success_rate: Float).void }
       attr_writer :success_rate
 
-      # Response payload for guardrail workflow operations.
       sig do
         params(
           name: String,
@@ -100,7 +99,7 @@ module Deeprails
         description: nil,
         # The action used to improve outputs that fail one or more guardrail metrics for
         # the workflow events. May be `regenerate`, `fixit`, or null which represents “do
-        # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+        # nothing”. Regenerate runs the user's input prompt with minor induced variance.
         # Fixit attempts to directly address the shortcomings of the output using the
         # guardrail failure rationale. Do nothing does not attempt any improvement.
         improvement_action: nil,
@@ -140,7 +139,7 @@ module Deeprails
 
       # The action used to improve outputs that fail one or more guardrail metrics for
       # the workflow events. May be `regenerate`, `fixit`, or null which represents “do
-      # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+      # nothing”. Regenerate runs the user's input prompt with minor induced variance.
       # Fixit attempts to directly address the shortcomings of the output using the
       # guardrail failure rationale. Do nothing does not attempt any improvement.
       module ImprovementAction

data/rbi/deeprails/models/defend_submit_event_params.rbi

@@ -35,10 +35,6 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :model_used
 
-      # An optional, user-defined tag for the event.
-      sig { returns(String) }
-      attr_accessor :nametag
-
       # Run mode for the workflow event. The run mode allows the user to optimize for
       # speed, accuracy, and cost by determining which models are used to evaluate the
       # event. Available run modes include `precision_plus`, `precision`, `smart`, and
@@ -46,13 +42,20 @@ module Deeprails
       sig { returns(Deeprails::DefendSubmitEventParams::RunMode::OrSymbol) }
       attr_accessor :run_mode
 
+      # An optional, user-defined tag for the event.
+      sig { returns(T.nilable(String)) }
+      attr_reader :nametag
+
+      sig { params(nametag: String).void }
+      attr_writer :nametag
+
       sig do
         params(
           model_input: Deeprails::DefendSubmitEventParams::ModelInput::OrHash,
           model_output: String,
           model_used: String,
-          nametag: String,
           run_mode: Deeprails::DefendSubmitEventParams::RunMode::OrSymbol,
+          nametag: String,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -65,13 +68,13 @@ module Deeprails
         model_output:,
         # Model ID used to generate the output, like `gpt-4o` or `o3`.
         model_used:,
-        # An optional, user-defined tag for the event.
-        nametag:,
         # Run mode for the workflow event. The run mode allows the user to optimize for
         # speed, accuracy, and cost by determining which models are used to evaluate the
         # event. Available run modes include `precision_plus`, `precision`, `smart`, and
         # `economy`. Defaults to `smart`.
         run_mode:,
+        # An optional, user-defined tag for the event.
+        nametag: nil,
         request_options: {}
       )
       end
@@ -82,8 +85,8 @@ module Deeprails
             model_input: Deeprails::DefendSubmitEventParams::ModelInput,
             model_output: String,
             model_used: String,
-            nametag: String,
             run_mode: Deeprails::DefendSubmitEventParams::RunMode::OrSymbol,
+            nametag: String,
             request_options: Deeprails::RequestOptions
           }
         )

data/rbi/deeprails/models/defend_update_workflow_params.rbi

@@ -28,24 +28,10 @@ module Deeprails
       sig { params(name: String).void }
       attr_writer :name
 
-      # Type of thresholds to use for the workflow, either `automatic` or `custom`.
-      sig do
-        returns(
-          T.nilable(Deeprails::DefendUpdateWorkflowParams::Type::OrSymbol)
-        )
-      end
-      attr_reader :type
-
-      sig do
-        params(type: Deeprails::DefendUpdateWorkflowParams::Type::OrSymbol).void
-      end
-      attr_writer :type
-
       sig do
         params(
           description: String,
           name: String,
-          type: Deeprails::DefendUpdateWorkflowParams::Type::OrSymbol,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -54,8 +40,6 @@ module Deeprails
         description: nil,
         # Name of the workflow.
         name: nil,
-        # Type of thresholds to use for the workflow, either `automatic` or `custom`.
-        type: nil,
         request_options: {}
       )
       end
@@ -65,43 +49,12 @@ module Deeprails
           {
             description: String,
             name: String,
-            type: Deeprails::DefendUpdateWorkflowParams::Type::OrSymbol,
             request_options: Deeprails::RequestOptions
           }
         )
       end
       def to_hash
       end
-
-      # Type of thresholds to use for the workflow, either `automatic` or `custom`.
-      module Type
-        extend Deeprails::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Deeprails::DefendUpdateWorkflowParams::Type)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        AUTOMATIC =
-          T.let(
-            :automatic,
-            Deeprails::DefendUpdateWorkflowParams::Type::TaggedSymbol
-          )
-        CUSTOM =
-          T.let(
-            :custom,
-            Deeprails::DefendUpdateWorkflowParams::Type::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Deeprails::DefendUpdateWorkflowParams::Type::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/deeprails/models/monitor_retrieve_response.rbi

@@ -15,7 +15,6 @@ module Deeprails
       sig { returns(T::Boolean) }
       attr_accessor :success
 
-      # Detailed response payload for retrieving a monitor and its evaluations.
       sig do
         returns(T.nilable(Deeprails::Models::MonitorRetrieveResponse::Data))
       end
@@ -47,7 +46,6 @@ module Deeprails
       def self.new(
         # Represents whether the request was completed successfully.
         success:,
-        # Detailed response payload for retrieving a monitor and its evaluations.
         data: nil,
         # The accompanying message for the request. Includes error details when
         # applicable.
@@ -149,7 +147,6 @@ module Deeprails
         sig { params(user_id: String).void }
         attr_writer :user_id
 
-        # Detailed response payload for retrieving a monitor and its evaluations.
         sig do
           params(
             monitor_id: String,

data/rbi/deeprails/models/monitor_submit_event_response.rbi

@@ -15,7 +15,6 @@ module Deeprails
       sig { returns(T::Boolean) }
       attr_accessor :success
 
-      # Response payload for monitor event operations.
       sig do
         returns(T.nilable(Deeprails::Models::MonitorSubmitEventResponse::Data))
       end
@@ -47,7 +46,6 @@ module Deeprails
       def self.new(
         # Represents whether the request was completed successfully.
         success:,
-        # Response payload for monitor event operations.
         data: nil,
         # The accompanying message for the request. Includes error details when
         # applicable.
@@ -95,7 +93,6 @@ module Deeprails
         sig { params(created_at: Time).void }
         attr_writer :created_at
 
-        # Response payload for monitor event operations.
         sig do
           params(
             evaluation_id: String,

data/rbi/deeprails/models/workflow_event_response.rbi

@@ -40,7 +40,6 @@ module Deeprails
       sig { params(filtered: T::Boolean).void }
       attr_writer :filtered
 
-      # Response payload for workflow event operations.
       sig do
         params(
           event_id: String,

data/rbi/deeprails/resources/defend.rbi

@@ -3,8 +3,8 @@
 module Deeprails
   module Resources
     class Defend
-      # Create a new guardrail workflow with optional guardrail thresholds and
-      # improvement actions.
+      # Use this endpoint to create a new guardrail workflow with optional guardrail
+      # thresholds and improvement actions
       sig do
         params(
           improvement_action:
@@ -24,7 +24,7 @@ module Deeprails
       def create_workflow(
         # The action used to improve outputs that fail one or guardrail metrics for the
         # workflow events. May be `regenerate`, `fixit`, or null which represents “do
-        # nothing”. ReGen runs the user's exact input prompt with minor induced variance.
+        # nothing”. Regenerate runs the user's input prompt with minor induced variance.
         # Fixit attempts to directly address the shortcomings of the output using the
         # guardrail failure rationale. Do nothing does not attempt any improvement.
         improvement_action:,
@@ -54,7 +54,7 @@ module Deeprails
       )
       end
 
-      # Retrieve a specific event of a guardrail workflow.
+      # Use this endpoint to retrieve a specific event of a guardrail workflow
       sig do
         params(
           event_id: String,
@@ -71,7 +71,7 @@ module Deeprails
       )
       end
 
-      # Retrieve the details for a specific guardrail workflow.
+      # Use this endpoint to retrieve the details for a specific defend workflow
       sig do
         params(
           workflow_id: String,
@@ -85,15 +85,16 @@ module Deeprails
       )
       end
 
-      # Submit a model input and output pair to a workflow for evaluation.
+      # Use this endpoint to submit a model input and output pair to a workflow for
+      # evaluation
       sig do
         params(
           workflow_id: String,
           model_input: Deeprails::DefendSubmitEventParams::ModelInput::OrHash,
           model_output: String,
           model_used: String,
-          nametag: String,
           run_mode: Deeprails::DefendSubmitEventParams::RunMode::OrSymbol,
+          nametag: String,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::WorkflowEventResponse)
       end
@@ -108,24 +109,23 @@ module Deeprails
         model_output:,
         # Model ID used to generate the output, like `gpt-4o` or `o3`.
         model_used:,
-        # An optional, user-defined tag for the event.
-        nametag:,
         # Run mode for the workflow event. The run mode allows the user to optimize for
         # speed, accuracy, and cost by determining which models are used to evaluate the
         # event. Available run modes include `precision_plus`, `precision`, `smart`, and
         # `economy`. Defaults to `smart`.
         run_mode:,
+        # An optional, user-defined tag for the event.
+        nametag: nil,
         request_options: {}
       )
       end
 
-      # Update an existing guardrail workflow.
+      # Use this endpoint to update an existing guardrail workflow
       sig do
         params(
           workflow_id: String,
           description: String,
           name: String,
-          type: Deeprails::DefendUpdateWorkflowParams::Type::OrSymbol,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::DefendResponse)
       end
@@ -136,8 +136,6 @@ module Deeprails
         description: nil,
         # Name of the workflow.
         name: nil,
-        # Type of thresholds to use for the workflow, either `automatic` or `custom`.
-        type: nil,
         request_options: {}
       )
       end

data/rbi/deeprails/resources/evaluate.rbi

@@ -43,7 +43,7 @@ module Deeprails
       )
       end
 
-      # Retrieve the evaluation record for a given evaluation ID.
+      # Use this endpoint to retrieve the evaluation record for a given evaluation ID
       sig do
         params(
           eval_id: String,

data/rbi/deeprails/resources/monitor.rbi

@@ -3,7 +3,8 @@
 module Deeprails
   module Resources
     class Monitor
-      # Create a new monitor to evaluate model inputs and outputs using guardrails.
+      # Use this endpoint to create a new monitor to evaluate model inputs and outputs
+      # using guardrails
       sig do
         params(
           name: String,
@@ -20,7 +21,8 @@ module Deeprails
       )
       end
 
-      # Retrieve the details and evaluations associated with a specific monitor.
+      # Use this endpoint to retrieve the details and evaluations associated with a
+      # specific monitor
       sig do
         params(
           monitor_id: String,
@@ -37,7 +39,8 @@ module Deeprails
       )
       end
 
-      # Update the name, description, or status of an existing monitor.
+      # Use this endpoint to update the name, description, or status of an existing
+      # monitor
       sig do
         params(
           monitor_id: String,
@@ -62,7 +65,8 @@ module Deeprails
       )
       end
 
-      # Submit a model input and output pair to a monitor for evaluation.
+      # Use this endpoint to submit a model input and output pair to a monitor for
+      # evaluation
       sig do
         params(
           monitor_id: String,

data/sig/deeprails/models/defend_submit_event_params.rbs

@@ -5,8 +5,8 @@ module Deeprails
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
-        nametag: String,
-        run_mode: Deeprails::Models::DefendSubmitEventParams::run_mode
+        run_mode: Deeprails::Models::DefendSubmitEventParams::run_mode,
+        nametag: String
       }
       & Deeprails::Internal::Type::request_parameters
 
@@ -20,16 +20,18 @@ module Deeprails
 
       attr_accessor model_used: String
 
-      attr_accessor nametag: String
-
       attr_accessor run_mode: Deeprails::Models::DefendSubmitEventParams::run_mode
 
+      attr_reader nametag: String?
+
+      def nametag=: (String) -> String
+
       def initialize: (
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
-        nametag: String,
         run_mode: Deeprails::Models::DefendSubmitEventParams::run_mode,
+        ?nametag: String,
         ?request_options: Deeprails::request_opts
       ) -> void
 
@@ -37,8 +39,8 @@ module Deeprails
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
-        nametag: String,
         run_mode: Deeprails::Models::DefendSubmitEventParams::run_mode,
+        nametag: String,
         request_options: Deeprails::RequestOptions
       }
 

data/sig/deeprails/models/defend_update_workflow_params.rbs

@@ -1,11 +1,7 @@
 module Deeprails
   module Models
     type defend_update_workflow_params =
-      {
-        description: String,
-        name: String,
-        type: Deeprails::Models::DefendUpdateWorkflowParams::type_
-      }
+      { description: String, name: String }
       & Deeprails::Internal::Type::request_parameters
 
     class DefendUpdateWorkflowParams < Deeprails::Internal::Type::BaseModel
@@ -20,36 +16,17 @@ module Deeprails
 
       def name=: (String) -> String
 
-      attr_reader type: Deeprails::Models::DefendUpdateWorkflowParams::type_?
-
-      def type=: (
-        Deeprails::Models::DefendUpdateWorkflowParams::type_
-      ) -> Deeprails::Models::DefendUpdateWorkflowParams::type_
-
       def initialize: (
         ?description: String,
         ?name: String,
-        ?type: Deeprails::Models::DefendUpdateWorkflowParams::type_,
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
         description: String,
         name: String,
-        type: Deeprails::Models::DefendUpdateWorkflowParams::type_,
         request_options: Deeprails::RequestOptions
       }
-
-      type type_ = :automatic | :custom
-
-      module Type
-        extend Deeprails::Internal::Type::Enum
-
-        AUTOMATIC: :automatic
-        CUSTOM: :custom
-
-        def self?.values: -> ::Array[Deeprails::Models::DefendUpdateWorkflowParams::type_]
-      end
     end
   end
 end

data/sig/deeprails/resources/defend.rbs

@@ -28,8 +28,8 @@ module Deeprails
         model_input: Deeprails::DefendSubmitEventParams::ModelInput,
         model_output: String,
         model_used: String,
-        nametag: String,
         run_mode: Deeprails::Models::DefendSubmitEventParams::run_mode,
+        ?nametag: String,
         ?request_options: Deeprails::request_opts
       ) -> Deeprails::WorkflowEventResponse
 
@@ -37,7 +37,6 @@ module Deeprails
         String workflow_id,
         ?description: String,
         ?name: String,
-        ?type: Deeprails::Models::DefendUpdateWorkflowParams::type_,
         ?request_options: Deeprails::request_opts
       ) -> Deeprails::DefendResponse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deeprails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Deeprails
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-07 00:00:00.000000000 Z
+date: 2025-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool