@cadenya/cadenya 0.124.0 → 0.126.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/README.md +18 -7
- package/client.d.mts +17 -11
- package/client.d.mts.map +1 -1
- package/client.d.ts +17 -11
- package/client.d.ts.map +1 -1
- package/client.js +7 -3
- package/client.js.map +1 -1
- package/client.mjs +7 -3
- package/client.mjs.map +1 -1
- package/internal/request-options.d.mts +1 -1
- package/internal/request-options.d.ts +1 -1
- package/package.json +1 -1
- package/resources/agents/agents.d.mts +115 -28
- package/resources/agents/agents.d.mts.map +1 -1
- package/resources/agents/agents.d.ts +115 -28
- package/resources/agents/agents.d.ts.map +1 -1
- package/resources/agents/agents.js +93 -13
- package/resources/agents/agents.js.map +1 -1
- package/resources/agents/agents.mjs +93 -13
- package/resources/agents/agents.mjs.map +1 -1
- package/resources/agents/feedback.d.mts +13 -2
- package/resources/agents/feedback.d.mts.map +1 -1
- package/resources/agents/feedback.d.ts +13 -2
- package/resources/agents/feedback.d.ts.map +1 -1
- package/resources/agents/feedback.js +13 -2
- package/resources/agents/feedback.js.map +1 -1
- package/resources/agents/feedback.mjs +13 -2
- package/resources/agents/feedback.mjs.map +1 -1
- package/resources/agents/index.d.mts +1 -1
- package/resources/agents/index.d.mts.map +1 -1
- package/resources/agents/index.d.ts +1 -1
- package/resources/agents/index.d.ts.map +1 -1
- package/resources/agents/index.js.map +1 -1
- package/resources/agents/index.mjs.map +1 -1
- package/resources/agents/schedules.d.mts +100 -52
- package/resources/agents/schedules.d.mts.map +1 -1
- package/resources/agents/schedules.d.ts +100 -52
- package/resources/agents/schedules.d.ts.map +1 -1
- package/resources/agents/schedules.js +99 -21
- package/resources/agents/schedules.js.map +1 -1
- package/resources/agents/schedules.mjs +99 -21
- package/resources/agents/schedules.mjs.map +1 -1
- package/resources/agents/variations.d.mts +252 -105
- package/resources/agents/variations.d.mts.map +1 -1
- package/resources/agents/variations.d.ts +252 -105
- package/resources/agents/variations.d.ts.map +1 -1
- package/resources/agents/variations.js +138 -27
- package/resources/agents/variations.js.map +1 -1
- package/resources/agents/variations.mjs +138 -27
- package/resources/agents/variations.mjs.map +1 -1
- package/resources/agents/webhook-deliveries.d.mts +13 -2
- package/resources/agents/webhook-deliveries.d.mts.map +1 -1
- package/resources/agents/webhook-deliveries.d.ts +13 -2
- package/resources/agents/webhook-deliveries.d.ts.map +1 -1
- package/resources/agents/webhook-deliveries.js +13 -2
- package/resources/agents/webhook-deliveries.js.map +1 -1
- package/resources/agents/webhook-deliveries.mjs +13 -2
- package/resources/agents/webhook-deliveries.mjs.map +1 -1
- package/resources/ai-provider-keys.d.mts +125 -110
- package/resources/ai-provider-keys.d.mts.map +1 -1
- package/resources/ai-provider-keys.d.ts +125 -110
- package/resources/ai-provider-keys.d.ts.map +1 -1
- package/resources/ai-provider-keys.js +11 -9
- package/resources/ai-provider-keys.js.map +1 -1
- package/resources/ai-provider-keys.mjs +11 -9
- package/resources/ai-provider-keys.mjs.map +1 -1
- package/resources/api-keys.d.mts +28 -20
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +28 -20
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/api-keys.js +14 -12
- package/resources/api-keys.js.map +1 -1
- package/resources/api-keys.mjs +14 -12
- package/resources/api-keys.mjs.map +1 -1
- package/resources/index.d.mts +4 -4
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/memory-layers/entries.d.mts +27 -30
- package/resources/memory-layers/entries.d.mts.map +1 -1
- package/resources/memory-layers/entries.d.ts +27 -30
- package/resources/memory-layers/entries.d.ts.map +1 -1
- package/resources/memory-layers/entries.js +12 -12
- package/resources/memory-layers/entries.js.map +1 -1
- package/resources/memory-layers/entries.mjs +12 -12
- package/resources/memory-layers/entries.mjs.map +1 -1
- package/resources/memory-layers/index.d.mts +1 -1
- package/resources/memory-layers/index.d.mts.map +1 -1
- package/resources/memory-layers/index.d.ts +1 -1
- package/resources/memory-layers/index.d.ts.map +1 -1
- package/resources/memory-layers/index.js.map +1 -1
- package/resources/memory-layers/index.mjs.map +1 -1
- package/resources/memory-layers/memory-layers.d.mts +34 -22
- package/resources/memory-layers/memory-layers.d.mts.map +1 -1
- package/resources/memory-layers/memory-layers.d.ts +34 -22
- package/resources/memory-layers/memory-layers.d.ts.map +1 -1
- package/resources/memory-layers/memory-layers.js +11 -9
- package/resources/memory-layers/memory-layers.js.map +1 -1
- package/resources/memory-layers/memory-layers.mjs +11 -9
- package/resources/memory-layers/memory-layers.mjs.map +1 -1
- package/resources/models.d.mts +32 -24
- package/resources/models.d.mts.map +1 -1
- package/resources/models.d.ts +32 -24
- package/resources/models.d.ts.map +1 -1
- package/resources/models.js +10 -8
- package/resources/models.js.map +1 -1
- package/resources/models.mjs +10 -8
- package/resources/models.mjs.map +1 -1
- package/resources/objectives/feedback.d.mts +27 -3
- package/resources/objectives/feedback.d.mts.map +1 -1
- package/resources/objectives/feedback.d.ts +27 -3
- package/resources/objectives/feedback.d.ts.map +1 -1
- package/resources/objectives/feedback.js +27 -3
- package/resources/objectives/feedback.js.map +1 -1
- package/resources/objectives/feedback.mjs +27 -3
- package/resources/objectives/feedback.mjs.map +1 -1
- package/resources/objectives/index.d.mts +2 -2
- package/resources/objectives/index.d.mts.map +1 -1
- package/resources/objectives/index.d.ts +2 -2
- package/resources/objectives/index.d.ts.map +1 -1
- package/resources/objectives/index.js.map +1 -1
- package/resources/objectives/index.mjs.map +1 -1
- package/resources/objectives/objectives.d.mts +273 -102
- package/resources/objectives/objectives.d.mts.map +1 -1
- package/resources/objectives/objectives.d.ts +273 -102
- package/resources/objectives/objectives.d.ts.map +1 -1
- package/resources/objectives/objectives.js +112 -17
- package/resources/objectives/objectives.js.map +1 -1
- package/resources/objectives/objectives.mjs +112 -17
- package/resources/objectives/objectives.mjs.map +1 -1
- package/resources/objectives/tasks.d.mts +25 -8
- package/resources/objectives/tasks.d.mts.map +1 -1
- package/resources/objectives/tasks.d.ts +25 -8
- package/resources/objectives/tasks.d.ts.map +1 -1
- package/resources/objectives/tasks.js +26 -5
- package/resources/objectives/tasks.js.map +1 -1
- package/resources/objectives/tasks.mjs +26 -5
- package/resources/objectives/tasks.mjs.map +1 -1
- package/resources/objectives/tool-calls.d.mts +99 -42
- package/resources/objectives/tool-calls.d.mts.map +1 -1
- package/resources/objectives/tool-calls.d.ts +99 -42
- package/resources/objectives/tool-calls.d.ts.map +1 -1
- package/resources/objectives/tool-calls.js +73 -14
- package/resources/objectives/tool-calls.js.map +1 -1
- package/resources/objectives/tool-calls.mjs +73 -14
- package/resources/objectives/tool-calls.mjs.map +1 -1
- package/resources/objectives/tools.d.mts +13 -2
- package/resources/objectives/tools.d.mts.map +1 -1
- package/resources/objectives/tools.d.ts +13 -2
- package/resources/objectives/tools.d.ts.map +1 -1
- package/resources/objectives/tools.js +13 -2
- package/resources/objectives/tools.js.map +1 -1
- package/resources/objectives/tools.mjs +13 -2
- package/resources/objectives/tools.mjs.map +1 -1
- package/resources/search.d.mts +11 -2
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +11 -2
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +3 -2
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +3 -2
- package/resources/search.mjs.map +1 -1
- package/resources/tool-sets/index.d.mts +2 -2
- package/resources/tool-sets/index.d.mts.map +1 -1
- package/resources/tool-sets/index.d.ts +2 -2
- package/resources/tool-sets/index.d.ts.map +1 -1
- package/resources/tool-sets/index.js.map +1 -1
- package/resources/tool-sets/index.mjs.map +1 -1
- package/resources/tool-sets/secrets.d.mts +9 -24
- package/resources/tool-sets/secrets.d.mts.map +1 -1
- package/resources/tool-sets/secrets.d.ts +9 -24
- package/resources/tool-sets/secrets.d.ts.map +1 -1
- package/resources/tool-sets/secrets.js +12 -12
- package/resources/tool-sets/secrets.js.map +1 -1
- package/resources/tool-sets/secrets.mjs +12 -12
- package/resources/tool-sets/secrets.mjs.map +1 -1
- package/resources/tool-sets/tool-sets.d.mts +149 -64
- package/resources/tool-sets/tool-sets.d.mts.map +1 -1
- package/resources/tool-sets/tool-sets.d.ts +149 -64
- package/resources/tool-sets/tool-sets.d.ts.map +1 -1
- package/resources/tool-sets/tool-sets.js +17 -15
- package/resources/tool-sets/tool-sets.js.map +1 -1
- package/resources/tool-sets/tool-sets.mjs +17 -15
- package/resources/tool-sets/tool-sets.mjs.map +1 -1
- package/resources/tool-sets/tools.d.mts +33 -43
- package/resources/tool-sets/tools.d.mts.map +1 -1
- package/resources/tool-sets/tools.d.ts +33 -43
- package/resources/tool-sets/tools.d.ts.map +1 -1
- package/resources/tool-sets/tools.js +18 -18
- package/resources/tool-sets/tools.js.map +1 -1
- package/resources/tool-sets/tools.mjs +18 -18
- package/resources/tool-sets/tools.mjs.map +1 -1
- package/resources/uploads.d.mts +14 -6
- package/resources/uploads.d.mts.map +1 -1
- package/resources/uploads.d.ts +14 -6
- package/resources/uploads.d.ts.map +1 -1
- package/resources/uploads.js +5 -4
- package/resources/uploads.js.map +1 -1
- package/resources/uploads.mjs +5 -4
- package/resources/uploads.mjs.map +1 -1
- package/resources/workspace-admin/index.d.mts +1 -1
- package/resources/workspace-admin/index.d.mts.map +1 -1
- package/resources/workspace-admin/index.d.ts +1 -1
- package/resources/workspace-admin/index.d.ts.map +1 -1
- package/resources/workspace-admin/index.js.map +1 -1
- package/resources/workspace-admin/index.mjs.map +1 -1
- package/resources/workspace-admin/members.d.mts +41 -6
- package/resources/workspace-admin/members.d.mts.map +1 -1
- package/resources/workspace-admin/members.d.ts +41 -6
- package/resources/workspace-admin/members.d.ts.map +1 -1
- package/resources/workspace-admin/members.js +34 -6
- package/resources/workspace-admin/members.js.map +1 -1
- package/resources/workspace-admin/members.mjs +34 -6
- package/resources/workspace-admin/members.mjs.map +1 -1
- package/resources/workspace-admin/profiles.d.mts +8 -0
- package/resources/workspace-admin/profiles.d.mts.map +1 -1
- package/resources/workspace-admin/profiles.d.ts +8 -0
- package/resources/workspace-admin/profiles.d.ts.map +1 -1
- package/resources/workspace-admin/profiles.js +8 -0
- package/resources/workspace-admin/profiles.js.map +1 -1
- package/resources/workspace-admin/profiles.mjs +8 -0
- package/resources/workspace-admin/profiles.mjs.map +1 -1
- package/resources/workspace-admin/workspace-admin.d.mts +65 -9
- package/resources/workspace-admin/workspace-admin.d.mts.map +1 -1
- package/resources/workspace-admin/workspace-admin.d.ts +65 -9
- package/resources/workspace-admin/workspace-admin.d.ts.map +1 -1
- package/resources/workspace-admin/workspace-admin.js +46 -6
- package/resources/workspace-admin/workspace-admin.js.map +1 -1
- package/resources/workspace-admin/workspace-admin.mjs +46 -6
- package/resources/workspace-admin/workspace-admin.mjs.map +1 -1
- package/resources/workspace-secrets.d.mts +27 -15
- package/resources/workspace-secrets.d.mts.map +1 -1
- package/resources/workspace-secrets.d.ts +27 -15
- package/resources/workspace-secrets.d.ts.map +1 -1
- package/resources/workspace-secrets.js +11 -9
- package/resources/workspace-secrets.js.map +1 -1
- package/resources/workspace-secrets.mjs +11 -9
- package/resources/workspace-secrets.mjs.map +1 -1
- package/src/client.ts +102 -5
- package/src/internal/request-options.ts +1 -1
- package/src/resources/agents/agents.ts +147 -37
- package/src/resources/agents/feedback.ts +14 -3
- package/src/resources/agents/index.ts +6 -0
- package/src/resources/agents/schedules.ts +143 -71
- package/src/resources/agents/variations.ts +319 -125
- package/src/resources/agents/webhook-deliveries.ts +14 -3
- package/src/resources/ai-provider-keys.ts +155 -127
- package/src/resources/api-keys.ts +48 -29
- package/src/resources/index.ts +44 -1
- package/src/resources/memory-layers/entries.ts +56 -40
- package/src/resources/memory-layers/index.ts +2 -0
- package/src/resources/memory-layers/memory-layers.ts +53 -30
- package/src/resources/models.ts +46 -31
- package/src/resources/objectives/feedback.ts +29 -5
- package/src/resources/objectives/index.ts +26 -0
- package/src/resources/objectives/objectives.ts +373 -125
- package/src/resources/objectives/tasks.ts +33 -12
- package/src/resources/objectives/tool-calls.ts +123 -46
- package/src/resources/objectives/tools.ts +14 -3
- package/src/resources/search.ts +14 -4
- package/src/resources/tool-sets/index.ts +23 -3
- package/src/resources/tool-sets/secrets.ts +32 -35
- package/src/resources/tool-sets/tool-sets.ts +239 -79
- package/src/resources/tool-sets/tools.ts +79 -61
- package/src/resources/uploads.ts +22 -8
- package/src/resources/workspace-admin/index.ts +2 -0
- package/src/resources/workspace-admin/members.ts +53 -12
- package/src/resources/workspace-admin/profiles.ts +8 -0
- package/src/resources/workspace-admin/workspace-admin.ts +80 -11
- package/src/resources/workspace-secrets.ts +40 -25
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -10,7 +10,7 @@ import { Feedback, FeedbackCreateParams, FeedbackListParams, ObjectiveFeedback,
|
|
|
10
10
|
import * as TasksAPI from "./tasks.js";
|
|
11
11
|
import { ObjectiveTask, ObjectiveTaskData, ObjectiveTasksCursorPagination, TaskListParams, TaskRetrieveParams, Tasks } from "./tasks.js";
|
|
12
12
|
import * as ToolCallsAPI from "./tool-calls.js";
|
|
13
|
-
import { ObjectiveToolCall, ObjectiveToolCallData, ObjectiveToolCallInfo, ObjectiveToolCallResult, ObjectiveToolCallResultAudioBlock, ObjectiveToolCallResultContentBlock, ObjectiveToolCallResultImageBlock, ObjectiveToolCallResultTextBlock, ObjectiveToolCallWithResult, ObjectiveToolCallsCursorPagination, ResolvedSecret, SetToolCallContentRequestAudioBlock, SetToolCallContentRequestContentBlock, SetToolCallContentRequestImageBlock, SetToolCallContentRequestTextBlock, ToolCallApproveParams, ToolCallDenyParams, ToolCallListParams, ToolCallRetrieveParams, ToolCallSetContentParams, ToolCalls } from "./tool-calls.js";
|
|
13
|
+
import { ObjectiveToolCall, ObjectiveToolCallData, ObjectiveToolCallInfo, ObjectiveToolCallResult, ObjectiveToolCallResultAudioBlock, ObjectiveToolCallResultContentBlock, ObjectiveToolCallResultContentBlockAudio, ObjectiveToolCallResultContentBlockImage, ObjectiveToolCallResultContentBlockText, ObjectiveToolCallResultImageBlock, ObjectiveToolCallResultTextBlock, ObjectiveToolCallWithResult, ObjectiveToolCallsCursorPagination, ResolvedSecret, SetToolCallContentRequestAudioBlock, SetToolCallContentRequestContentBlock, SetToolCallContentRequestContentBlockAudio, SetToolCallContentRequestContentBlockImage, SetToolCallContentRequestContentBlockText, SetToolCallContentRequestImageBlock, SetToolCallContentRequestTextBlock, ToolCallApproveParams, ToolCallDenyParams, ToolCallListParams, ToolCallRetrieveParams, ToolCallSetContentParams, ToolCalls } from "./tool-calls.js";
|
|
14
14
|
import * as ToolsAPI from "./tools.js";
|
|
15
15
|
import { ObjectiveTool, ObjectiveToolsCursorPagination, ToolListParams, Tools } from "./tools.js";
|
|
16
16
|
import * as ToolSetsToolsAPI from "../tool-sets/tools.js";
|
|
@@ -25,50 +25,143 @@ export declare class Objectives extends APIResource {
|
|
|
25
25
|
feedback: FeedbackAPI.Feedback;
|
|
26
26
|
/**
|
|
27
27
|
* Creates a new objective in the workspace
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const objective = await client.objectives.create({
|
|
32
|
+
* workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
|
|
33
|
+
* agentId: 'agent_01HXKD2E5NQM3T9AYWCFMGWT9Y',
|
|
34
|
+
* systemPromptData: { foo: 'bar' },
|
|
35
|
+
* });
|
|
36
|
+
* ```
|
|
28
37
|
*/
|
|
29
|
-
create(
|
|
38
|
+
create(params: ObjectiveCreateParams, options?: RequestOptions): APIPromise<Objective>;
|
|
30
39
|
/**
|
|
31
40
|
* Retrieves an objective by ID from the workspace
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* const objective = await client.objectives.retrieve(
|
|
45
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
46
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
47
|
+
* );
|
|
48
|
+
* ```
|
|
32
49
|
*/
|
|
33
|
-
retrieve(id: string, params
|
|
50
|
+
retrieve(id: string, params?: ObjectiveRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Objective>;
|
|
34
51
|
/**
|
|
35
52
|
* Lists all objectives in the workspace
|
|
36
|
-
|
|
37
|
-
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* // Automatically fetches more pages as needed.
|
|
57
|
+
* for await (const objective of client.objectives.list({
|
|
58
|
+
* workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
|
|
59
|
+
* })) {
|
|
60
|
+
* // ...
|
|
61
|
+
* }
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
list(params?: ObjectiveListParams | null | undefined, options?: RequestOptions): PagePromise<ObjectivesCursorPagination, Objective>;
|
|
38
65
|
/**
|
|
39
66
|
* Cancels a running or pending objective. The objective's state will be set to
|
|
40
67
|
* STATE_CANCELLED.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* const objective = await client.objectives.cancel(
|
|
72
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
73
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
74
|
+
* );
|
|
75
|
+
* ```
|
|
41
76
|
*/
|
|
42
77
|
cancel(objectiveID: string, params: ObjectiveCancelParams, options?: RequestOptions): APIPromise<Objective>;
|
|
43
78
|
/**
|
|
44
79
|
* Triggers compaction on a running objective. Optionally override the variation's
|
|
45
80
|
* compaction config.
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```ts
|
|
84
|
+
* const response = await client.objectives.compact(
|
|
85
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
86
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
87
|
+
* );
|
|
88
|
+
* ```
|
|
46
89
|
*/
|
|
47
90
|
compact(objectiveID: string, params: ObjectiveCompactParams, options?: RequestOptions): APIPromise<ObjectiveCompactResponse>;
|
|
48
91
|
/**
|
|
49
92
|
* Continues an objective that has completed
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* const objectiveEvent = await client.objectives.continue(
|
|
97
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
98
|
+
* {
|
|
99
|
+
* workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
|
|
100
|
+
* message: 'message',
|
|
101
|
+
* },
|
|
102
|
+
* );
|
|
103
|
+
* ```
|
|
50
104
|
*/
|
|
51
105
|
continue(objectiveID: string, params: ObjectiveContinueParams, options?: RequestOptions): APIPromise<ObjectiveEvent>;
|
|
52
106
|
/**
|
|
53
107
|
* Read-only list of the last five windows of execution for this objective, ordered
|
|
54
108
|
* by most recent first
|
|
55
|
-
|
|
56
|
-
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* ```ts
|
|
112
|
+
* // Automatically fetches more pages as needed.
|
|
113
|
+
* for await (const objectiveContextWindow of client.objectives.listContextWindows(
|
|
114
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
115
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
116
|
+
* )) {
|
|
117
|
+
* // ...
|
|
118
|
+
* }
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
listContextWindows(objectiveID: string, params?: ObjectiveListContextWindowsParams | null | undefined, options?: RequestOptions): PagePromise<ObjectiveContextWindowsCursorPagination, ObjectiveContextWindow>;
|
|
57
122
|
/**
|
|
58
123
|
* Lists all events for an objective
|
|
59
|
-
|
|
60
|
-
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```ts
|
|
127
|
+
* // Automatically fetches more pages as needed.
|
|
128
|
+
* for await (const objectiveEvent of client.objectives.listEvents(
|
|
129
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
130
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
131
|
+
* )) {
|
|
132
|
+
* // ...
|
|
133
|
+
* }
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
listEvents(objectiveID: string, params?: ObjectiveListEventsParams | null | undefined, options?: RequestOptions): PagePromise<ObjectiveEventsCursorPagination, ObjectiveEvent>;
|
|
61
137
|
/**
|
|
62
138
|
* Returns the context-usage breakdown measured for the objective's most recent
|
|
63
139
|
* iteration: character lengths per context component (system prompt, memory
|
|
64
140
|
* appendices, tool definitions, messages by role) alongside the iteration's input
|
|
65
141
|
* token counts.
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```ts
|
|
145
|
+
* const response =
|
|
146
|
+
* await client.objectives.retrieveDiagnostics(
|
|
147
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
148
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
149
|
+
* );
|
|
150
|
+
* ```
|
|
66
151
|
*/
|
|
67
|
-
retrieveDiagnostics(objectiveID: string, params
|
|
152
|
+
retrieveDiagnostics(objectiveID: string, params?: ObjectiveRetrieveDiagnosticsParams | null | undefined, options?: RequestOptions): APIPromise<ObjectiveRetrieveDiagnosticsResponse>;
|
|
68
153
|
/**
|
|
69
154
|
* Streams events for an objective in real-time using server-sent events (SSE)
|
|
70
|
-
|
|
71
|
-
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* ```ts
|
|
158
|
+
* const objectiveEvent = await client.objectives.streamEvents(
|
|
159
|
+
* 'obj_01HXKD2E5NQM3T9AYWCFQAZGFV',
|
|
160
|
+
* { workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q' },
|
|
161
|
+
* );
|
|
162
|
+
* ```
|
|
163
|
+
*/
|
|
164
|
+
streamEvents(objectiveID: string, params?: ObjectiveStreamEventsParams | undefined, options?: RequestOptions): APIPromise<Stream<ObjectiveEvent>>;
|
|
72
165
|
}
|
|
73
166
|
export type ObjectivesCursorPagination = CursorPagination<Objective>;
|
|
74
167
|
export type ObjectiveContextWindowsCursorPagination = CursorPagination<ObjectiveContextWindow>;
|
|
@@ -94,19 +187,27 @@ export interface AssistantToolCall {
|
|
|
94
187
|
* user-defined tool (IE: MCP, HTTP), another Agent (useful to separate context),
|
|
95
188
|
* or a Cadenya Tool (one Cadenya provides).
|
|
96
189
|
*/
|
|
97
|
-
export
|
|
190
|
+
export type CallableTool = CallableToolTool | CallableToolAgent | CallableToolCadenyaProvidedTool;
|
|
191
|
+
export interface CallableToolAgent {
|
|
98
192
|
/**
|
|
99
193
|
* Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
|
|
100
194
|
*/
|
|
101
|
-
agent
|
|
195
|
+
agent: Shared.ResourceMetadata;
|
|
196
|
+
type: 'agent';
|
|
197
|
+
}
|
|
198
|
+
export interface CallableToolCadenyaProvidedTool {
|
|
102
199
|
/**
|
|
103
200
|
* Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
|
|
104
201
|
*/
|
|
105
|
-
cadenyaProvidedTool
|
|
202
|
+
cadenyaProvidedTool: Shared.ResourceMetadata;
|
|
203
|
+
type: 'cadenyaProvidedTool';
|
|
204
|
+
}
|
|
205
|
+
export interface CallableToolTool {
|
|
106
206
|
/**
|
|
107
207
|
* Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
|
|
108
208
|
*/
|
|
109
|
-
tool
|
|
209
|
+
tool: Shared.ResourceMetadata;
|
|
210
|
+
type: 'tool';
|
|
110
211
|
}
|
|
111
212
|
/**
|
|
112
213
|
* ContextLengths is the measured character length of each distinct component of an
|
|
@@ -205,6 +306,7 @@ export interface MemoryRead {
|
|
|
205
306
|
* form (external_id:my-custom-id). The same applies to memory_entry_id when set.
|
|
206
307
|
*/
|
|
207
308
|
export interface MemoryReference {
|
|
309
|
+
memoryLayerId: string;
|
|
208
310
|
/**
|
|
209
311
|
* When set, inserts only this entry from memory_layer_id into the cascade —
|
|
210
312
|
* behaves as a single-entry layer (only this key resolves at this position). The
|
|
@@ -212,7 +314,6 @@ export interface MemoryReference {
|
|
|
212
314
|
* InvalidArgument.
|
|
213
315
|
*/
|
|
214
316
|
memoryEntryId?: string;
|
|
215
|
-
memoryLayerId?: string;
|
|
216
317
|
}
|
|
217
318
|
/**
|
|
218
319
|
* Objective is the data for an objective. It contains the snapshotted fields for
|
|
@@ -312,7 +413,7 @@ export declare namespace Objective {
|
|
|
312
413
|
* The caller-supplied episodic key. Objectives created with the same key (for the
|
|
313
414
|
* same agent) share one episodic memory layer.
|
|
314
415
|
*/
|
|
315
|
-
key
|
|
416
|
+
key: string;
|
|
316
417
|
/**
|
|
317
418
|
* The episodic memory layer resolved (created or reused) for this objective's key.
|
|
318
419
|
* Populated by the system at objective creation.
|
|
@@ -437,57 +538,21 @@ export interface ObjectiveEvent {
|
|
|
437
538
|
contextWindowId?: string;
|
|
438
539
|
info?: ObjectiveEventInfo;
|
|
439
540
|
}
|
|
440
|
-
export
|
|
441
|
-
|
|
541
|
+
export type ObjectiveEventData = ObjectiveEventDataUserMessage | ObjectiveEventDataToolApprovalRequested | ObjectiveEventDataToolApproved | ObjectiveEventDataToolDenied | ObjectiveEventDataToolCalled | ObjectiveEventDataError | ObjectiveEventDataAssistantMessage | ObjectiveEventDataToolResult | ObjectiveEventDataToolError | ObjectiveEventDataContextWindowCompacted | ObjectiveEventDataMemoryRead | ObjectiveEventDataCancelled | ObjectiveEventDataSubAgentSpawned | ObjectiveEventDataSubAgentUpdated | ObjectiveEventDataFinalized | ObjectiveEventDataNotice | ObjectiveEventDataTimedOut;
|
|
542
|
+
export interface ObjectiveEventDataAssistantMessage {
|
|
543
|
+
assistantMessage: AssistantMessage;
|
|
544
|
+
type: 'assistantMessage';
|
|
545
|
+
}
|
|
546
|
+
export interface ObjectiveEventDataCancelled {
|
|
442
547
|
/**
|
|
443
548
|
* ObjectiveCancelled is the terminal event written when an objective is cancelled.
|
|
444
549
|
* After this event, the objective is super-terminal: no further iterations,
|
|
445
550
|
* compaction, or continuation are permitted.
|
|
446
551
|
*/
|
|
447
|
-
cancelled
|
|
448
|
-
|
|
449
|
-
error?: ObjectiveError;
|
|
450
|
-
/**
|
|
451
|
-
* ObjectiveFinalized is the terminal event written when an objective is finalized.
|
|
452
|
-
* After this event, the objective is super-terminal: no further iterations,
|
|
453
|
-
* compaction, or continuation are permitted.
|
|
454
|
-
*/
|
|
455
|
-
finalized?: ObjectiveEventData.Finalized;
|
|
456
|
-
/**
|
|
457
|
-
* MemoryRead is emitted each time the agent resolves a key against the memory
|
|
458
|
-
* cascade and loads an entry. Lookups that miss (key not found in any layer) do
|
|
459
|
-
* not emit this event.
|
|
460
|
-
*/
|
|
461
|
-
memoryRead?: MemoryRead;
|
|
462
|
-
/**
|
|
463
|
-
* Notice is a non-terminal diagnostic emitted by the runtime when something
|
|
464
|
-
* noteworthy but non-fatal happens during an objective — for example a
|
|
465
|
-
* just-in-time tool set failing to load, or a previously loaded tool being dropped
|
|
466
|
-
* because it was archived. Notices carry no structured payload; they exist to make
|
|
467
|
-
* the objective timeline self-explanatory.
|
|
468
|
-
*/
|
|
469
|
-
notice?: ObjectiveEventData.Notice;
|
|
470
|
-
subAgentSpawned?: SubAgentSpawned;
|
|
471
|
-
subAgentUpdated?: SubAgentUpdated;
|
|
472
|
-
/**
|
|
473
|
-
* ObjectiveTimedOut is the terminal event written when an objective is finalized
|
|
474
|
-
* by the inactivity sweep because it saw no activity (no user messages, no LLM
|
|
475
|
-
* calls) within its variation's inactivity timeout — or the system-wide 24 hour
|
|
476
|
-
* maximum when no timeout is configured. The objective produces no output. After
|
|
477
|
-
* this event, the objective is super-terminal: no further iterations, compaction,
|
|
478
|
-
* or continuation are permitted.
|
|
479
|
-
*/
|
|
480
|
-
timedOut?: ObjectiveEventData.TimedOut;
|
|
481
|
-
toolApprovalRequested?: ToolApprovalRequested;
|
|
482
|
-
toolApproved?: ToolApproved;
|
|
483
|
-
toolCalled?: ToolCalled;
|
|
484
|
-
toolDenied?: ToolDenied;
|
|
485
|
-
toolError?: ToolError;
|
|
486
|
-
toolResult?: ToolResult;
|
|
487
|
-
type?: string;
|
|
488
|
-
userMessage?: UserMessage;
|
|
552
|
+
cancelled: ObjectiveEventDataCancelled.Cancelled;
|
|
553
|
+
type: 'cancelled';
|
|
489
554
|
}
|
|
490
|
-
export declare namespace
|
|
555
|
+
export declare namespace ObjectiveEventDataCancelled {
|
|
491
556
|
/**
|
|
492
557
|
* ObjectiveCancelled is the terminal event written when an objective is cancelled.
|
|
493
558
|
* After this event, the objective is super-terminal: no further iterations,
|
|
@@ -501,6 +566,25 @@ export declare namespace ObjectiveEventData {
|
|
|
501
566
|
*/
|
|
502
567
|
message?: string;
|
|
503
568
|
}
|
|
569
|
+
}
|
|
570
|
+
export interface ObjectiveEventDataContextWindowCompacted {
|
|
571
|
+
contextWindowCompacted: ContextWindowCompacted;
|
|
572
|
+
type: 'contextWindowCompacted';
|
|
573
|
+
}
|
|
574
|
+
export interface ObjectiveEventDataError {
|
|
575
|
+
error: ObjectiveError;
|
|
576
|
+
type: 'error';
|
|
577
|
+
}
|
|
578
|
+
export interface ObjectiveEventDataFinalized {
|
|
579
|
+
/**
|
|
580
|
+
* ObjectiveFinalized is the terminal event written when an objective is finalized.
|
|
581
|
+
* After this event, the objective is super-terminal: no further iterations,
|
|
582
|
+
* compaction, or continuation are permitted.
|
|
583
|
+
*/
|
|
584
|
+
finalized: ObjectiveEventDataFinalized.Finalized;
|
|
585
|
+
type: 'finalized';
|
|
586
|
+
}
|
|
587
|
+
export declare namespace ObjectiveEventDataFinalized {
|
|
504
588
|
/**
|
|
505
589
|
* ObjectiveFinalized is the terminal event written when an objective is finalized.
|
|
506
590
|
* After this event, the objective is super-terminal: no further iterations,
|
|
@@ -514,6 +598,28 @@ export declare namespace ObjectiveEventData {
|
|
|
514
598
|
*/
|
|
515
599
|
output?: unknown;
|
|
516
600
|
}
|
|
601
|
+
}
|
|
602
|
+
export interface ObjectiveEventDataMemoryRead {
|
|
603
|
+
/**
|
|
604
|
+
* MemoryRead is emitted each time the agent resolves a key against the memory
|
|
605
|
+
* cascade and loads an entry. Lookups that miss (key not found in any layer) do
|
|
606
|
+
* not emit this event.
|
|
607
|
+
*/
|
|
608
|
+
memoryRead: MemoryRead;
|
|
609
|
+
type: 'memoryRead';
|
|
610
|
+
}
|
|
611
|
+
export interface ObjectiveEventDataNotice {
|
|
612
|
+
/**
|
|
613
|
+
* Notice is a non-terminal diagnostic emitted by the runtime when something
|
|
614
|
+
* noteworthy but non-fatal happens during an objective — for example a
|
|
615
|
+
* just-in-time tool set failing to load, or a previously loaded tool being dropped
|
|
616
|
+
* because it was archived. Notices carry no structured payload; they exist to make
|
|
617
|
+
* the objective timeline self-explanatory.
|
|
618
|
+
*/
|
|
619
|
+
notice: ObjectiveEventDataNotice.Notice;
|
|
620
|
+
type: 'notice';
|
|
621
|
+
}
|
|
622
|
+
export declare namespace ObjectiveEventDataNotice {
|
|
517
623
|
/**
|
|
518
624
|
* Notice is a non-terminal diagnostic emitted by the runtime when something
|
|
519
625
|
* noteworthy but non-fatal happens during an objective — for example a
|
|
@@ -534,6 +640,28 @@ export declare namespace ObjectiveEventData {
|
|
|
534
640
|
*/
|
|
535
641
|
message?: string;
|
|
536
642
|
}
|
|
643
|
+
}
|
|
644
|
+
export interface ObjectiveEventDataSubAgentSpawned {
|
|
645
|
+
subAgentSpawned: SubAgentSpawned;
|
|
646
|
+
type: 'subAgentSpawned';
|
|
647
|
+
}
|
|
648
|
+
export interface ObjectiveEventDataSubAgentUpdated {
|
|
649
|
+
subAgentUpdated: SubAgentUpdated;
|
|
650
|
+
type: 'subAgentUpdated';
|
|
651
|
+
}
|
|
652
|
+
export interface ObjectiveEventDataTimedOut {
|
|
653
|
+
/**
|
|
654
|
+
* ObjectiveTimedOut is the terminal event written when an objective is finalized
|
|
655
|
+
* by the inactivity sweep because it saw no activity (no user messages, no LLM
|
|
656
|
+
* calls) within its variation's inactivity timeout — or the system-wide 24 hour
|
|
657
|
+
* maximum when no timeout is configured. The objective produces no output. After
|
|
658
|
+
* this event, the objective is super-terminal: no further iterations, compaction,
|
|
659
|
+
* or continuation are permitted.
|
|
660
|
+
*/
|
|
661
|
+
timedOut: ObjectiveEventDataTimedOut.TimedOut;
|
|
662
|
+
type: 'timedOut';
|
|
663
|
+
}
|
|
664
|
+
export declare namespace ObjectiveEventDataTimedOut {
|
|
537
665
|
/**
|
|
538
666
|
* ObjectiveTimedOut is the terminal event written when an objective is finalized
|
|
539
667
|
* by the inactivity sweep because it saw no activity (no user messages, no LLM
|
|
@@ -550,6 +678,34 @@ export declare namespace ObjectiveEventData {
|
|
|
550
678
|
message?: string;
|
|
551
679
|
}
|
|
552
680
|
}
|
|
681
|
+
export interface ObjectiveEventDataToolApprovalRequested {
|
|
682
|
+
toolApprovalRequested: ToolApprovalRequested;
|
|
683
|
+
type: 'toolApprovalRequested';
|
|
684
|
+
}
|
|
685
|
+
export interface ObjectiveEventDataToolApproved {
|
|
686
|
+
toolApproved: ToolApproved;
|
|
687
|
+
type: 'toolApproved';
|
|
688
|
+
}
|
|
689
|
+
export interface ObjectiveEventDataToolCalled {
|
|
690
|
+
toolCalled: ToolCalled;
|
|
691
|
+
type: 'toolCalled';
|
|
692
|
+
}
|
|
693
|
+
export interface ObjectiveEventDataToolDenied {
|
|
694
|
+
toolDenied: ToolDenied;
|
|
695
|
+
type: 'toolDenied';
|
|
696
|
+
}
|
|
697
|
+
export interface ObjectiveEventDataToolError {
|
|
698
|
+
toolError: ToolError;
|
|
699
|
+
type: 'toolError';
|
|
700
|
+
}
|
|
701
|
+
export interface ObjectiveEventDataToolResult {
|
|
702
|
+
toolResult: ToolResult;
|
|
703
|
+
type: 'toolResult';
|
|
704
|
+
}
|
|
705
|
+
export interface ObjectiveEventDataUserMessage {
|
|
706
|
+
type: 'userMessage';
|
|
707
|
+
userMessage: UserMessage;
|
|
708
|
+
}
|
|
553
709
|
export interface ObjectiveEventInfo {
|
|
554
710
|
/**
|
|
555
711
|
* A profile identifies a user or non-human principal (such as an API key) at the
|
|
@@ -787,29 +943,36 @@ export interface ObjectiveRetrieveDiagnosticsResponse {
|
|
|
787
943
|
diagnostics: ObjectiveDiagnostics;
|
|
788
944
|
}
|
|
789
945
|
export interface ObjectiveCreateParams {
|
|
946
|
+
/**
|
|
947
|
+
* Path param
|
|
948
|
+
*/
|
|
949
|
+
workspaceId?: string;
|
|
950
|
+
/**
|
|
951
|
+
* Body param
|
|
952
|
+
*/
|
|
790
953
|
agentId: string;
|
|
791
954
|
/**
|
|
792
|
-
* Arbitrary data rendered into the selected variation's
|
|
793
|
-
* (liquid) to produce the objective's system prompt. If the
|
|
794
|
-
* system_prompt_data_schema, this must satisfy it.
|
|
955
|
+
* Body param: Arbitrary data rendered into the selected variation's
|
|
956
|
+
* system_prompt_template (liquid) to produce the objective's system prompt. If the
|
|
957
|
+
* agent has a system_prompt_data_schema, this must satisfy it.
|
|
795
958
|
*/
|
|
796
959
|
systemPromptData: {
|
|
797
960
|
[key: string]: unknown;
|
|
798
961
|
};
|
|
799
962
|
/**
|
|
800
|
-
* Episodic is used to configure the episodic memory for the objective
|
|
963
|
+
* Body param: Episodic is used to configure the episodic memory for the objective
|
|
801
964
|
*/
|
|
802
965
|
episodicMemory?: ObjectiveCreateParams.EpisodicMemory;
|
|
803
966
|
/**
|
|
804
|
-
* Optional explicit first user message for the LLM chat history. When
|
|
805
|
-
* selected variation's first_user_message_template is rendered with
|
|
967
|
+
* Body param: Optional explicit first user message for the LLM chat history. When
|
|
968
|
+
* not set, the selected variation's first_user_message_template is rendered with
|
|
806
969
|
* first_user_message_data instead. If neither this field nor a
|
|
807
970
|
* first_user_message_template is present, the request is rejected with
|
|
808
971
|
* InvalidArgument.
|
|
809
972
|
*/
|
|
810
973
|
firstUserMessage?: string;
|
|
811
974
|
/**
|
|
812
|
-
* Arbitrary data rendered into the selected variation's
|
|
975
|
+
* Body param: Arbitrary data rendered into the selected variation's
|
|
813
976
|
* first_user_message_template (liquid) to produce the first user message. Separate
|
|
814
977
|
* from `system_prompt_data`, which renders the system prompt template.
|
|
815
978
|
*/
|
|
@@ -817,8 +980,9 @@ export interface ObjectiveCreateParams {
|
|
|
817
980
|
[key: string]: unknown;
|
|
818
981
|
};
|
|
819
982
|
/**
|
|
820
|
-
* Memory layers/entries layered over the baseline cascade inherited
|
|
821
|
-
* selected variation — element-level rules over inherited styles, in CSS
|
|
983
|
+
* Body param: Memory layers/entries layered over the baseline cascade inherited
|
|
984
|
+
* from the selected variation — element-level rules over inherited styles, in CSS
|
|
985
|
+
* terms.
|
|
822
986
|
*
|
|
823
987
|
* Array order is resolution order: EARLIER elements are more specific and are
|
|
824
988
|
* consulted first. Entries pinned via memory_entry_id behave as single-entry
|
|
@@ -833,18 +997,18 @@ export interface ObjectiveCreateParams {
|
|
|
833
997
|
*/
|
|
834
998
|
memoryCascade?: Array<MemoryReference>;
|
|
835
999
|
/**
|
|
836
|
-
* CreateOperationMetadata contains the user-provided fields for
|
|
837
|
-
* operation. Read-only fields (id, account_id, workspace_id,
|
|
838
|
-
* profile_id) are excluded since they are set by the server.
|
|
1000
|
+
* Body param: CreateOperationMetadata contains the user-provided fields for
|
|
1001
|
+
* creating an operation. Read-only fields (id, account_id, workspace_id,
|
|
1002
|
+
* created_at, profile_id) are excluded since they are set by the server.
|
|
839
1003
|
*/
|
|
840
1004
|
metadata?: Shared.CreateOperationMetadata;
|
|
841
1005
|
/**
|
|
842
|
-
* Secrets that can be used in the headers for tool calls using the
|
|
843
|
-
* interpolation format.
|
|
1006
|
+
* Body param: Secrets that can be used in the headers for tool calls using the
|
|
1007
|
+
* secret interpolation format.
|
|
844
1008
|
*/
|
|
845
1009
|
secrets?: Array<ObjectiveCreateParams.Secret>;
|
|
846
1010
|
/**
|
|
847
|
-
* Optional explicit variation selection. Overrides the agent's
|
|
1011
|
+
* Body param: Optional explicit variation selection. Overrides the agent's
|
|
848
1012
|
* variation_selection_mode.
|
|
849
1013
|
*/
|
|
850
1014
|
variationId?: string;
|
|
@@ -858,7 +1022,7 @@ export declare namespace ObjectiveCreateParams {
|
|
|
858
1022
|
* The caller-supplied episodic key. Objectives created with the same key (for the
|
|
859
1023
|
* same agent) share one episodic memory layer.
|
|
860
1024
|
*/
|
|
861
|
-
key
|
|
1025
|
+
key: string;
|
|
862
1026
|
}
|
|
863
1027
|
interface Secret {
|
|
864
1028
|
name?: string;
|
|
@@ -866,39 +1030,46 @@ export declare namespace ObjectiveCreateParams {
|
|
|
866
1030
|
}
|
|
867
1031
|
}
|
|
868
1032
|
export interface ObjectiveRetrieveParams {
|
|
869
|
-
workspaceId
|
|
1033
|
+
workspaceId?: string;
|
|
870
1034
|
}
|
|
871
1035
|
export interface ObjectiveListParams extends CursorPaginationParams {
|
|
872
1036
|
/**
|
|
873
|
-
*
|
|
1037
|
+
* Path param
|
|
1038
|
+
*/
|
|
1039
|
+
workspaceId?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* Query param: Agent ID for filtering
|
|
874
1042
|
*/
|
|
875
1043
|
agentId?: string;
|
|
876
1044
|
/**
|
|
877
|
-
* Filter to objectives produced by a specific AgentSchedule. Accepts
|
|
878
|
-
* as\_… form or external_id:<value> form.
|
|
1045
|
+
* Query param: Filter to objectives produced by a specific AgentSchedule. Accepts
|
|
1046
|
+
* canonical as\_… form or external_id:<value> form.
|
|
879
1047
|
*/
|
|
880
1048
|
agentScheduleId?: string;
|
|
881
1049
|
/**
|
|
882
|
-
* When set to true you may use more of your alloted API rate-limit
|
|
1050
|
+
* Query param: When set to true you may use more of your alloted API rate-limit
|
|
883
1051
|
*/
|
|
884
1052
|
includeInfo?: boolean;
|
|
885
1053
|
/**
|
|
886
|
-
* Filters by metadata labels. Comma-separated key=value pairs, e.g.
|
|
1054
|
+
* Query param: Filters by metadata labels. Comma-separated key=value pairs, e.g.
|
|
887
1055
|
* "env=prod,team=ai". A resource matches only if every pair matches exactly (AND
|
|
888
1056
|
* semantics).
|
|
889
1057
|
*/
|
|
890
1058
|
labels?: string;
|
|
891
1059
|
/**
|
|
892
|
-
* Optional filters
|
|
1060
|
+
* Query param: Optional filters
|
|
893
1061
|
*/
|
|
894
1062
|
parentObjectiveId?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* Query param
|
|
1065
|
+
*/
|
|
895
1066
|
profileId?: string;
|
|
896
1067
|
/**
|
|
897
|
-
* Sort order for results (asc or desc by creation time)
|
|
1068
|
+
* Query param: Sort order for results (asc or desc by creation time)
|
|
898
1069
|
*/
|
|
899
1070
|
sortOrder?: string;
|
|
900
1071
|
/**
|
|
901
|
-
* Filter by state
|
|
1072
|
+
* Query param: Filter by state
|
|
902
1073
|
*/
|
|
903
1074
|
state?: 'STATE_UNSPECIFIED' | 'STATE_PENDING' | 'STATE_RUNNING' | 'STATE_WAITING' | 'STATE_FAILED' | 'STATE_CANCELLED' | 'STATE_FINALIZED' | 'STATE_TIMED_OUT';
|
|
904
1075
|
}
|
|
@@ -906,7 +1077,7 @@ export interface ObjectiveCancelParams {
|
|
|
906
1077
|
/**
|
|
907
1078
|
* Path param
|
|
908
1079
|
*/
|
|
909
|
-
workspaceId
|
|
1080
|
+
workspaceId?: string;
|
|
910
1081
|
/**
|
|
911
1082
|
* Body param: Optional reason for cancellation
|
|
912
1083
|
*/
|
|
@@ -916,7 +1087,7 @@ export interface ObjectiveCompactParams {
|
|
|
916
1087
|
/**
|
|
917
1088
|
* Path param
|
|
918
1089
|
*/
|
|
919
|
-
workspaceId
|
|
1090
|
+
workspaceId?: string;
|
|
920
1091
|
/**
|
|
921
1092
|
* Body param: CompactionConfig defines how context window compaction behaves for
|
|
922
1093
|
* objectives using this variation.
|
|
@@ -927,23 +1098,23 @@ export interface ObjectiveContinueParams {
|
|
|
927
1098
|
/**
|
|
928
1099
|
* Path param
|
|
929
1100
|
*/
|
|
930
|
-
workspaceId
|
|
1101
|
+
workspaceId?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Body param: The message to continue an objective that has completed (or you are
|
|
1104
|
+
* enqueing)
|
|
1105
|
+
*/
|
|
1106
|
+
message: string;
|
|
931
1107
|
/**
|
|
932
1108
|
* Body param: When set to true, the message will be enqueued for when the agent
|
|
933
1109
|
* loop is available to process it.
|
|
934
1110
|
*/
|
|
935
1111
|
enqueue?: boolean;
|
|
936
|
-
/**
|
|
937
|
-
* Body param: The message to continue an objective that has completed (or you are
|
|
938
|
-
* enqueing)
|
|
939
|
-
*/
|
|
940
|
-
message?: string;
|
|
941
1112
|
}
|
|
942
1113
|
export interface ObjectiveListContextWindowsParams extends CursorPaginationParams {
|
|
943
1114
|
/**
|
|
944
1115
|
* Path param
|
|
945
1116
|
*/
|
|
946
|
-
workspaceId
|
|
1117
|
+
workspaceId?: string;
|
|
947
1118
|
/**
|
|
948
1119
|
* Query param: When set to true you may use more of your alloted API rate-limit
|
|
949
1120
|
*/
|
|
@@ -959,7 +1130,7 @@ export interface ObjectiveListEventsParams extends CursorPaginationParams {
|
|
|
959
1130
|
/**
|
|
960
1131
|
* Path param
|
|
961
1132
|
*/
|
|
962
|
-
workspaceId
|
|
1133
|
+
workspaceId?: string;
|
|
963
1134
|
/**
|
|
964
1135
|
* Query param: When set to true you may use more of your alloted API rate-limit
|
|
965
1136
|
*/
|
|
@@ -984,15 +1155,15 @@ export interface ObjectiveListEventsParams extends CursorPaginationParams {
|
|
|
984
1155
|
windowId?: string;
|
|
985
1156
|
}
|
|
986
1157
|
export interface ObjectiveRetrieveDiagnosticsParams {
|
|
987
|
-
workspaceId
|
|
1158
|
+
workspaceId?: string;
|
|
988
1159
|
}
|
|
989
1160
|
export interface ObjectiveStreamEventsParams {
|
|
990
|
-
workspaceId
|
|
1161
|
+
workspaceId?: string;
|
|
991
1162
|
}
|
|
992
1163
|
export declare namespace Objectives {
|
|
993
|
-
export { type AssistantMessage as AssistantMessage, type AssistantToolCall as AssistantToolCall, type CallableTool as CallableTool, type ContextLengths as ContextLengths, type ContextWindowCompacted as ContextWindowCompacted, type MemoryRead as MemoryRead, type MemoryReference as MemoryReference, type Objective as Objective, type ObjectiveConfigSnapshot as ObjectiveConfigSnapshot, type ObjectiveContextWindow as ObjectiveContextWindow, type ObjectiveContextWindowData as ObjectiveContextWindowData, type ObjectiveDiagnostics as ObjectiveDiagnostics, type ObjectiveError as ObjectiveError, type ObjectiveEvent as ObjectiveEvent, type ObjectiveEventData as ObjectiveEventData, type ObjectiveEventInfo as ObjectiveEventInfo, type ObjectiveEventWebhookData as ObjectiveEventWebhookData, type ObjectiveInfo as ObjectiveInfo, type ObjectiveSecret as ObjectiveSecret, type SubAgentSpawned as SubAgentSpawned, type SubAgentUpdated as SubAgentUpdated, type ToolApprovalRequested as ToolApprovalRequested, type ToolApproved as ToolApproved, type ToolCalled as ToolCalled, type ToolDenied as ToolDenied, type ToolError as ToolError, type ToolResult as ToolResult, type UserMessage as UserMessage, type ObjectiveCompactResponse as ObjectiveCompactResponse, type ObjectiveRetrieveDiagnosticsResponse as ObjectiveRetrieveDiagnosticsResponse, type ObjectivesCursorPagination as ObjectivesCursorPagination, type ObjectiveContextWindowsCursorPagination as ObjectiveContextWindowsCursorPagination, type ObjectiveEventsCursorPagination as ObjectiveEventsCursorPagination, type ObjectiveCreateParams as ObjectiveCreateParams, type ObjectiveRetrieveParams as ObjectiveRetrieveParams, type ObjectiveListParams as ObjectiveListParams, type ObjectiveCancelParams as ObjectiveCancelParams, type ObjectiveCompactParams as ObjectiveCompactParams, type ObjectiveContinueParams as ObjectiveContinueParams, type ObjectiveListContextWindowsParams as ObjectiveListContextWindowsParams, type ObjectiveListEventsParams as ObjectiveListEventsParams, type ObjectiveRetrieveDiagnosticsParams as ObjectiveRetrieveDiagnosticsParams, type ObjectiveStreamEventsParams as ObjectiveStreamEventsParams, };
|
|
1164
|
+
export { type AssistantMessage as AssistantMessage, type AssistantToolCall as AssistantToolCall, type CallableTool as CallableTool, type CallableToolAgent as CallableToolAgent, type CallableToolCadenyaProvidedTool as CallableToolCadenyaProvidedTool, type CallableToolTool as CallableToolTool, type ContextLengths as ContextLengths, type ContextWindowCompacted as ContextWindowCompacted, type MemoryRead as MemoryRead, type MemoryReference as MemoryReference, type Objective as Objective, type ObjectiveConfigSnapshot as ObjectiveConfigSnapshot, type ObjectiveContextWindow as ObjectiveContextWindow, type ObjectiveContextWindowData as ObjectiveContextWindowData, type ObjectiveDiagnostics as ObjectiveDiagnostics, type ObjectiveError as ObjectiveError, type ObjectiveEvent as ObjectiveEvent, type ObjectiveEventData as ObjectiveEventData, type ObjectiveEventDataAssistantMessage as ObjectiveEventDataAssistantMessage, type ObjectiveEventDataCancelled as ObjectiveEventDataCancelled, type ObjectiveEventDataContextWindowCompacted as ObjectiveEventDataContextWindowCompacted, type ObjectiveEventDataError as ObjectiveEventDataError, type ObjectiveEventDataFinalized as ObjectiveEventDataFinalized, type ObjectiveEventDataMemoryRead as ObjectiveEventDataMemoryRead, type ObjectiveEventDataNotice as ObjectiveEventDataNotice, type ObjectiveEventDataSubAgentSpawned as ObjectiveEventDataSubAgentSpawned, type ObjectiveEventDataSubAgentUpdated as ObjectiveEventDataSubAgentUpdated, type ObjectiveEventDataTimedOut as ObjectiveEventDataTimedOut, type ObjectiveEventDataToolApprovalRequested as ObjectiveEventDataToolApprovalRequested, type ObjectiveEventDataToolApproved as ObjectiveEventDataToolApproved, type ObjectiveEventDataToolCalled as ObjectiveEventDataToolCalled, type ObjectiveEventDataToolDenied as ObjectiveEventDataToolDenied, type ObjectiveEventDataToolError as ObjectiveEventDataToolError, type ObjectiveEventDataToolResult as ObjectiveEventDataToolResult, type ObjectiveEventDataUserMessage as ObjectiveEventDataUserMessage, type ObjectiveEventInfo as ObjectiveEventInfo, type ObjectiveEventWebhookData as ObjectiveEventWebhookData, type ObjectiveInfo as ObjectiveInfo, type ObjectiveSecret as ObjectiveSecret, type SubAgentSpawned as SubAgentSpawned, type SubAgentUpdated as SubAgentUpdated, type ToolApprovalRequested as ToolApprovalRequested, type ToolApproved as ToolApproved, type ToolCalled as ToolCalled, type ToolDenied as ToolDenied, type ToolError as ToolError, type ToolResult as ToolResult, type UserMessage as UserMessage, type ObjectiveCompactResponse as ObjectiveCompactResponse, type ObjectiveRetrieveDiagnosticsResponse as ObjectiveRetrieveDiagnosticsResponse, type ObjectivesCursorPagination as ObjectivesCursorPagination, type ObjectiveContextWindowsCursorPagination as ObjectiveContextWindowsCursorPagination, type ObjectiveEventsCursorPagination as ObjectiveEventsCursorPagination, type ObjectiveCreateParams as ObjectiveCreateParams, type ObjectiveRetrieveParams as ObjectiveRetrieveParams, type ObjectiveListParams as ObjectiveListParams, type ObjectiveCancelParams as ObjectiveCancelParams, type ObjectiveCompactParams as ObjectiveCompactParams, type ObjectiveContinueParams as ObjectiveContinueParams, type ObjectiveListContextWindowsParams as ObjectiveListContextWindowsParams, type ObjectiveListEventsParams as ObjectiveListEventsParams, type ObjectiveRetrieveDiagnosticsParams as ObjectiveRetrieveDiagnosticsParams, type ObjectiveStreamEventsParams as ObjectiveStreamEventsParams, };
|
|
994
1165
|
export { Tools as Tools, type ObjectiveTool as ObjectiveTool, type ObjectiveToolsCursorPagination as ObjectiveToolsCursorPagination, type ToolListParams as ToolListParams, };
|
|
995
|
-
export { ToolCalls as ToolCalls, type ObjectiveToolCall as ObjectiveToolCall, type ObjectiveToolCallData as ObjectiveToolCallData, type ObjectiveToolCallInfo as ObjectiveToolCallInfo, type ObjectiveToolCallResult as ObjectiveToolCallResult, type ObjectiveToolCallResultAudioBlock as ObjectiveToolCallResultAudioBlock, type ObjectiveToolCallResultContentBlock as ObjectiveToolCallResultContentBlock, type ObjectiveToolCallResultImageBlock as ObjectiveToolCallResultImageBlock, type ObjectiveToolCallResultTextBlock as ObjectiveToolCallResultTextBlock, type ObjectiveToolCallWithResult as ObjectiveToolCallWithResult, type ResolvedSecret as ResolvedSecret, type SetToolCallContentRequestAudioBlock as SetToolCallContentRequestAudioBlock, type SetToolCallContentRequestContentBlock as SetToolCallContentRequestContentBlock, type SetToolCallContentRequestImageBlock as SetToolCallContentRequestImageBlock, type SetToolCallContentRequestTextBlock as SetToolCallContentRequestTextBlock, type ObjectiveToolCallsCursorPagination as ObjectiveToolCallsCursorPagination, type ToolCallRetrieveParams as ToolCallRetrieveParams, type ToolCallListParams as ToolCallListParams, type ToolCallApproveParams as ToolCallApproveParams, type ToolCallDenyParams as ToolCallDenyParams, type ToolCallSetContentParams as ToolCallSetContentParams, };
|
|
1166
|
+
export { ToolCalls as ToolCalls, type ObjectiveToolCall as ObjectiveToolCall, type ObjectiveToolCallData as ObjectiveToolCallData, type ObjectiveToolCallInfo as ObjectiveToolCallInfo, type ObjectiveToolCallResult as ObjectiveToolCallResult, type ObjectiveToolCallResultAudioBlock as ObjectiveToolCallResultAudioBlock, type ObjectiveToolCallResultContentBlock as ObjectiveToolCallResultContentBlock, type ObjectiveToolCallResultContentBlockAudio as ObjectiveToolCallResultContentBlockAudio, type ObjectiveToolCallResultContentBlockImage as ObjectiveToolCallResultContentBlockImage, type ObjectiveToolCallResultContentBlockText as ObjectiveToolCallResultContentBlockText, type ObjectiveToolCallResultImageBlock as ObjectiveToolCallResultImageBlock, type ObjectiveToolCallResultTextBlock as ObjectiveToolCallResultTextBlock, type ObjectiveToolCallWithResult as ObjectiveToolCallWithResult, type ResolvedSecret as ResolvedSecret, type SetToolCallContentRequestAudioBlock as SetToolCallContentRequestAudioBlock, type SetToolCallContentRequestContentBlock as SetToolCallContentRequestContentBlock, type SetToolCallContentRequestContentBlockAudio as SetToolCallContentRequestContentBlockAudio, type SetToolCallContentRequestContentBlockImage as SetToolCallContentRequestContentBlockImage, type SetToolCallContentRequestContentBlockText as SetToolCallContentRequestContentBlockText, type SetToolCallContentRequestImageBlock as SetToolCallContentRequestImageBlock, type SetToolCallContentRequestTextBlock as SetToolCallContentRequestTextBlock, type ObjectiveToolCallsCursorPagination as ObjectiveToolCallsCursorPagination, type ToolCallRetrieveParams as ToolCallRetrieveParams, type ToolCallListParams as ToolCallListParams, type ToolCallApproveParams as ToolCallApproveParams, type ToolCallDenyParams as ToolCallDenyParams, type ToolCallSetContentParams as ToolCallSetContentParams, };
|
|
996
1167
|
export { Tasks as Tasks, type ObjectiveTask as ObjectiveTask, type ObjectiveTaskData as ObjectiveTaskData, type ObjectiveTasksCursorPagination as ObjectiveTasksCursorPagination, type TaskRetrieveParams as TaskRetrieveParams, type TaskListParams as TaskListParams, };
|
|
997
1168
|
export { Feedback as Feedback, type ObjectiveFeedback as ObjectiveFeedback, type ObjectiveFeedbackData as ObjectiveFeedbackData, type ObjectiveFeedbackInfo as ObjectiveFeedbackInfo, type ObjectiveFeedbacksCursorPagination as ObjectiveFeedbacksCursorPagination, type FeedbackCreateParams as FeedbackCreateParams, type FeedbackListParams as FeedbackListParams, };
|
|
998
1169
|
}
|