Class: Cadenya::Models::AgentSpec

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cadenya/models/agent_spec.rb

Defined Under Namespace

Modules: Status, VariationSelectionMode

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(status:, variation_selection_mode:, description: nil, input_data_schema: nil, webhook_events_url: nil) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::AgentSpec for more details.

Agent specification (user-provided configuration)

Parameters:

  • status (Symbol, Cadenya::Models::AgentSpec::Status) —

    Status of the agent

  • variation_selection_mode (Symbol, Cadenya::Models::AgentSpec::VariationSelectionMode) —

    Controls how variations are automatically selected when creating objectives

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

    Description of the agent’s purpose

  • input_data_schema (Object) (defaults to: nil) —

    InputDataSchema is used for enforcing a data input when objectives are created.

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

    The URL that Cadenya will send events for any objective assigned to the agent.




# File 'lib/cadenya/models/agent_spec.rb', line 43

Instance Attribute Details

#description ⇒ String?

Description of the agent’s purpose

Returns:

  • (String, nil) 


25
 
# File 'lib/cadenya/models/agent_spec.rb', line 25

optional :description, String

#input_data_schema ⇒ Object?

InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool’s input parameter schema. If omitted, the sub-agent schema will be loaded with a simple “prompt” free text string as its schema.

Returns:

  • (Object, nil) 


35
 
# File 'lib/cadenya/models/agent_spec.rb', line 35

optional :input_data_schema, Cadenya::Internal::Type::Unknown, api_name: :inputDataSchema

#status ⇒ Symbol, Cadenya::Models::AgentSpec::Status

Status of the agent

Returns:



10
 
# File 'lib/cadenya/models/agent_spec.rb', line 10

required :status, enum: -> { Cadenya::AgentSpec::Status }

#variation_selection_mode ⇒ Symbol, Cadenya::Models::AgentSpec::VariationSelectionMode

Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified

Returns:



17
18
19
 
# File 'lib/cadenya/models/agent_spec.rb', line 17

required :variation_selection_mode,
enum: -> { Cadenya::AgentSpec::VariationSelectionMode },
api_name: :variationSelectionMode

#webhook_events_url ⇒ String?

The URL that Cadenya will send events for any objective assigned to the agent.

Returns:

  • (String, nil) 


41
 
# File 'lib/cadenya/models/agent_spec.rb', line 41

optional :webhook_events_url, String, api_name: :webhookEventsUrl

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/cadenya/models/agent_spec.rb', line 70