deeprails 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7192d4dabd071a76430b8c959bf2d81f4e8e669c3ff435b3e03137e571ccf6a
-  data.tar.gz: de4f603949d3e0e379c7c0f4549d9d96f776f0ce4a591bceabdc54eb4b957a21
+  metadata.gz: 586d8d76ef27fc2dcdf36e0670b4389719f16bcba5f429563d818d4bb5da826c
+  data.tar.gz: e04b9886b2027b4c28238ca165d6e651e17b69415767aac6cffdc52be7d63b3b
 SHA512:
-  metadata.gz: ba34997d3b6e6c383ee5570dc9bdfb4b39a88ab9b18749d15bb52c053fcd7b8cc5104382b5ea48cc23be05dbf98ede56d60edf0dc9997264c3d9323db35e6a34
-  data.tar.gz: d25c2b15590f995f3eb80ec2460c7888cc7f7359c6f5dc157cf582594b8ed813b0025fdc029c2128a2fa6b912e8338f139a8afba19a6067dd9fe15e43ed71b6c
+  metadata.gz: e9f780f6b48c4b1b057c9cef568f408e0cdbe8ab4b312b38d28cbb3857542482e71d33e6cfbbba1ca52ed150f5e19137e9fbe2e3c420ee11be0b3bd6760bb51f
+  data.tar.gz: 7d514066daa4ae3fa543e87966b195c31d835fb9a6dc211f5743c247dba1fef773ed9b67241a50f4805d18d6c2be5e0d8f1c20a67064f687be16044876286f5e

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.6.0 (2025-10-22)
+
+Full Changelog: [v0.5.0...v0.6.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.5.0...v0.6.0)
+
+### Features
+
+* **api:** update defend naming and data structures ([e345a29](https://github.com/deeprails/deeprails-ruby-sdk/commit/e345a293b74cc3bfedcfcf8b5d9c9a834f82a69b))
+
+## 0.5.0 (2025-10-20)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** readme example update ([4cdb59b](https://github.com/deeprails/deeprails-ruby-sdk/commit/4cdb59b5a0c9a5af34851fbd7885551a6253cf69))
+
 ## 0.4.0 (2025-10-16)
 
 Full Changelog: [v0.3.1...v0.4.0](https://github.com/deeprails/deeprails-ruby-sdk/compare/v0.3.1...v0.4.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.4.0"
+gem "deeprails", "~> 0.6.0"
 ```
 
 <!-- x-release-please-end -->
@@ -30,12 +30,7 @@ deeprails = Deeprails::Client.new(
   api_key: ENV["DEEPRAILS_API_KEY"] # This is the default and can be omitted
 )
 
-defend_response = deeprails.defend.create_workflow(
-  improvement_action: "fixit",
-  metrics: {completeness: 0.8, instruction_adherence: 0.75},
-  name: "Push Alert Workflow",
-  type: "custom"
-)
+defend_response = deeprails.defend.create_workflow(improvement_action: "fixit", name: "Push Alert Workflow", type: "custom")
 
 puts(defend_response.workflow_id)
 ```
@@ -46,12 +41,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(
-    improvement_action: "fixit",
-    metrics: {completeness: 0.8, instruction_adherence: 0.75},
-    name: "Push Alert Workflow",
-    type: "custom"
-  )
+  defend = deeprails.defend.create_workflow(improvement_action: "fixit", name: "Push Alert Workflow", type: "custom")
 rescue Deeprails::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -96,7 +86,6 @@ deeprails = Deeprails::Client.new(
 # Or, configure per-request:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
-  metrics: {completeness: 0.8, instruction_adherence: 0.75},
   name: "Push Alert Workflow",
   type: "custom",
   request_options: {max_retries: 5}
@@ -116,7 +105,6 @@ deeprails = Deeprails::Client.new(
 # Or, configure per-request:
 deeprails.defend.create_workflow(
   improvement_action: "fixit",
-  metrics: {completeness: 0.8, instruction_adherence: 0.75},
   name: "Push Alert Workflow",
   type: "custom",
   request_options: {timeout: 5}
@@ -153,7 +141,6 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 defend_response =
   deeprails.defend.create_workflow(
     improvement_action: "fixit",
-    metrics: {completeness: 0.8, instruction_adherence: 0.75},
     name: "Push Alert Workflow",
     type: "custom",
     request_options: {
@@ -201,29 +188,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-deeprails.defend.create_workflow(
-  improvement_action: "fixit",
-  metrics: {completeness: 0.8, instruction_adherence: 0.75},
-  name: "Push Alert Workflow",
-  type: "custom"
-)
+deeprails.defend.create_workflow(improvement_action: "fixit", name: "Push Alert Workflow", type: "custom")
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-deeprails.defend.create_workflow(
-  improvement_action: "fixit",
-  metrics: {completeness: 0.8, instruction_adherence: 0.75},
-  name: "Push Alert Workflow",
-  type: "custom"
-)
+deeprails.defend.create_workflow(improvement_action: "fixit", name: "Push Alert Workflow", type: "custom")
 
 # You can also splat a full Params class:
 params = Deeprails::DefendCreateWorkflowParams.new(
   improvement_action: "fixit",
-  metrics: {completeness: 0.8, instruction_adherence: 0.75},
   name: "Push Alert Workflow",
   type: "custom"
 )
@@ -235,11 +211,11 @@ deeprails.defend.create_workflow(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :regenerate
-puts(Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGENERATE)
+# :regen
+puts(Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGEN)
 
 # Revealed type: `T.all(Deeprails::DefendCreateWorkflowParams::ImprovementAction, Symbol)`
-T.reveal_type(Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGENERATE)
+T.reveal_type(Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGEN)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
@@ -247,13 +223,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(
-  improvement_action: Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGENERATE,
+  improvement_action: Deeprails::DefendCreateWorkflowParams::ImprovementAction::REGEN,
   # …
 )
 
 # Literal values are also permissible:
 deeprails.defend.create_workflow(
-  improvement_action: :regenerate,
+  improvement_action: :regen,
   # …
 )
 ```

data/lib/deeprails/models/defend_create_workflow_params.rb

@@ -9,25 +9,13 @@ 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”. 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.
+      #   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, nil]
-      required :improvement_action,
-               enum: -> { Deeprails::DefendCreateWorkflowParams::ImprovementAction },
-               nil?: true
-
-      # @!attribute metrics
-      #   Mapping of guardrail metrics to floating point threshold values. If the workflow
-      #   type is automatic, only the metric names are used (`automatic_tolerance`
-      #   determines thresholds). Possible metrics are `correctness`, `completeness`,
-      #   `instruction_adherence`, `context_adherence`, `ground_truth_adherence`, or
-      #   `comprehensive_safety`.
-      #
-      #   @return [Hash{Symbol=>Float}]
-      required :metrics, Deeprails::Internal::Type::HashOf[Float]
+      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction]
+      required :improvement_action, enum: -> { Deeprails::DefendCreateWorkflowParams::ImprovementAction }
 
       # @!attribute name
       #   Name of the workflow.
@@ -45,12 +33,23 @@ module Deeprails
       #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::Type]
       required :type, enum: -> { Deeprails::DefendCreateWorkflowParams::Type }
 
-      # @!attribute automatic_tolerance
-      #   Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
-      #   `high`. Ignored if `type` is `custom`.
+      # @!attribute automatic_hallucination_tolerance_levels
+      #   Mapping of guardrail metrics to hallucination tolerance levels (either `low`,
+      #   `medium`, or `high`). Possible metrics are `completeness`,
+      #   `instruction_adherence`, `context_adherence`, `ground_truth_adherence`, or
+      #   `comprehensive_safety`.
+      #
+      #   @return [Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}, nil]
+      optional :automatic_hallucination_tolerance_levels,
+               -> { Deeprails::Internal::Type::HashOf[enum: Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel] }
+
+      # @!attribute custom_hallucination_threshold_values
+      #   Mapping of guardrail metrics to floating point threshold values. Possible
+      #   metrics are `correctness`, `completeness`, `instruction_adherence`,
+      #   `context_adherence`, `ground_truth_adherence`, or `comprehensive_safety`.
       #
-      #   @return [Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticTolerance, nil]
-      optional :automatic_tolerance, enum: -> { Deeprails::DefendCreateWorkflowParams::AutomaticTolerance }
+      #   @return [Hash{Symbol=>Float}, nil]
+      optional :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
 
       # @!attribute description
       #   Description for the workflow.
@@ -58,43 +57,44 @@ module Deeprails
       #   @return [String, nil]
       optional :description, String
 
-      # @!attribute max_retries
+      # @!attribute max_improvement_attempt
       #   Max. number of improvement action retries until a given event passes the
       #   guardrails. Defaults to 10.
       #
       #   @return [Integer, nil]
-      optional :max_retries, Integer
+      optional :max_improvement_attempt, Integer
 
-      # @!method initialize(improvement_action:, metrics:, name:, type:, automatic_tolerance: nil, description: nil, max_retries: nil, request_options: {})
+      # @!method initialize(improvement_action:, name:, type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, max_improvement_attempt: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendCreateWorkflowParams} for more details.
       #
-      #   @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction, nil] The action used to improve outputs that fail one or guardrail metrics for the wo
-      #
-      #   @param metrics [Hash{Symbol=>Float}] Mapping of guardrail metrics to floating point threshold values. If the workflo
+      #   @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or guardrail metrics for the wo
       #
       #   @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 automatic_tolerance [Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticTolerance] Hallucination tolerance for automatic workflows; may be `low`, `medium`, or `hig
+      #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metrics to hallucination tolerance levels
+      #
+      #   @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metrics to floating point threshold values. Possible metric
       #
       #   @param description [String] Description for the workflow.
       #
-      #   @param max_retries [Integer] Max. number of improvement action retries until a given event passes the guardra
+      #   @param max_improvement_attempt [Integer] Max. number of improvement action retries until a given event passes the guardra
       #
       #   @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 `regenerate`, `fixit`, or null which represents “do
-      # 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.
+      # 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
 
-        REGENERATE = :regenerate
+        REGEN = :regen
         FIXIT = :fixit
+        DO_NOTHING = :do_nothing
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -115,9 +115,7 @@ module Deeprails
         #   @return [Array<Symbol>]
       end
 
-      # Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
-      # `high`. Ignored if `type` is `custom`.
-      module AutomaticTolerance
+      module AutomaticHallucinationToleranceLevel
         extend Deeprails::Internal::Type::Enum
 
         LOW = :low

data/lib/deeprails/models/defend_response.rb

@@ -30,20 +30,20 @@ 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”. 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.
+      #   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::DefendResponse::ImprovementAction, nil]
-      optional :improvement_action, enum: -> { Deeprails::DefendResponse::ImprovementAction }, nil?: true
+      optional :improvement_action, enum: -> { Deeprails::DefendResponse::ImprovementAction }
 
-      # @!attribute max_retries
+      # @!attribute max_improvement_attempt
       #   Max. number of improvement action retries until a given event passes the
       #   guardrails.
       #
       #   @return [Integer, nil]
-      optional :max_retries, Integer
+      optional :max_improvement_attempt, Integer
 
       # @!attribute modified_at
       #   The most recent time the workflow was modified in UTC.
@@ -52,7 +52,7 @@ module Deeprails
       optional :modified_at, Time
 
       # @!attribute status
-      #   Status of the selected workflow. May be `archived` or `active`. Archived
+      #   Status of the selected workflow. May be `inactive` or `active`. Inactive
       #   workflows will not accept events.
       #
       #   @return [Symbol, Deeprails::Models::DefendResponse::Status, nil]
@@ -64,7 +64,7 @@ module Deeprails
       #   @return [Float, nil]
       optional :success_rate, Float
 
-      # @!method initialize(name:, workflow_id:, created_at: nil, description: nil, improvement_action: nil, max_retries: nil, modified_at: nil, status: nil, success_rate: nil)
+      # @!method initialize(name:, workflow_id:, created_at: nil, description: nil, improvement_action: nil, max_improvement_attempt: nil, modified_at: nil, status: nil, success_rate: nil)
       #   Some parameter documentations has been truncated, see
       #   {Deeprails::Models::DefendResponse} for more details.
       #
@@ -76,41 +76,42 @@ module Deeprails
       #
       #   @param description [String] Description for the workflow.
       #
-      #   @param improvement_action [Symbol, Deeprails::Models::DefendResponse::ImprovementAction, nil] The action used to improve outputs that fail one or more guardrail metrics for t
+      #   @param improvement_action [Symbol, Deeprails::Models::DefendResponse::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
       #
-      #   @param max_retries [Integer] Max. number of improvement action retries until a given event passes the guardra
+      #   @param max_improvement_attempt [Integer] Max. number of improvement action retries until a given event passes the guardra
       #
       #   @param modified_at [Time] The most recent time the workflow was modified in UTC.
       #
-      #   @param status [Symbol, Deeprails::Models::DefendResponse::Status] Status of the selected workflow. May be `archived` or `active`. Archived workf
+      #   @param status [Symbol, Deeprails::Models::DefendResponse::Status] Status of the selected workflow. May be `inactive` or `active`. Inactive workf
       #
       #   @param success_rate [Float] Rate of events associated with this workflow that passed evaluation.
 
       # 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”. 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.
+      # 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.
       #
       # @see Deeprails::Models::DefendResponse#improvement_action
       module ImprovementAction
         extend Deeprails::Internal::Type::Enum
 
-        REGENERATE = :regenerate
+        REGEN = :regen
         FIXIT = :fixit
+        DO_NOTHING = :do_nothing
 
         # @!method self.values
         #   @return [Array<Symbol>]
       end
 
-      # Status of the selected workflow. May be `archived` or `active`. Archived
+      # Status of the selected workflow. May be `inactive` or `active`. Inactive
       # workflows will not accept events.
       #
       # @see Deeprails::Models::DefendResponse#status
       module Status
         extend Deeprails::Internal::Type::Enum
 
-        ARCHIVED = :archived
+        INACTIVE = :inactive
         ACTIVE = :active
 
         # @!method self.values

data/lib/deeprails/models/defend_submit_event_params.rb

@@ -9,7 +9,7 @@ module Deeprails
 
       # @!attribute model_input
       #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   contain at least `user_prompt` or `system_prompt` field. For
       #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::DefendSubmitEventParams::ModelInput]
@@ -79,7 +79,7 @@ module Deeprails
 
         # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
         #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   contain at least `user_prompt` or `system_prompt` field. For
         #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         #
         #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.

data/lib/deeprails/models/evaluate_create_params.rb

@@ -9,7 +9,7 @@ module Deeprails
 
       # @!attribute model_input
       #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   contain at least `user_prompt` or `system_prompt` field. For
       #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::EvaluateCreateParams::ModelInput]
@@ -90,7 +90,7 @@ module Deeprails
 
         # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
         #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   contain at least `user_prompt` or `system_prompt` field. For
         #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         #
         #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.

data/lib/deeprails/models/evaluation.rb

@@ -18,7 +18,7 @@ module Deeprails
 
       # @!attribute model_input
       #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   contain at least `user_prompt` or `system_prompt` field. For
       #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::Evaluation::ModelInput]
@@ -189,7 +189,7 @@ module Deeprails
 
         # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
         #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   contain at least `user_prompt` or `system_prompt` field. For
         #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         #
         #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.

data/lib/deeprails/models/monitor_submit_event_params.rb

@@ -19,7 +19,7 @@ module Deeprails
 
       # @!attribute model_input
       #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-      #   contain at least one of `user_prompt` or `system_prompt`. For
+      #   contain at least a `user_prompt` or `system_prompt` field. For
       #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
       #
       #   @return [Deeprails::Models::MonitorSubmitEventParams::ModelInput]
@@ -105,7 +105,7 @@ module Deeprails
 
         # @!method initialize(ground_truth: nil, system_prompt: nil, user_prompt: nil)
         #   A dictionary of inputs sent to the LLM to generate output. The dictionary must
-        #   contain at least one of `user_prompt` or `system_prompt`. For
+        #   contain at least a `user_prompt` or `system_prompt` field. For
         #   ground_truth_aherence guadrail metric, `ground_truth` should be provided.
         #
         #   @param ground_truth [String] The ground truth for evaluating Ground Truth Adherence guardrail.

data/lib/deeprails/resources/defend.rb

@@ -9,21 +9,21 @@ module Deeprails
       # 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: {})
+      # @overload create_workflow(improvement_action:, name:, type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, max_improvement_attempt: nil, request_options: {})
       #
-      # @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction, nil] The action used to improve outputs that fail one or guardrail metrics for the wo
-      #
-      # @param metrics [Hash{Symbol=>Float}] Mapping of guardrail metrics to floating point threshold values. If the workflo
+      # @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or guardrail metrics for the wo
       #
       # @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 automatic_tolerance [Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticTolerance] Hallucination tolerance for automatic workflows; may be `low`, `medium`, or `hig
+      # @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metrics to hallucination tolerance levels
+      #
+      # @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metrics to floating point threshold values. Possible metric
       #
       # @param description [String] Description for the workflow.
       #
-      # @param max_retries [Integer] Max. number of improvement action retries until a given event passes the guardra
+      # @param max_improvement_attempt [Integer] Max. number of improvement action retries until a given event passes the guardra
       #
       # @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.4.0"
+  VERSION = "0.6.0"
 end