deeprails 0.4.0 → 0.6.0

data/rbi/deeprails/models/defend_create_workflow_params.rbi

@@ -15,27 +15,17 @@ module Deeprails
         end
 
       # 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.
       sig do
         returns(
-          T.nilable(
-            Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol
-          )
+          Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol
         )
       end
       attr_accessor :improvement_action
 
-      # 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`.
-      sig { returns(T::Hash[Symbol, Float]) }
-      attr_accessor :metrics
-
       # Name of the workflow.
       sig { returns(String) }
       attr_accessor :name
@@ -48,24 +38,45 @@ module Deeprails
       sig { returns(Deeprails::DefendCreateWorkflowParams::Type::OrSymbol) }
       attr_accessor :type
 
-      # Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
-      # `high`. Ignored if `type` is `custom`.
+      # 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`.
       sig do
         returns(
           T.nilable(
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::OrSymbol
+            T::Hash[
+              Symbol,
+              Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
+            ]
           )
         )
       end
-      attr_reader :automatic_tolerance
+      attr_reader :automatic_hallucination_tolerance_levels
 
       sig do
         params(
-          automatic_tolerance:
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::OrSymbol
+          automatic_hallucination_tolerance_levels:
+            T::Hash[
+              Symbol,
+              Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
+            ]
         ).void
       end
-      attr_writer :automatic_tolerance
+      attr_writer :automatic_hallucination_tolerance_levels
+
+      # Mapping of guardrail metrics to floating point threshold values. Possible
+      # metrics are `correctness`, `completeness`, `instruction_adherence`,
+      # `context_adherence`, `ground_truth_adherence`, or `comprehensive_safety`.
+      sig { returns(T.nilable(T::Hash[Symbol, Float])) }
+      attr_reader :custom_hallucination_threshold_values
+
+      sig do
+        params(
+          custom_hallucination_threshold_values: T::Hash[Symbol, Float]
+        ).void
+      end
+      attr_writer :custom_hallucination_threshold_values
 
       # Description for the workflow.
       sig { returns(T.nilable(String)) }
@@ -77,40 +88,35 @@ module Deeprails
       # Max. number of improvement action retries until a given event passes the
       # guardrails. Defaults to 10.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_retries
+      attr_reader :max_improvement_attempt
 
-      sig { params(max_retries: Integer).void }
-      attr_writer :max_retries
+      sig { params(max_improvement_attempt: Integer).void }
+      attr_writer :max_improvement_attempt
 
       sig do
         params(
           improvement_action:
-            T.nilable(
-              Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol
-            ),
-          metrics: T::Hash[Symbol, Float],
+            Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol,
           name: String,
           type: Deeprails::DefendCreateWorkflowParams::Type::OrSymbol,
-          automatic_tolerance:
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::OrSymbol,
+          automatic_hallucination_tolerance_levels:
+            T::Hash[
+              Symbol,
+              Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
+            ],
+          custom_hallucination_threshold_values: T::Hash[Symbol, Float],
           description: String,
-          max_retries: Integer,
+          max_improvement_attempt: Integer,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       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”. 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.
         improvement_action:,
-        # 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`.
-        metrics:,
         # Name of the workflow.
         name:,
         # Type of thresholds to use for the workflow, either `automatic` or `custom`.
@@ -119,14 +125,20 @@ module Deeprails
         # set the threshold for each metric as a floating point number between 0.0 and
         # 1.0.
         type:,
-        # Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
-        # `high`. Ignored if `type` is `custom`.
-        automatic_tolerance: nil,
+        # 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`.
+        automatic_hallucination_tolerance_levels: nil,
+        # Mapping of guardrail metrics to floating point threshold values. Possible
+        # metrics are `correctness`, `completeness`, `instruction_adherence`,
+        # `context_adherence`, `ground_truth_adherence`, or `comprehensive_safety`.
+        custom_hallucination_threshold_values: nil,
         # Description for the workflow.
         description: nil,
         # Max. number of improvement action retries until a given event passes the
         # guardrails. Defaults to 10.
-        max_retries: nil,
+        max_improvement_attempt: nil,
         request_options: {}
       )
       end
@@ -135,16 +147,17 @@ module Deeprails
         override.returns(
           {
             improvement_action:
-              T.nilable(
-                Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol
-              ),
-            metrics: T::Hash[Symbol, Float],
+              Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol,
             name: String,
             type: Deeprails::DefendCreateWorkflowParams::Type::OrSymbol,
-            automatic_tolerance:
-              Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::OrSymbol,
+            automatic_hallucination_tolerance_levels:
+              T::Hash[
+                Symbol,
+                Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
+              ],
+            custom_hallucination_threshold_values: T::Hash[Symbol, Float],
             description: String,
-            max_retries: Integer,
+            max_improvement_attempt: Integer,
             request_options: Deeprails::RequestOptions
           }
         )
@@ -153,10 +166,10 @@ module Deeprails
       end
 
       # 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
 
