Class: Deeprails::Models::DefendCreateWorkflowParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Deeprails::Models::DefendCreateWorkflowParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/deeprails/models/defend_create_workflow_params.rb

Overview

See Also:

• Resources::Defend#create_workflow

Defined Under Namespace

Modules: AutomaticHallucinationToleranceLevel, ImprovementAction, ThresholdType

Instance Attribute Summary

• #automatic_hallucination_tolerance_levels ⇒ Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}^?

  Mapping of guardrail metrics to hallucination tolerance levels (either low, medium, or high).

• #context_awareness ⇒ Boolean^?

  Context includes any structured information that directly relates to the model’s input and expected output—e.g., the recent turn-by-turn history between an AI tutor and a student, facts or state passed through an agentic workflow, or other domain-specific signals your system already knows and wants the model to condition on.

• #custom_hallucination_threshold_values ⇒ Hash{Symbol=>Float}^?

  Mapping of guardrail metrics to floating point threshold values.

• #description ⇒ String^?

  Description for the workflow.

• #file_search ⇒ Array<String>^?

  An array of file IDs to search in the workflow’s evaluations.

• #improvement_action ⇒ Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction

  The action used to improve outputs that fail one or more guardrail metrics for the workflow events.

• #max_improvement_attempts ⇒ Integer^?

  Max.

• #name ⇒ String

  Name of the workflow.

• #threshold_type ⇒ Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType

  Type of thresholds to use for the workflow, either automatic or custom.

• #web_search ⇒ Boolean^?

  Whether to enable web search for this workflow’s evaluations.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(improvement_action:, name:, threshold_type:, automatic_hallucination_tolerance_levels: nil, context_awareness: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see DefendCreateWorkflowParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(improvement_action:, name:, threshold_type:, automatic_hallucination_tolerance_levels: nil, context_awareness: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Deeprails::Models::DefendCreateWorkflowParams for more details.

Parameters:

• improvement_action (Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction) —

  The action used to improve outputs that fail one or more guardrail metrics for t

• name (String) —

  Name of the workflow.

• threshold_type (Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType) —

  Type of thresholds to use for the workflow, either automatic or custom. Aut

• automatic_hallucination_tolerance_levels (Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}) (defaults to: nil) —

  Mapping of guardrail metrics to hallucination tolerance levels

• context_awareness (Boolean) (defaults to: nil) —

  Context includes any structured information that directly relates to the model’s

• custom_hallucination_threshold_values (Hash{Symbol=>Float}) (defaults to: nil) —

  Mapping of guardrail metrics to floating point threshold values. Possible metric

• description (String) (defaults to: nil) —

  Description for the workflow.

• file_search (Array<String>) (defaults to: nil) —

  An array of file IDs to search in the workflow’s evaluations. Files must be uplo

• max_improvement_attempts (Integer) (defaults to: nil) —

  Max. number of improvement action attempts until a given event passes the guardr

• web_search (Boolean) (defaults to: nil) —

  Whether to enable web search for this workflow’s evaluations. Defaults to false.

• request_options (Deeprails::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 91

Instance Attribute Details

#automatic_hallucination_tolerance_levels ⇒ Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}^?

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.

Returns:

• (Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 43

optional :automatic_hallucination_tolerance_levels,
-> { Deeprails::Internal::Type::HashOf[enum: Deeprails::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel] }

#context_awareness ⇒ Boolean^?

Context includes any structured information that directly relates to the model’s input and expected output—e.g., the recent turn-by-turn history between an AI tutor and a student, facts or state passed through an agentic workflow, or other domain-specific signals your system already knows and wants the model to condition on. This field determines whether to enable context awareness for this workflow’s evaluations. Defaults to false.

Returns:

• (Boolean, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 55

optional :context_awareness, Deeprails::Internal::Type::Boolean

#custom_hallucination_threshold_values ⇒ Hash{Symbol=>Float}^?

Mapping of guardrail metrics to floating point threshold values. Possible metrics are correctness, completeness, instruction_adherence, context_adherence, ground_truth_adherence, or comprehensive_safety.

Returns:

• (Hash{Symbol=>Float}, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 63

optional :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]

#description ⇒ String^?

Description for the workflow.

Returns:

• (String, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 69

optional :description, String

#file_search ⇒ Array<String>^?

An array of file IDs to search in the workflow’s evaluations. Files must be uploaded via the DeepRails API first.

Returns:

• (Array<String>, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 76

optional :file_search, Deeprails::Internal::Type::ArrayOf[String]

#improvement_action ⇒ Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction

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.

Returns:

• (Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 18

required :improvement_action, enum: -> { Deeprails::DefendCreateWorkflowParams::ImprovementAction }

#max_improvement_attempts ⇒ Integer^?

Max. number of improvement action attempts until a given event passes the guardrails. Defaults to 10.

Returns:

• (Integer, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 83

optional :max_improvement_attempts, Integer

#name ⇒ String

Name of the workflow.

Returns:

• (String)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 24

required :name, String

#threshold_type ⇒ Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType

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.

Returns:

• (Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 34

required :threshold_type, enum: -> { Deeprails::DefendCreateWorkflowParams::ThresholdType }

#web_search ⇒ Boolean^?

Whether to enable web search for this workflow’s evaluations. Defaults to false.

Returns:

• (Boolean, nil)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 89

optional :web_search, Deeprails::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/deeprails/models/defend_create_workflow_params.rb', line 129