deeprails 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d0bb2bc489ff93e8154059bdae38683517ce5236f83cef8526137d119d16860
-  data.tar.gz: 5e50572d0197927215cd8bd5742a19f8bbf1fdc13f4bf02466b5db2024424e5a
+  metadata.gz: 54176c43a05bdde5394a3f0f01c37c0f1485e5e29049174c0d480debcd6b5f04
+  data.tar.gz: 8bd890ce30a2c75f3abc6e46261f7df60179bc4d2802a44db4eb27e1fb6e4bf7
 SHA512:
-  metadata.gz: 7d54b53af12982fa3338176f2344ff4692a6956e46086c4c43aaf030d58a36ed1b573038eaf81fcf8b52bc180bc8a2e54fda1d000120eaf3fea94eaae8124788
-  data.tar.gz: 2b7636cfdaf35d9efe26cfecb6f8bc3340620c9ef4e35747023bfe79bec11fb732083633865f8d4d68d3fa34f4df8b226841f91f8e9f97e40c06c5d8d059ac11
+  metadata.gz: 2ee61755f2763bbdf7b29e5a2c9f2890863c85e16e5a32175251360f21ccb6128c1af96ac04feb026c00ee19ad0a5fc631c382e9a8a91c0af7e1cb485795093e
+  data.tar.gz: 1509a75d3b7a7565fe47ab1cb831de2445eaa8c08769b78f3d66d13ab9530752d8b1d41898d495b77aac678e4d7aaac59c58bde46a491bff8ea036bc2cca5826

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.18.0 (2025-11-20)
+
+Full Changelog: [v0.17.0...v0.18.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.17.0...v0.18.0)
+
+### Features
+
+* **api:** fix files upload parameter ([65d38fa](https://github.com/deeprails/deeprails-ruby-sdk/commit/65d38fa89d23857fad01820282af44e8f5a63458))
+* **api:** Minor changes and updates to examples ([4b690d4](https://github.com/deeprails/deeprails-ruby-sdk/commit/4b690d41df9fa9ad16c34015fb806a9a7ce83bd7))
+
+## 0.17.0 (2025-11-19)
+
+Full Changelog: [v0.16.0...v0.17.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.16.0...v0.17.0)
+
+### Features
+
+* **api:** update package name casing ([94dcce7](https://github.com/deeprails/deeprails-ruby-sdk/commit/94dcce764af00fa51541e4fb2217eb2e743efe61))
+
 ## 0.16.0 (2025-11-18)
 
 Full Changelog: [v0.15.0...v0.16.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.15.0...v0.16.0)

data/README.md

@@ -1,6 +1,6 @@
-# Deeprails Ruby API library
+# DeepRails Ruby API library
 
-The Deeprails Ruby library provides convenient access to the Deeprails REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/deeprails/deeprails-ruby-sdk#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+The DeepRails Ruby library provides convenient access to the DeepRails REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/deeprails/deeprails-ruby-sdk#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 ## Documentation
 
@@ -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.16.0"
+gem "deeprails", "~> 0.18.0"
 ```
 
 <!-- x-release-please-end -->
@@ -26,11 +26,11 @@ gem "deeprails", "~> 0.16.0"
 require "bundler/setup"
 require "deeprails"
 
-deeprails = Deeprails::Client.new(
+deep_rails = Deeprails::Client.new(
   api_key: ENV["DEEPRAILS_API_KEY"] # This is the default and can be omitted
 )
 
-defend_create_response = deeprails.defend.create_workflow(
+defend_create_response = deep_rails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
   threshold_type: "custom",
@@ -47,7 +47,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  defend = deeprails.defend.create_workflow(
+  defend = deep_rails.defend.create_workflow(
     improvement_action: "fixit",
     name: "Push Alert Workflow",
     threshold_type: "custom",
@@ -91,12 +91,12 @@ You can use the `max_retries` option to configure or disable this:
 
 ```ruby
 # Configure the default for all requests:
-deeprails = Deeprails::Client.new(
+deep_rails = Deeprails::Client.new(
   max_retries: 0 # default is 2
 )
 
 # Or, configure per-request:
-deeprails.defend.create_workflow(
+deep_rails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
   threshold_type: "custom",
@@ -112,12 +112,12 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 
 ```ruby
 # Configure the default for all requests:
-deeprails = Deeprails::Client.new(
+deep_rails = Deeprails::Client.new(
   timeout: nil # default is 60
 )
 
 # Or, configure per-request:
-deeprails.defend.create_workflow(
+deep_rails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
   threshold_type: "custom",
@@ -155,7 +155,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 
 ```ruby
 defend_create_response =
-  deeprails.defend.create_workflow(
+  deep_rails.defend.create_workflow(
     improvement_action: "fixit",
     name: "Push Alert Workflow",
     threshold_type: "custom",
@@ -206,7 +206,7 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-deeprails.defend.create_workflow(
+deep_rails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
   threshold_type: "custom",
@@ -219,7 +219,7 @@ Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-deeprails.defend.create_workflow(
+deep_rails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
   threshold_type: "custom",
@@ -235,7 +235,7 @@ params = Deeprails::DefendCreateWorkflowParams.new(
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
   web_search: true
 )
-deeprails.defend.create_workflow(**params)
+deep_rails.defend.create_workflow(**params)
 ```
 
 ### Enums
@@ -254,13 +254,13 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-deeprails.defend.create_workflow(
+deep_rails.defend.create_workflow(
   improvement_action: Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGEN,
   # …
 )
 
 # Literal values are also permissible:
-deeprails.defend.create_workflow(
+deep_rails.defend.create_workflow(
   improvement_action: :regen,
   # …
 )

data/SECURITY.md

@@ -16,9 +16,9 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Deeprails, please follow the respective company's security reporting guidelines.
+or products provided by Deep Rails, please follow the respective company's security reporting guidelines.
 
-### Deeprails Terms and Policies
+### Deep Rails Terms and Policies
 
 Please contact support@deeprails.ai for any questions or concerns regarding the security of our services.
 

data/lib/deeprails/client.rb

@@ -41,7 +41,7 @@ module Deeprails
     # @param api_key [String, nil] Defaults to `ENV["DEEPRAILS_API_KEY"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
-    # `"https://api.example.com/v2/"`. Defaults to `ENV["DEEPRAILS_BASE_URL"]`
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["DEEP_RAILS_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -52,7 +52,7 @@ module Deeprails
     # @param max_retry_delay [Float]
     def initialize(
       api_key: ENV["DEEPRAILS_API_KEY"],
-      base_url: ENV["DEEPRAILS_BASE_URL"],
+      base_url: ENV["DEEP_RAILS_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,

data/lib/deeprails/models/defend_response.rb

@@ -78,7 +78,7 @@ module Deeprails
       required :updated_at, Time
 
       # @!attribute workflow_id
-      #   A unique workflow ID.
+      #   A unique workflow ID used to identify the workflow in other endpoints.
       #
       #   @return [String]
       required :workflow_id, String
@@ -121,7 +121,7 @@ module Deeprails
       #
       #   @param updated_at [Time] The most recent time the workflow was updated in UTC.
       #
-      #   @param workflow_id [String] A unique workflow ID.
+      #   @param workflow_id [String] A unique workflow ID used to identify the workflow in other endpoints.
       #
       #   @param improvement_action [Symbol, Deeprails::Models::DefendResponse::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
       #

data/lib/deeprails/models/file_upload_params.rb

@@ -7,14 +7,14 @@ module Deeprails
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
-      # @!attribute file
-      #   The contents of the file to upload.
+      # @!attribute files
+      #   The contents of the files to upload.
       #
       #   @return [Array<String>]
-      required :file, Deeprails::Internal::Type::ArrayOf[String]
+      required :files, Deeprails::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(file:, request_options: {})
-      #   @param file [Array<String>] The contents of the file to upload.
+      # @!method initialize(files:, request_options: {})
+      #   @param files [Array<String>] The contents of the files to upload.
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/deeprails/models/monitor_detail_response.rb

@@ -159,8 +159,8 @@ module Deeprails
         optional :evaluation_total_cost, Float
 
         # @!attribute guardrail_metrics
-        #   An array of guardrail metrics that the model input and output pair will be
-        #   evaluated on.
+        #   An array of guardrail metrics that the input and output pair will be evaluated
+        #   on.
         #
         #   @return [Array<Symbol, Deeprails::Models::MonitorDetailResponse::Evaluation::GuardrailMetric>, nil]
         optional :guardrail_metrics,
@@ -199,7 +199,7 @@ module Deeprails
         #
         #   @param evaluation_total_cost [Float] Total cost of the evaluation.
         #
-        #   @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 guardrail_metrics [Array<Symbol, Deeprails::Models::MonitorDetailResponse::Evaluation::GuardrailMetric>] An array of guardrail metrics that the input and output pair will be evaluated o
         #
         #   @param nametag [String] An optional, user-defined tag for the evaluation.
         #

data/lib/deeprails/models/workflow_event_detail_response.rb

@@ -24,12 +24,6 @@ module Deeprails
       #   @return [String]
       required :event_id, String
 
-      # @!attribute event_status
-      #   Status of the event.
-      #
-      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EventStatus]
-      required :event_status, enum: -> { Deeprails::WorkflowEventDetailResponse::EventStatus }
-
       # @!attribute filtered
       #   Whether the event was filtered and requires improvement.
       #
@@ -57,6 +51,12 @@ module Deeprails
                enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus },
                nil?: true
 
+      # @!attribute status
+      #   Status of the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::Status]
+      required :status, enum: -> { Deeprails::WorkflowEventDetailResponse::Status }
+
       # @!attribute threshold_type
       #   Type of thresholds used to evaluate the event.
       #
@@ -99,7 +99,7 @@ module Deeprails
       #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::File>, nil]
       optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::File] }
 
-      # @!method initialize(evaluation_history:, evaluation_result:, event_id:, event_status:, filtered:, improved_model_output:, improvement_action:, improvement_tool_status:, threshold_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, files: nil)
+      # @!method initialize(evaluation_history:, evaluation_result:, event_id:, filtered:, improved_model_output:, improvement_action:, improvement_tool_status:, status:, threshold_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, files: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::WorkflowEventDetailResponse} for more details.
       #
@@ -109,8 +109,6 @@ module Deeprails
       #
       #   @param event_id [String] A unique workflow event ID.
       #
-      #   @param event_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EventStatus] Status of the event.
-      #
       #   @param filtered [Boolean] Whether the event was filtered and requires improvement.
       #
       #   @param improved_model_output [String] Improved model output after improvement tool was applied and each metric passed
@@ -119,6 +117,8 @@ module Deeprails
       #
       #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil] Status of the improvement tool used to improve the event.
       #
+      #   @param status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::Status] Status of the event.
+      #
       #   @param threshold_type [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType] Type of thresholds used to evaluate the event.
       #
       #   @param workflow_id [String] Workflow ID associated with the event.
@@ -213,19 +213,6 @@ module Deeprails
         #   @param run_mode [String]
       end
 
-      # Status of the event.
-      #
-      # @see Deeprails::Models::WorkflowEventDetailResponse#event_status
-      module EventStatus
-        extend Deeprails::Internal::Type::Enum
-
-        IN_PROGRESS = :"In Progress"
-        COMPLETED = :Completed
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # Type of improvement action used to improve the event.
       #
       # @see Deeprails::Models::WorkflowEventDetailResponse#improvement_action
@@ -254,6 +241,19 @@ module Deeprails
         #   @return [Array<Symbol>]
       end
 
+      # Status of the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        IN_PROGRESS = :"In Progress"
+        COMPLETED = :Completed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # Type of thresholds used to evaluate the event.
       #
       # @see Deeprails::Models::WorkflowEventDetailResponse#threshold_type

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.
       #
-      # Use this endpoint to create a new guardrail workflow with optional guardrail
-      # thresholds and improvement actions
+      # Use this endpoint to create a new guardrail workflow by specifying guardrail
+      # thresholds, an improvement action, and optional extended capabilities.
       #
       # @overload create_workflow(improvement_action:, name:, threshold_type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {})
       #
@@ -135,7 +135,7 @@ module Deeprails
         )
       end
 
-      # Use this endpoint to update an existing defend workflow
+      # Use this endpoint to update an existing defend workflow if its details change.
       #
       # @overload update_workflow(workflow_id, description: nil, name: nil, request_options: {})
       #

data/lib/deeprails/resources/files.rb

@@ -5,9 +5,9 @@ module Deeprails
     class Files
       # Use this endpoint to upload a file to the DeepRails API
       #
-      # @overload upload(file:, request_options: {})
+      # @overload upload(files:, request_options: {})
       #
-      # @param file [Array<String>] The contents of the file to upload.
+      # @param files [Array<String>] The contents of the files to upload.
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/deeprails/version.rb

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

data/rbi/deeprails/client.rbi

@@ -42,8 +42,8 @@ module Deeprails
       # Defaults to `ENV["DEEPRAILS_API_KEY"]`
       api_key: ENV["DEEPRAILS_API_KEY"],
       # Override the default base URL for the API, e.g.,
-      # `"https://api.example.com/v2/"`. Defaults to `ENV["DEEPRAILS_BASE_URL"]`
-      base_url: ENV["DEEPRAILS_BASE_URL"],
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["DEEP_RAILS_BASE_URL"]`
+      base_url: ENV["DEEP_RAILS_BASE_URL"],
       # Max number of retries to attempt after a failed retryable request.
       max_retries: Deeprails::Client::DEFAULT_MAX_RETRIES,
       timeout: Deeprails::Client::DEFAULT_TIMEOUT_IN_SECONDS,

data/rbi/deeprails/models/defend_response.rbi

@@ -65,7 +65,7 @@ module Deeprails
       sig { returns(Time) }
       attr_accessor :updated_at
 
-      # A unique workflow ID.
+      # A unique workflow ID used to identify the workflow in other endpoints.
       sig { returns(String) }
       attr_accessor :workflow_id
 
@@ -144,7 +144,7 @@ module Deeprails
         threshold_type:,
         # The most recent time the workflow was updated in UTC.
         updated_at:,
-        # A unique workflow ID.
+        # A unique workflow ID used to identify the workflow in other endpoints.
         workflow_id:,
         # The action used to improve outputs that fail one or more guardrail metrics for
         # the workflow events.

data/rbi/deeprails/models/file_upload_params.rbi

@@ -11,26 +11,29 @@ module Deeprails
           T.any(Deeprails::FileUploadParams, Deeprails::Internal::AnyHash)
         end
 
-      # The contents of the file to upload.
+      # The contents of the files to upload.
       sig { returns(T::Array[String]) }
-      attr_accessor :file
+      attr_accessor :files
 
       sig do
         params(
-          file: T::Array[String],
+          files: T::Array[String],
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The contents of the file to upload.
-        file:,
+        # The contents of the files to upload.
+        files:,
         request_options: {}
       )
       end
 
       sig do
         override.returns(
-          { file: T::Array[String], request_options: Deeprails::RequestOptions }
+          {
+            files: T::Array[String],
+            request_options: Deeprails::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/deeprails/models/monitor_detail_response.rbi

@@ -227,8 +227,8 @@ module Deeprails
         sig { params(evaluation_total_cost: Float).void }
         attr_writer :evaluation_total_cost
 
-        # An array of guardrail metrics that the model input and output pair will be
-        # evaluated on.
+        # An array of guardrail metrics that the input and output pair will be evaluated
+        # on.
         sig do
           returns(
             T.nilable(
@@ -307,8 +307,8 @@ module Deeprails
           evaluation_result: nil,
           # Total cost of the evaluation.
           evaluation_total_cost: nil,
-          # An array of guardrail metrics that the model input and output pair will be
-          # evaluated on.
+          # An array of guardrail metrics that the input and output pair will be evaluated
+          # on.
           guardrail_metrics: nil,
           # An optional, user-defined tag for the evaluation.
           nametag: nil,

data/rbi/deeprails/models/workflow_event_detail_response.rbi

@@ -28,14 +28,6 @@ module Deeprails
       sig { returns(String) }
       attr_accessor :event_id
 
-      # Status of the event.
-      sig do
-        returns(
-          Deeprails::WorkflowEventDetailResponse::EventStatus::TaggedSymbol
-        )
-      end
-      attr_accessor :event_status
-
       # Whether the event was filtered and requires improvement.
       sig { returns(T::Boolean) }
       attr_accessor :filtered
@@ -63,6 +55,12 @@ module Deeprails
       end
       attr_accessor :improvement_tool_status
 
+      # Status of the event.
+      sig do
+        returns(Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol)
+      end
+      attr_accessor :status
+
       # Type of thresholds used to evaluate the event.
       sig do
         returns(
@@ -155,8 +153,6 @@ module Deeprails
             ],
           evaluation_result: T::Hash[Symbol, T.anything],
           event_id: String,
-          event_status:
-            Deeprails::WorkflowEventDetailResponse::EventStatus::OrSymbol,
           filtered: T::Boolean,
           improved_model_output: String,
           improvement_action:
@@ -165,6 +161,7 @@ module Deeprails
             T.nilable(
               Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::OrSymbol
             ),
+          status: Deeprails::WorkflowEventDetailResponse::Status::OrSymbol,
           threshold_type:
             Deeprails::WorkflowEventDetailResponse::ThresholdType::OrSymbol,
           workflow_id: String,
@@ -189,8 +186,6 @@ module Deeprails
         evaluation_result:,
         # A unique workflow event ID.
         event_id:,
-        # Status of the event.
-        event_status:,
         # Whether the event was filtered and requires improvement.
         filtered:,
         # Improved model output after improvement tool was applied and each metric passed
@@ -200,6 +195,8 @@ module Deeprails
         improvement_action:,
         # Status of the improvement tool used to improve the event.
         improvement_tool_status:,
+        # Status of the event.
+        status:,
         # Type of thresholds used to evaluate the event.
         threshold_type:,
         # Workflow ID associated with the event.
@@ -228,8 +225,6 @@ module Deeprails
               ],
             evaluation_result: T::Hash[Symbol, T.anything],
             event_id: String,
-            event_status:
-              Deeprails::WorkflowEventDetailResponse::EventStatus::TaggedSymbol,
             filtered: T::Boolean,
             improved_model_output: String,
             improvement_action:
@@ -238,6 +233,8 @@ module Deeprails
               T.nilable(
                 Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus::TaggedSymbol
               ),
+            status:
+              Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol,
             threshold_type:
               Deeprails::WorkflowEventDetailResponse::ThresholdType::TaggedSymbol,
             workflow_id: String,
@@ -400,38 +397,6 @@ module Deeprails
         end
       end
 
-      # Status of the event.
-      module EventStatus
-        extend Deeprails::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Deeprails::WorkflowEventDetailResponse::EventStatus)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        IN_PROGRESS =
-          T.let(
-            :"In Progress",
-            Deeprails::WorkflowEventDetailResponse::EventStatus::TaggedSymbol
-          )
-        COMPLETED =
-          T.let(
-            :Completed,
-            Deeprails::WorkflowEventDetailResponse::EventStatus::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Deeprails::WorkflowEventDetailResponse::EventStatus::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
       # Type of improvement action used to improve the event.
       module ImprovementAction
         extend Deeprails::Internal::Type::Enum
@@ -512,6 +477,38 @@ module Deeprails
         end
       end
 
+      # Status of the event.
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Deeprails::WorkflowEventDetailResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IN_PROGRESS =
+          T.let(
+            :"In Progress",
+            Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(
+            :Completed,
+            Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Deeprails::WorkflowEventDetailResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Type of thresholds used to evaluate the event.
       module ThresholdType
         extend Deeprails::Internal::Type::Enum

data/rbi/deeprails/resources/defend.rbi

@@ -3,8 +3,8 @@
 module Deeprails
   module Resources
     class Defend
-      # Use this endpoint to create a new guardrail workflow with optional guardrail
-      # thresholds and improvement actions
+      # Use this endpoint to create a new guardrail workflow by specifying guardrail
+      # thresholds, an improvement action, and optional extended capabilities.
       sig do
         params(
           improvement_action:
@@ -133,7 +133,7 @@ module Deeprails
       )
       end
 
-      # Use this endpoint to update an existing defend workflow
+      # Use this endpoint to update an existing defend workflow if its details change.
       sig do
         params(
           workflow_id: String,

data/rbi/deeprails/resources/files.rbi

@@ -6,13 +6,13 @@ module Deeprails
       # Use this endpoint to upload a file to the DeepRails API
       sig do
         params(
-          file: T::Array[String],
+          files: T::Array[String],
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::FileResponse)
       end
       def upload(
-        # The contents of the file to upload.
-        file:,
+        # The contents of the files to upload.
+        files:,
         request_options: {}
       )
       end

data/sig/deeprails/models/file_upload_params.rbs

@@ -1,21 +1,21 @@
 module Deeprails
   module Models
     type file_upload_params =
-      { file: ::Array[String] } & Deeprails::Internal::Type::request_parameters
+      { files: ::Array[String] } & Deeprails::Internal::Type::request_parameters
 
     class FileUploadParams < Deeprails::Internal::Type::BaseModel
       extend Deeprails::Internal::Type::RequestParameters::Converter
       include Deeprails::Internal::Type::RequestParameters
 
-      attr_accessor file: ::Array[String]
+      attr_accessor files: ::Array[String]
 
       def initialize: (
-        file: ::Array[String],
+        files: ::Array[String],
         ?request_options: Deeprails::request_opts
       ) -> void
 
       def to_hash: -> {
-        file: ::Array[String],
+        files: ::Array[String],
         request_options: Deeprails::RequestOptions
       }
     end

data/sig/deeprails/models/workflow_event_detail_response.rbs

@@ -5,11 +5,11 @@ module Deeprails
         evaluation_history: ::Array[Deeprails::WorkflowEventDetailResponse::EvaluationHistory],
         evaluation_result: ::Hash[Symbol, top],
         event_id: String,
-        event_status: Deeprails::Models::WorkflowEventDetailResponse::event_status,
         filtered: bool,
         improved_model_output: String,
         improvement_action: Deeprails::Models::WorkflowEventDetailResponse::improvement_action,
         improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?,
+        status: Deeprails::Models::WorkflowEventDetailResponse::status,
         threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type,
         workflow_id: String,
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::WorkflowEventDetailResponse::automatic_hallucination_tolerance_level],
@@ -25,8 +25,6 @@ module Deeprails
 
       attr_accessor event_id: String
 
-      attr_accessor event_status: Deeprails::Models::WorkflowEventDetailResponse::event_status
-
       attr_accessor filtered: bool
 
       attr_accessor improved_model_output: String
@@ -35,6 +33,8 @@ module Deeprails
 
       attr_accessor improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?
 
+      attr_accessor status: Deeprails::Models::WorkflowEventDetailResponse::status
+
       attr_accessor threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type
 
       attr_accessor workflow_id: String
@@ -67,11 +67,11 @@ module Deeprails
         evaluation_history: ::Array[Deeprails::WorkflowEventDetailResponse::EvaluationHistory],
         evaluation_result: ::Hash[Symbol, top],
         event_id: String,
-        event_status: Deeprails::Models::WorkflowEventDetailResponse::event_status,
         filtered: bool,
         improved_model_output: String,
         improvement_action: Deeprails::Models::WorkflowEventDetailResponse::improvement_action,
         improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?,
+        status: Deeprails::Models::WorkflowEventDetailResponse::status,
         threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type,
         workflow_id: String,
         ?automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::WorkflowEventDetailResponse::automatic_hallucination_tolerance_level],
@@ -84,11 +84,11 @@ module Deeprails
         evaluation_history: ::Array[Deeprails::WorkflowEventDetailResponse::EvaluationHistory],
         evaluation_result: ::Hash[Symbol, top],
         event_id: String,
-        event_status: Deeprails::Models::WorkflowEventDetailResponse::event_status,
         filtered: bool,
         improved_model_output: String,
         improvement_action: Deeprails::Models::WorkflowEventDetailResponse::improvement_action,
         improvement_tool_status: Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status?,
+        status: Deeprails::Models::WorkflowEventDetailResponse::status,
         threshold_type: Deeprails::Models::WorkflowEventDetailResponse::threshold_type,
         workflow_id: String,
         automatic_hallucination_tolerance_levels: ::Hash[Symbol, Deeprails::Models::WorkflowEventDetailResponse::automatic_hallucination_tolerance_level],
@@ -200,17 +200,6 @@ module Deeprails
         }
       end
 
-      type event_status = :"In Progress" | :Completed
-
-      module EventStatus
-        extend Deeprails::Internal::Type::Enum
-
-        IN_PROGRESS: :"In Progress"
-        COMPLETED: :Completed
-
-        def self?.values: -> ::Array[Deeprails::Models::WorkflowEventDetailResponse::event_status]
-      end
-
       type improvement_action = :regen | :fixit | :do_nothing
 
       module ImprovementAction
@@ -236,6 +225,17 @@ module Deeprails
         def self?.values: -> ::Array[Deeprails::Models::WorkflowEventDetailResponse::improvement_tool_status]
       end
 
+      type status = :"In Progress" | :Completed
+
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        IN_PROGRESS: :"In Progress"
+        COMPLETED: :Completed
+
+        def self?.values: -> ::Array[Deeprails::Models::WorkflowEventDetailResponse::status]
+      end
+
       type threshold_type = :custom | :automatic
 
       module ThresholdType

data/sig/deeprails/resources/files.rbs

@@ -2,7 +2,7 @@ module Deeprails
   module Resources
     class Files
       def upload: (
-        file: ::Array[String],
+        files: ::Array[String],
         ?request_options: Deeprails::request_opts
       ) -> Deeprails::FileResponse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deeprails
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
-- Deeprails
+- Deep Rails
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -199,5 +199,5 @@ requirements: []
 rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
-summary: Ruby library to access the Deeprails API
+summary: Ruby library to access the Deep Rails API
 test_files: []