Class: Cadenya::Resources::Objectives

Inherits:
Object
  • Object
show all
Defined in:
lib/cadenya/resources/objectives.rb,
lib/cadenya/resources/objectives/tasks.rb,
lib/cadenya/resources/objectives/tools.rb,
lib/cadenya/resources/objectives/feedback.rb,
lib/cadenya/resources/objectives/tool_calls.rb,
sig/cadenya/resources/objectives.rbs,
sig/cadenya/resources/objectives/tasks.rbs,
sig/cadenya/resources/objectives/tools.rbs,
sig/cadenya/resources/objectives/feedback.rbs,
sig/cadenya/resources/objectives/tool_calls.rbs

Defined Under Namespace

Classes: Feedback, Tasks, ToolCalls, Tools

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Objectives

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Objectives.

Parameters:



397
398
399
400
401
402
403
 
# File 'lib/cadenya/resources/objectives.rb', line 397

def initialize(client:)
  @client = client
  @tools = Cadenya::Resources::Objectives::Tools.new(client: client)
  @tool_calls = Cadenya::Resources::Objectives::ToolCalls.new(client: client)
  @tasks = Cadenya::Resources::Objectives::Tasks.new(client: client)
  @feedback = Cadenya::Resources::Objectives::Feedback.new(client: client)
end

Instance Attribute Details

#feedback ⇒ Cadenya::Resources::Objectives::Feedback (readonly)

Returns:



16
17
18
 
# File 'lib/cadenya/resources/objectives.rb', line 16

def feedback
  @feedback
end

#tasks ⇒ Cadenya::Resources::Objectives::Tasks (readonly)

Returns:



13
14
15
 
# File 'lib/cadenya/resources/objectives.rb', line 13

def tasks
  @tasks
end

#tool_calls ⇒ Cadenya::Resources::Objectives::ToolCalls (readonly)

Returns:



10
11
12
 
# File 'lib/cadenya/resources/objectives.rb', line 10

def tool_calls
  @tool_calls
end

#tools ⇒ Cadenya::Resources::Objectives::Tools (readonly)

Returns:



7
8
9
 
# File 'lib/cadenya/resources/objectives.rb', line 7

def tools
  @tools
end

Instance Method Details

#cancel(objective_id, workspace_id:, reason: nil, request_options: {}) ⇒ Cadenya::Models::Objective

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

Cancels a running or pending objective. The objective's state will be set to STATE_CANCELLED.

Parameters:

  • objective_id (String) —

    Path param: The ID of the objective. Supports "external_id:" prefix for external

  • workspace_id (String) —

    Path param

  • reason (String) —

    Body param: Optional reason for cancellation

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/cadenya/resources/objectives.rb', line 159

def cancel(objective_id, params)
  parsed, options = Cadenya::ObjectiveCancelParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/objectives/%2$s:cancel", workspace_id, objective_id],
    body: parsed,
    model: Cadenya::Objective,
    options: options
  )
end

#compact(objective_id, workspace_id:, compaction_config: nil, request_options: {}) ⇒ Cadenya::Models::ObjectiveCompactResponse

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

Triggers compaction on a running objective. Optionally override the variation's compaction config.

Parameters:

Returns:

See Also:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cadenya/resources/objectives.rb', line 193

def compact(objective_id, params)
  parsed, options = Cadenya::ObjectiveCompactParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/objectives/%2$s:compact", workspace_id, objective_id],
    body: parsed,
    model: Cadenya::Models::ObjectiveCompactResponse,
    options: options
  )
end

#continue(objective_id, workspace_id:, enqueue: nil, message: nil, request_options: {}) ⇒ Cadenya::Models::ObjectiveEvent

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

Continues an objective that has completed

Parameters:

  • objective_id (String) —

    Path param: The ID of the objective. If you have assigned an external ID to the

  • workspace_id (String) —

    Path param

  • enqueue (Boolean) —

    Body param: When set to true, the message will be enqueued for when the agent lo

  • message (String) —

    Body param: The message to continue an objective that has completed (or you are

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cadenya/resources/objectives.rb', line 228

def continue(objective_id, params)
  parsed, options = Cadenya::ObjectiveContinueParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/objectives/%2$s:continue", workspace_id, objective_id],
    body: parsed,
    model: Cadenya::ObjectiveEvent,
    options: options
  )
