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: Secret

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Cadenya::Internal::Type::BaseModel

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]

#initial_message ⇒ String?

Optional override for initial message sent to the agent. This becomes the first user message in the LLM chat history. The agent variation is used to set this if not present.

Returns:

  • (String, nil) 


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

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:



53
54
55
 
# File 'lib/cadenya/models/objective_create_params.rb', line 53

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:



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

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:



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

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

#variation_id ⇒ String?

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

Returns:

  • (String, nil) 


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

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