Class: Cadenya::Models::ObjectiveData

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

Instance Attribute 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(agent: nil, data: nil, initial_message: nil, memory_stack: nil, parent_objective_id: nil, secrets: nil, source_schedule_id: nil, system_prompt: nil, variation: nil) ⇒ Object

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

Parameters:

  • agent (Cadenya::Models::Agent) (defaults to: nil) —

    Agent resource

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

    Represents a dynamically typed value which can be either null, a number, a strin

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

    The initial message sent to the agent. This becomes the first user message in th

  • memory_stack (Array<Cadenya::Models::MemoryReference>) (defaults to: nil) —

    Memory layers/entries to push onto this objective’s memory stack on

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

    A parent objective means the objective was spawned off using a separate agent to

  • secrets (Array<Cadenya::Models::ObjectiveDataSecret>) (defaults to: nil) —

    Secrets that can be used in the headers for tool calls using the secret interpol

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

    ID of the AgentSchedule that produced this objective, when applicable.

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

    system_prompt is read-only, derived from the selected variation’s prompt

  • variation (Cadenya::Models::Agents::AgentVariation) (defaults to: nil) —

    AgentVariation resource




# File 'lib/cadenya/models/objective_data.rb', line 84

Instance Attribute Details

#data ⇒ Object?

Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.

Returns:

  • (Object, nil) 


11
 
# File 'lib/cadenya/models/objective_data.rb', line 11

optional :data, Cadenya::Internal::Type::Unknown

#initial_message ⇒ String?

The initial message sent to the agent. This becomes the first user message in the LLM chat history.

Returns:

  • (String, nil) 


18
 
# File 'lib/cadenya/models/objective_data.rb', line 18

optional :initial_message, String, api_name: :initialMessage

#memory_stack ⇒ Array<Cadenya::Models::MemoryReference>?

Memory layers/entries to push onto this objective’s memory stack on top of the baseline stack inherited from the selected variation.

Array order is push order: the first element sits lower in the objective’s contribution to the stack; the LAST element ends up on top of the effective stack. Entries pinned via memory_entry_id behave as single-entry layers at their position.

System-managed layers (e.g., episodic) cannot be referenced here; they attach themselves automatically based on episodic_key.

Stack size cap: the TOTAL effective stack (variation’s memory layers

  • this field) must not exceed 10 entries. A request that would produce an effective stack larger than 10 is rejected with InvalidArgument.

Returns:



38
39
40
 
# File 'lib/cadenya/models/objective_data.rb', line 38

optional :memory_stack,
-> { Cadenya::Internal::Type::ArrayOf[Cadenya::MemoryReference] },
api_name: :memoryStack

#secrets ⇒ Array<Cadenya::Models::ObjectiveDataSecret>?

Secrets that can be used in the headers for tool calls using the secret interpolation format.

Returns:



47
 
# File 'lib/cadenya/models/objective_data.rb', line 47

optional :secrets, -> { Cadenya::Internal::Type::ArrayOf[Cadenya::ObjectiveDataSecret] }