end

#create(workspace_id, agent_id:, system_prompt_data:, episodic_memory: nil, first_user_message: nil, first_user_message_data: nil, memory_cascade: nil, metadata: nil, secrets: nil, variation_id: nil, request_options: {}) ⇒ Cadenya::Models::Objective

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

Creates a new objective in the workspace

Parameters:

  • workspace_id (String)
  • agent_id (String)
  • system_prompt_data (Hash{Symbol=>Object}) —

    Arbitrary data rendered into the selected variation's system_prompt_template

  • episodic_memory (Cadenya::Models::ObjectiveCreateParams::EpisodicMemory) —

    Episodic is used to configure the episodic memory for the objective

  • first_user_message (String) —

    Optional explicit first user message for the LLM chat history. When not set,

  • first_user_message_data (Hash{Symbol=>Object}) —

    Arbitrary data rendered into the selected variation's first_user_message_templat

  • memory_cascade (Array<Cadenya::Models::MemoryReference>) —

    Memory layers/entries layered over the baseline cascade inherited

  • metadata (Cadenya::Models::CreateOperationMetadata) —

    CreateOperationMetadata contains the user-provided fields for creating

  • secrets (Array<Cadenya::Models::ObjectiveCreateParams::Secret>) —

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

  • variation_id (String) —

    Optional explicit variation selection. Overrides the agent's variation_selection

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/cadenya/resources/objectives.rb', line 50

def create(workspace_id, params)
  parsed, options = Cadenya::ObjectiveCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/objectives", workspace_id],
    body: parsed,
    model: Cadenya::Objective,
    options: options
  )
end

#list(workspace_id, agent_id: nil, agent_schedule_id: nil, cursor: nil, include_info: nil, labels: nil, limit: nil, parent_objective_id: nil, profile_id: nil, sort_order: nil, state: nil, request_options: {}) ⇒ Cadenya::Internal::CursorPagination<Cadenya::Models::Objective>

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

Lists all objectives in the workspace

Parameters:

  • workspace_id (String)
  • agent_id (String) —

    Agent ID for filtering

  • agent_schedule_id (String) —

    Filter to objectives produced by a specific AgentSchedule. Accepts

  • cursor (String) —

    Pagination cursor from previous response

  • include_info (Boolean) —

    When set to true you may use more of your alloted API rate-limit

  • labels (String) —

    Filters by metadata labels. Comma-separated key=value pairs,

  • limit (Integer) —

    Maximum number of results to return

  • parent_objective_id (String) —

    Optional filters

  • profile_id (String)
  • sort_order (String) —

    Sort order for results (asc or desc by creation time)

  • state (Symbol, Cadenya::Models::ObjectiveListParams::State) —

    Filter by state

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/cadenya/resources/objectives.rb', line 120

def list(workspace_id, params = {})
  parsed, options = Cadenya::ObjectiveListParams.dump_request(params)
  query = Cadenya::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/objectives", workspace_id],
    query: query.transform_keys(
      agent_id: "agentId",
      agent_schedule_id: "agentScheduleId",
      include_info: "includeInfo",
      parent_objective_id: "parentObjectiveId",
      profile_id: "profileId",
      sort_order: "sortOrder"
    ),
    page: Cadenya::Internal::CursorPagination,
    model: Cadenya::Objective,
    options: options
  )
end

#list_context_windows(objective_id, workspace_id:, cursor: nil, include_info: nil, labels: nil, limit: nil, request_options: {}) ⇒ Cadenya::Internal::CursorPagination<Cadenya::Models::ObjectiveContextWindow>

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

Read-only list of the last five windows of execution for this objective, ordered by most recent first

Parameters:

  • objective_id (String) —

    Path param: The objective ID to return windows for

  • workspace_id (String) —

    Path param

  • cursor (String) —

    Query param: Pagination cursor from previous response

  • include_info (Boolean) —

    Query param: When set to true you may use more of your alloted API rate-limit

  • labels (String) —

    Query param: Filters by metadata labels. Comma-separated key=value pairs,

  • limit (Integer) —

    Query param: Maximum number of results to return

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cadenya/resources/objectives.rb', line 268

