Class: Cadenya::Models::ObjectiveCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cadenya/models/objective_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: EpisodicMemory, Secret

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(key: nil) ⇒ Object

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

Episodic is used to configure the episodic memory for the objective

Parameters:

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

    The caller-supplied episodic key. Objectives created with the same key




# File 'lib/cadenya/models/objective_create_params.rb', line 133

Instance Attribute Details

#agent_id ⇒ String

Returns:

  • (String) 


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

required :agent_id, String, api_name: :agentId

#data ⇒ Hash{Symbol=>Object}

Arbitrary data for the objective. May be used in liquid templates for prompts configured on the agent variation

Returns:

  • (Hash{Symbol=>Object}) 


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

required :data, Cadenya::Internal::Type::HashOf[Cadenya::Internal::Type::Unknown]

#episodic_memory ⇒ Cadenya::Models::ObjectiveCreateParams::EpisodicMemory?

Episodic is used to configure the episodic memory for the objective

Returns:



31
32
33
 
# File 'lib/cadenya/models/objective_create_params.rb', line 31

optional :episodic_memory,
-> { Cadenya::ObjectiveCreateParams::EpisodicMemory },
api_name: :episodicMemory

#initial_message ⇒ String?

Optional override for the initial message sent to the agent. This becomes the first user message in the LLM chat history. When not set, the selected variation’s user_message_template is rendered with user_data instead. If neither this field nor a user_message_template is present, the request is rejected with InvalidArgument.

Returns:

  • (String, nil) 


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

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:



63
64
65
 
# File 'lib/cadenya/models/objective_create_params.rb', line 63

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

#metadata ⇒ Cadenya::Models::CreateOperationMetadata?

CreateOperationMetadata contains the user-provided fields for creating an operation. Read-only fields (id, account_id, workspace_id, created_at, profile_id) are excluded since they are set by the server.

Returns:



73
 
# File 'lib/cadenya/models/objective_create_params.rb', line 73

optional :metadata, -> { Cadenya::CreateOperationMetadata }

#secrets ⇒ Array<Cadenya::Models::ObjectiveCreateParams::Secret>?

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

Returns:



80
 
# File 'lib/cadenya/models/objective_create_params.rb', line 80

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

#user_data ⇒ Hash{Symbol=>Object}?

Arbitrary data rendered into the selected variation’s user_message_template (liquid) to produce the initial user message. Separate from ‘data`, which renders the system prompt template.

Returns:

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


88
89
90
 
# File 'lib/cadenya/models/objective_create_params.rb', line 88

optional :user_data,
Cadenya::Internal::Type::HashOf[Cadenya::Internal::Type::Unknown],
api_name: :userData

#variation_id ⇒ String?

Optional explicit variation selection. Overrides the agent’s variation_selection_mode.

Returns:

  • (String, nil) 


97
 
# File 'lib/cadenya/models/objective_create_params.rb', line 97

optional :variation_id, String, api_name: :variationId

#workspace_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/cadenya/models/objective_create_params.rb', line 13

required :workspace_id, String