@@ -169,9 +182,9 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        REGENERATE =
+        REGEN =
           T.let(
-            :regenerate,
+            :regen,
             Deeprails::DefendCreateWorkflowParams::ImprovementAction::TaggedSymbol
           )
         FIXIT =
@@ -179,6 +192,11 @@ module Deeprails
             :fixit,
             Deeprails::DefendCreateWorkflowParams::ImprovementAction::TaggedSymbol
           )
+        DO_NOTHING =
+          T.let(
+            :do_nothing,
+            Deeprails::DefendCreateWorkflowParams::ImprovementAction::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -225,16 +243,14 @@ module Deeprails
         end
       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
 
         TaggedSymbol =
           T.type_alias do
             T.all(
               Symbol,
-              Deeprails::DefendCreateWorkflowParams::AutomaticTolerance
+              Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel
             )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -242,23 +258,23 @@ module Deeprails
         LOW =
           T.let(
             :low,
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::TaggedSymbol
+            Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::TaggedSymbol
           )
         MEDIUM =
           T.let(
             :medium,
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::TaggedSymbol
+            Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::TaggedSymbol
           )
         HIGH =
           T.let(
             :high,
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::TaggedSymbol
+            Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::TaggedSymbol
+              Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::TaggedSymbol
             ]
           )
         end

data/rbi/deeprails/models/defend_response.rbi

@@ -31,24 +31,32 @@ module Deeprails
       attr_writer :description
 
       # 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.
       sig do
         returns(
           T.nilable(Deeprails::DefendResponse::ImprovementAction::TaggedSymbol)
         )
       end
-      attr_accessor :improvement_action
+      attr_reader :improvement_action
+
+      sig do
+        params(
+          improvement_action:
+            Deeprails::DefendResponse::ImprovementAction::OrSymbol
+        ).void
+      end
+      attr_writer :improvement_action
 
       # Max. number of improvement action retries until a given event passes the
       # guardrails.
       sig { returns(T.nilable(Integer)) }
-      attr_reader :max_retries
+      attr_reader :max_improvement_attempt
 
-      sig { params(max_retries: Integer).void }
-      attr_writer :max_retries
+      sig { params(max_improvement_attempt: Integer).void }
+      attr_writer :max_improvement_attempt
 
       # The most recent time the workflow was modified in UTC.
       sig { returns(T.nilable(Time)) }
@@ -57,7 +65,7 @@ module Deeprails
       sig { params(modified_at: Time).void }
       attr_writer :modified_at
 
-      # 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.
       sig do
         returns(T.nilable(Deeprails::DefendResponse::Status::TaggedSymbol))
@@ -81,8 +89,8 @@ module Deeprails
           created_at: Time,
           description: String,
           improvement_action:
-            T.nilable(Deeprails::DefendResponse::ImprovementAction::OrSymbol),
-          max_retries: Integer,
+            Deeprails::DefendResponse::ImprovementAction::OrSymbol,
+          max_improvement_attempt: Integer,
           modified_at: Time,
           status: Deeprails::DefendResponse::Status::OrSymbol,
           success_rate: Float
@@ -98,17 +106,17 @@ module Deeprails
         # Description for the workflow.
         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”. 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.
         improvement_action: nil,
         # Max. number of improvement action retries until a given event passes the
         # guardrails.
-        max_retries: nil,
+        max_improvement_attempt: nil,
         # The most recent time the workflow was modified in UTC.
         modified_at: nil,
-        # 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.
         status: nil,
         # Rate of events associated with this workflow that passed evaluation.
@@ -124,10 +132,8 @@ module Deeprails
             created_at: Time,
             description: String,
             improvement_action:
-              T.nilable(
-                Deeprails::DefendResponse::ImprovementAction::TaggedSymbol
-              ),
-            max_retries: Integer,
+              Deeprails::DefendResponse::ImprovementAction::TaggedSymbol,
+            max_improvement_attempt: Integer,
             modified_at: Time,
             status: Deeprails::DefendResponse::Status::TaggedSymbol,
             success_rate: Float
@@ -138,10 +144,10 @@ module Deeprails
       end
 
       # 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.
       module ImprovementAction
         extend Deeprails::Internal::Type::Enum
 
@@ -151,9 +157,9 @@ module Deeprails
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        REGENERATE =
+        REGEN =
           T.let(
-            :regenerate,
+            :regen,
             Deeprails::DefendResponse::ImprovementAction::TaggedSymbol
           )
         FIXIT =
@@ -161,6 +167,11 @@ module Deeprails
             :fixit,
             Deeprails::DefendResponse::ImprovementAction::TaggedSymbol
           )