def list_context_windows(objective_id, params)
  parsed, options = Cadenya::ObjectiveListContextWindowsParams.dump_request(params)
  query = Cadenya::Internal::Util.encode_query_params(parsed)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/objectives/%2$s/context_windows", workspace_id, objective_id],
    query: query.transform_keys(include_info: "includeInfo"),
    page: Cadenya::Internal::CursorPagination,
    model: Cadenya::ObjectiveContextWindow,
    options: options
  )
end

#list_events(objective_id, workspace_id:, cursor: nil, include_info: nil, labels: nil, limit: nil, since_event_id: nil, sort_order: nil, window_id: nil, request_options: {}) ⇒ Cadenya::Internal::CursorPagination<Cadenya::Models::ObjectiveEvent>

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

Lists all events for an objective

Parameters:

  • objective_id (String) —

    Path param: Objective ID for filtering

  • workspace_id (String) —

    Path param

  • cursor (String) —

    Query param: Pagination cursor from previous response

  • include_info (Boolean) —

    Query param: When set to true you may use more of your alloted API rate-limit

  • labels (String) —

    Query param: Filters by metadata labels. Comma-separated key=value pairs,

  • limit (Integer) —

    Query param: Maximum number of results to return

  • since_event_id (String) —

    Query param: Optional string to fetch events since an ID

  • sort_order (String) —

    Query param: Sort order for results (asc or desc by creation time)

  • window_id (String) —

    Query param: Optional context window ID to filter events by

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/cadenya/resources/objectives.rb', line 315

def list_events(objective_id, params)
  parsed, options = Cadenya::ObjectiveListEventsParams.dump_request(params)
  query = Cadenya::Internal::Util.encode_query_params(parsed)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/objectives/%2$s/events", workspace_id, objective_id],
    query: query.transform_keys(
      include_info: "includeInfo",
      since_event_id: "sinceEventId",
      sort_order: "sortOrder",
      window_id: "windowId"
    ),
    page: Cadenya::Internal::CursorPagination,
    model: Cadenya::ObjectiveEvent,
    options: options
  )
end

#retrieve(id, workspace_id:, request_options: {}) ⇒ Cadenya::Models::Objective

Retrieves an objective by ID from the workspace

Parameters:

Returns:

See Also:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cadenya/resources/objectives.rb', line 72

def retrieve(id, params)
  parsed, options = Cadenya::ObjectiveRetrieveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/objectives/%2$s", workspace_id, id],
    model: Cadenya::Objective,
    options: options
  )
end

#retrieve_diagnostics(objective_id, workspace_id:, request_options: {}) ⇒ Cadenya::Models::ObjectiveRetrieveDiagnosticsResponse

Returns the context-usage breakdown measured for the objective's most recent iteration: character lengths per context component (system prompt, memory appendices, tool definitions, messages by role) alongside the iteration's input token counts.

Parameters:

  • objective_id (String) —

    The ID of the objective. Supports "external_id:" prefix for external IDs.

  • workspace_id (String)
  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/cadenya/resources/objectives.rb', line 353

def retrieve_diagnostics(objective_id, params)
  parsed, options = Cadenya::ObjectiveRetrieveDiagnosticsParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/objectives/%2$s/diagnostics", workspace_id, objective_id],
    model: Cadenya::Models::ObjectiveRetrieveDiagnosticsResponse,
    options: options
  )
end

#stream_events_streaming(objective_id, workspace_id:, request_options: {}) ⇒ Cadenya::Internal::Stream<Cadenya::Models::ObjectiveEvent>

Streams events for an objective in real-time using server-sent events (SSE)

Parameters:

Returns:

See Also:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/cadenya/resources/objectives.rb', line 378

def stream_events_streaming(objective_id, params)
  parsed, options = Cadenya::ObjectiveStreamEventsParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/objectives/%2$s/events:stream", workspace_id, objective_id],
    headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
    stream: Cadenya::Internal::Stream,
    model: Cadenya::ObjectiveEvent,
    options: options
  )
end