deeprails 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27710c0ec0510319e5002b296aa2eecb635640fee1a38423cf43e8792abd1c9a
-  data.tar.gz: 372425505cca1a9bfea94c6adbe93c99cf13cfdf26ea4506ae934e0049486acd
+  metadata.gz: ee919b4b7355075fd7166bd63ffa82cb21d9593633f89ea46f07fc6ea9bba9e5
+  data.tar.gz: f7571dc221d9b1dfade476d9f82ec5ff6d6ff06210633d2b719c9fb187bb4e0b
 SHA512:
-  metadata.gz: 03e5bbb5226ef22805593349a2ccd1e4f888405bcb15b19eadc01fcd0e001d88a1b096ccfabc467f8b5cd6de6217d5dfc13122911a41b9866fb4467282e9d14f
-  data.tar.gz: 2bfd88ef33139e1ac30af2d3d4098e55061f6712736e61598908e972612cf1053eff0ba1cacc052c2a3e8522742617d320ae1fc471000ef9fc4f4749ad121fb8
+  metadata.gz: 66998c7bcb53ee7678e66375b37a9e7f71b0620f2c97891cf3f8f56196a15b3f4fa3f0e159403f7c5c09bd5a3fb36db0310c75137fe6ab9a29b0c535efcf270a
+  data.tar.gz: 6e8b371ff4bdaa0f8ed19edf9eb833e6a0813f48ea6f5d94d5a033ddd73745d96eac693cf0073d18f907d57790181e2c9b82601e30719e4531bc0131de67ea5d

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** Mass restructuring of API, including response bodies and naming schemes ([f52f6ee](https://github.com/deeprails/deeprails-ruby-sdk/commit/f52f6ee3484c15c0f403a2fd615552e6926d0626))
+
+
+### Bug Fixes
+
+* better thread safety via early initializing SSL store during HTTP client creation ([461a0a4](https://github.com/deeprails/deeprails-ruby-sdk/commit/461a0a45e6914b0376077215f353eb83685edc5f))
+
+
+### Chores
+
+* bump dependency version and update sorbet types ([444f9a0](https://github.com/deeprails/deeprails-ruby-sdk/commit/444f9a073d6a85bd83f64c201edfc2065f518bc8))
+
 ## 0.11.0 (2025-11-02)
 
 Full Changelog: [v0.10.0...v0.11.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.10.0...v0.11.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.11.0"
+gem "deeprails", "~> 0.12.0"
 ```
 
 <!-- x-release-please-end -->
@@ -30,38 +30,17 @@ deeprails = Deeprails::Client.new(
   api_key: ENV["DEEPRAILS_API_KEY"] # This is the default and can be omitted
 )
 
-defend_response = deeprails.defend.create_workflow(
+defend_create_response = deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  type: "custom",
-  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75}
+  threshold_type: "automatic",
+  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+  web_search: true
 )
 
-puts(defend_response.workflow_id)
+puts(defend_create_response.workflow_id)
 ```
 
-### File uploads
-
-Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
-
-```ruby
-require "pathname"
-
-# Use `Pathname` to send the filename and/or avoid paging a large file into memory:
-file_response = deeprails.files.upload(file: Pathname("/path/to/file"))
-
-# Alternatively, pass file contents or a `StringIO` directly:
-file_response = deeprails.files.upload(file: File.read("/path/to/file"))
-
-# Or, to control the filename and/or content type:
-file = Deeprails::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
-file_response = deeprails.files.upload(file: file)
-
-puts(file_response.file_id)
-```
-
-Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
-
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Deeprails::Errors::APIError` will be thrown:
@@ -71,8 +50,9 @@ begin
   defend = deeprails.defend.create_workflow(
     improvement_action: "fixit",
     name: "Push Alert Workflow",
-    type: "custom",
-    custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75}
+    threshold_type: "automatic",
+    custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+    web_search: true
   )
 rescue Deeprails::Errors::APIConnectionError => e
   puts("The server could not be reached")
@@ -119,8 +99,9 @@ deeprails = Deeprails::Client.new(
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  type: "custom",
+  threshold_type: "automatic",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+  web_search: true,
   request_options: {max_retries: 5}
 )
 ```
@@ -139,8 +120,9 @@ deeprails = Deeprails::Client.new(
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  type: "custom",
+  threshold_type: "automatic",
   custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+  web_search: true,
   request_options: {timeout: 5}
 )
 ```
@@ -172,12 +154,13 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-defend_response =
+defend_create_response =
   deeprails.defend.create_workflow(
     improvement_action: "fixit",
     name: "Push Alert Workflow",
-    type: "custom",
+    threshold_type: "automatic",
     custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+    web_search: true,
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -185,7 +168,7 @@ defend_response =
     }
   )
 
-puts(defend_response[:my_undocumented_property])
+puts(defend_create_response[:my_undocumented_property])
 ```
 
 #### Undocumented request params
@@ -226,8 +209,9 @@ You can provide typesafe request parameters like so:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  type: "custom",
-  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75}
+  threshold_type: "automatic",
+  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+  web_search: true
 )
 ```
 
@@ -238,16 +222,18 @@ Or, equivalently:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  type: "custom",
-  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75}
+  threshold_type: "automatic",
+  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+  web_search: true
 )
 
 # You can also splat a full Params class:
 params = Deeprails::DefendCreateWorkflowParams.new(
   improvement_action: "fixit",
   name: "Push Alert Workflow",
-  type: "custom",
-  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75}
+  threshold_type: "automatic",
+  custom_hallucination_threshold_values: {completeness: 0.7, instruction_adherence: 0.75},
+  web_search: true
 )
 deeprails.defend.create_workflow(**params)
 ```

data/lib/deeprails/internal/transport/base_client.rb

@@ -201,7 +201,8 @@ module Deeprails
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module Deeprails
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{Deeprails::VERSION}"
+
         # @api private
         #
         # @return [String]

data/lib/deeprails/internal/transport/pooled_net_requester.rb

@@ -16,10 +16,11 @@ module Deeprails
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module Deeprails
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module Deeprails
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -192,6 +195,7 @@ module Deeprails
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/deeprails/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module Deeprails
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `defend_response` is a `Deeprails::DefendResponse`
-        #   defend_response => {
-        #     name: name,
-        #     workflow_id: workflow_id,
-        #     created_at: created_at
+        #   # `defend_create_response` is a `Deeprails::DefendCreateResponse`
+        #   defend_create_response => {
+        #     created_at: created_at,
+        #     status: status,
+        #     workflow_id: workflow_id
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/deeprails/models/defend_create_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#create_workflow
+    class DefendCreateResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute created_at
+      #   The time the workflow was created in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute status
+      #   Status of the selected workflow. May be `inactive` or `active`. Inactive
+      #   workflows will not accept events.
+      #
+      #   @return [Symbol, Deeprails::Models::DefendCreateResponse::Status]
+      required :status, enum: -> { Deeprails::DefendCreateResponse::Status }
+
+      # @!attribute workflow_id
+      #   A unique workflow ID.
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!method initialize(created_at:, status:, workflow_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::DefendCreateResponse} for more details.
+      #
+      #   @param created_at [Time] The time the workflow was created in UTC.
+      #
+      #   @param status [Symbol, Deeprails::Models::DefendCreateResponse::Status] Status of the selected workflow. May be `inactive` or `active`. Inactive workf
+      #
+      #   @param workflow_id [String] A unique workflow ID.
+
+      # Status of the selected workflow. May be `inactive` or `active`. Inactive
+      # workflows will not accept events.
+      #
+      # @see Deeprails::Models::DefendCreateResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        INACTIVE = :inactive
+        ACTIVE = :active
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/deeprails/models/defend_create_workflow_params.rb

@@ -8,11 +8,11 @@ module Deeprails
       include Deeprails::Internal::Type::RequestParameters
 
       # @!attribute improvement_action
-      #   The action used to improve outputs that fail one or guardrail metrics for the
-      #   workflow events. May be `regen`, `fixit`, or `do_nothing`. ReGen 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.
+      #   The action used to improve outputs that fail one or more guardrail metrics for
+      #   the workflow events. May be `regen`, `fixit`, or `do_nothing`. ReGen 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.
       #
       #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction]
       required :improvement_action, enum: -> { Deeprails::DefendCreateWorkflowParams::ImprovementAction }
@@ -23,15 +23,15 @@ module Deeprails
       #   @return [String]
       required :name, String
 
-      # @!attribute type
+      # @!attribute threshold_type
       #   Type of thresholds to use for the workflow, either `automatic` or `custom`.
       #   Automatic thresholds are assigned internally after the user specifies a
       #   qualitative tolerance for the metrics, whereas custom metrics allow the user to
       #   set the threshold for each metric as a floating point number between 0.0 and
       #   1.0.
       #
-      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::Type]
-      required :type, enum: -> { Deeprails::DefendCreateWorkflowParams::Type }
+      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType]
+      required :threshold_type, enum: -> { Deeprails::DefendCreateWorkflowParams::ThresholdType }
 
       # @!attribute automatic_hallucination_tolerance_levels
       #   Mapping of guardrail metrics to hallucination tolerance levels (either `low`,
@@ -65,7 +65,7 @@ module Deeprails
       optional :file_search, Deeprails::Internal::Type::ArrayOf[String]
 
       # @!attribute max_improvement_attempts
-      #   Max. number of improvement action retries until a given event passes the
+      #   Max. number of improvement action attempts until a given event passes the
       #   guardrails. Defaults to 10.
       #
       #   @return [Integer, nil]
@@ -77,15 +77,15 @@ module Deeprails
       #   @return [Boolean, nil]
       optional :web_search, Deeprails::Internal::Type::Boolean
 
-      # @!method initialize(improvement_action:, name:, 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: {})
+      # @!method initialize(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: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendCreateWorkflowParams} for more details.
       #
-      #   @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or guardrail metrics for the wo
+      #   @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
       #
       #   @param name [String] Name of the workflow.
       #
-      #   @param type [Symbol, Deeprails::Models::DefendCreateWorkflowParams::Type] Type of thresholds to use for the workflow, either `automatic` or `custom`. Aut
+      #   @param threshold_type [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType] Type of thresholds to use for the workflow, either `automatic` or `custom`. Aut
       #
       #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metrics to hallucination tolerance levels
       #
@@ -95,17 +95,17 @@ module Deeprails
       #
       #   @param file_search [Array<String>] An array of file IDs to search in the workflow's evaluations. Files must be uplo
       #
-      #   @param max_improvement_attempts [Integer] Max. number of improvement action retries until a given event passes the guardra
+      #   @param max_improvement_attempts [Integer] Max. number of improvement action attempts until a given event passes the guardr
       #
       #   @param web_search [Boolean] Whether to enable web search for this workflow's evaluations. Defaults to false.
       #
       #   @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}]
 
-      # The action used to improve outputs that fail one or guardrail metrics for the
-      # workflow events. May be `regen`, `fixit`, or `do_nothing`. ReGen 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.
+      # The action used to improve outputs that fail one or more guardrail metrics for
+      # the workflow events. May be `regen`, `fixit`, or `do_nothing`. ReGen 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
         extend Deeprails::Internal::Type::Enum
 
@@ -122,7 +122,7 @@ module Deeprails
       # qualitative tolerance for the metrics, whereas custom metrics allow the user to
       # set the threshold for each metric as a floating point number between 0.0 and
       # 1.0.
-      module Type
+      module ThresholdType
         extend Deeprails::Internal::Type::Enum
 
         AUTOMATIC = :automatic