+        DO_NOTHING =
+          T.let(
+            :do_nothing,
+            Deeprails::DefendResponse::ImprovementAction::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -171,7 +182,7 @@ module Deeprails
         end
       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.
       module Status
         extend Deeprails::Internal::Type::Enum
@@ -180,8 +191,8 @@ module Deeprails
           T.type_alias { T.all(Symbol, Deeprails::DefendResponse::Status) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        ARCHIVED =
-          T.let(:archived, Deeprails::DefendResponse::Status::TaggedSymbol)
+        INACTIVE =
+          T.let(:inactive, Deeprails::DefendResponse::Status::TaggedSymbol)
         ACTIVE = T.let(:active, Deeprails::DefendResponse::Status::TaggedSymbol)
 
         sig do

data/rbi/deeprails/models/defend_submit_event_params.rbi

@@ -15,7 +15,7 @@ module Deeprails
         end
 
       # 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.
       sig { returns(Deeprails::DefendSubmitEventParams::ModelInput) }
       attr_reader :model_input
@@ -61,7 +61,7 @@ module Deeprails
       end
       def self.new(
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.
@@ -125,7 +125,7 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(

data/rbi/deeprails/models/evaluate_create_params.rbi

@@ -12,7 +12,7 @@ module Deeprails
         end
 
       # 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.
       sig { returns(Deeprails::EvaluateCreateParams::ModelInput) }
       attr_reader :model_input
@@ -85,7 +85,7 @@ module Deeprails
       end
       def self.new(
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.
@@ -157,7 +157,7 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(

data/rbi/deeprails/models/evaluation.rbi

@@ -17,7 +17,7 @@ module Deeprails
       attr_accessor :evaluation_status
 
       # 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.
       sig { returns(Deeprails::Evaluation::ModelInput) }
       attr_reader :model_input
@@ -162,7 +162,7 @@ module Deeprails
         # Status of the evaluation.
         evaluation_status:,
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.
@@ -298,7 +298,7 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(

data/rbi/deeprails/models/monitor_submit_event_params.rbi

@@ -28,7 +28,7 @@ module Deeprails
       attr_accessor :guardrail_metrics
 
       # 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.
       sig { returns(Deeprails::MonitorSubmitEventParams::ModelInput) }
       attr_reader :model_input
@@ -97,7 +97,7 @@ module Deeprails
         # `ground_truth_adherence`, and/or `comprehensive_safety`.
         guardrail_metrics:,
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.
@@ -216,7 +216,7 @@ module Deeprails
         attr_writer :user_prompt
 
         # 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.
         sig do
           params(

data/rbi/deeprails/resources/defend.rbi

@@ -8,32 +8,27 @@ module Deeprails
       sig do
         params(
           improvement_action:
-            T.nilable(
-              Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol
-            ),
-          metrics: T::Hash[Symbol, Float],
+            Deeprails::DefendCreateWorkflowParams::ImprovementAction::OrSymbol,
           name: String,
           type: Deeprails::DefendCreateWorkflowParams::Type::OrSymbol,
-          automatic_tolerance:
-            Deeprails::DefendCreateWorkflowParams::AutomaticTolerance::OrSymbol,
+          automatic_hallucination_tolerance_levels:
+            T::Hash[
+              Symbol,
+              Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel::OrSymbol
+            ],
+          custom_hallucination_threshold_values: T::Hash[Symbol, Float],
           description: String,
-          max_retries: Integer,
+          max_improvement_attempt: Integer,
           request_options: Deeprails::RequestOptions::OrHash
         ).returns(Deeprails::DefendResponse)
       end
       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”. 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.
         improvement_action:,
-        # 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`.
-        metrics:,
         # Name of the workflow.
         name:,
         # Type of thresholds to use for the workflow, either `automatic` or `custom`.
@@ -42,14 +37,20 @@ module Deeprails
         # set the threshold for each metric as a floating point number between 0.0 and
         # 1.0.
         type:,
-        # Hallucination tolerance for automatic workflows; may be `low`, `medium`, or
-        # `high`. Ignored if `type` is `custom`.
-        automatic_tolerance: nil,
+        # 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`.
+        automatic_hallucination_tolerance_levels: nil,
+        # Mapping of guardrail metrics to floating point threshold values. Possible
+        # metrics are `correctness`, `completeness`, `instruction_adherence`,
+        # `context_adherence`, `ground_truth_adherence`, or `comprehensive_safety`.
+        custom_hallucination_threshold_values: nil,
         # Description for the workflow.
         description: nil,
         # Max. number of improvement action retries until a given event passes the
         # guardrails. Defaults to 10.
-        max_retries: nil,
+        max_improvement_attempt: nil,
         request_options: {}
       )
       end
@@ -102,7 +103,7 @@ module Deeprails
         # Workflow ID associated with this event.
         workflow_id,
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.

data/rbi/deeprails/resources/evaluate.rbi

@@ -21,7 +21,7 @@ module Deeprails
       end
       def create(
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.

data/rbi/deeprails/resources/monitor.rbi

@@ -91,7 +91,7 @@ module Deeprails
         # `ground_truth_adherence`, and/or `comprehensive_safety`.
         guardrail_metrics:,
         # 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.
         model_input:,
         # Output generated by the LLM to be evaluated.