@nimble-way/nimble-js 0.19.0 → 0.20.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.
Files changed (82) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/package.json +1 -1
  3. package/resources/agent.d.mts +9 -26
  4. package/resources/agent.d.mts.map +1 -1
  5. package/resources/agent.d.ts +9 -26
  6. package/resources/agent.d.ts.map +1 -1
  7. package/resources/agent.js +4 -21
  8. package/resources/agent.js.map +1 -1
  9. package/resources/agent.mjs +4 -21
  10. package/resources/agent.mjs.map +1 -1
  11. package/resources/jobs/jobs.d.mts +18 -6
  12. package/resources/jobs/jobs.d.mts.map +1 -1
  13. package/resources/jobs/jobs.d.ts +18 -6
  14. package/resources/jobs/jobs.d.ts.map +1 -1
  15. package/resources/jobs/jobs.js +12 -0
  16. package/resources/jobs/jobs.js.map +1 -1
  17. package/resources/jobs/jobs.mjs +12 -0
  18. package/resources/jobs/jobs.mjs.map +1 -1
  19. package/resources/jobs/runs/artifacts.d.mts +11 -13
  20. package/resources/jobs/runs/artifacts.d.mts.map +1 -1
  21. package/resources/jobs/runs/artifacts.d.ts +11 -13
  22. package/resources/jobs/runs/artifacts.d.ts.map +1 -1
  23. package/resources/jobs/runs/artifacts.js +8 -0
  24. package/resources/jobs/runs/artifacts.js.map +1 -1
  25. package/resources/jobs/runs/artifacts.mjs +8 -0
  26. package/resources/jobs/runs/artifacts.mjs.map +1 -1
  27. package/resources/jobs/runs/runs.d.mts +12 -6
  28. package/resources/jobs/runs/runs.d.mts.map +1 -1
  29. package/resources/jobs/runs/runs.d.ts +12 -6
  30. package/resources/jobs/runs/runs.d.ts.map +1 -1
  31. package/resources/jobs/runs/runs.js +6 -0
  32. package/resources/jobs/runs/runs.js.map +1 -1
  33. package/resources/jobs/runs/runs.mjs +6 -0
  34. package/resources/jobs/runs/runs.mjs.map +1 -1
  35. package/resources/task-agent/index.d.mts +1 -1
  36. package/resources/task-agent/index.d.mts.map +1 -1
  37. package/resources/task-agent/index.d.ts +1 -1
  38. package/resources/task-agent/index.d.ts.map +1 -1
  39. package/resources/task-agent/index.js.map +1 -1
  40. package/resources/task-agent/index.mjs.map +1 -1
  41. package/resources/task-agent/runs.d.mts +246 -110
  42. package/resources/task-agent/runs.d.mts.map +1 -1
  43. package/resources/task-agent/runs.d.ts +246 -110
  44. package/resources/task-agent/runs.d.ts.map +1 -1
  45. package/resources/task-agent/runs.js +12 -14
  46. package/resources/task-agent/runs.js.map +1 -1
  47. package/resources/task-agent/runs.mjs +12 -14
  48. package/resources/task-agent/runs.mjs.map +1 -1
  49. package/resources/task-agent/task-agent.d.mts +557 -65
  50. package/resources/task-agent/task-agent.d.mts.map +1 -1
  51. package/resources/task-agent/task-agent.d.ts +557 -65
  52. package/resources/task-agent/task-agent.d.ts.map +1 -1
  53. package/resources/task-agent/task-agent.js +12 -0
  54. package/resources/task-agent/task-agent.js.map +1 -1
  55. package/resources/task-agent/task-agent.mjs +12 -0
  56. package/resources/task-agent/task-agent.mjs.map +1 -1
  57. package/resources/task-agent/templates.d.mts +167 -13
  58. package/resources/task-agent/templates.d.mts.map +1 -1
  59. package/resources/task-agent/templates.d.ts +167 -13
  60. package/resources/task-agent/templates.d.ts.map +1 -1
  61. package/resources/task-agent/templates.js +4 -0
  62. package/resources/task-agent/templates.js.map +1 -1
  63. package/resources/task-agent/templates.mjs +4 -0
  64. package/resources/task-agent/templates.mjs.map +1 -1
  65. package/resources/top-level.d.mts +0 -6
  66. package/resources/top-level.d.mts.map +1 -1
  67. package/resources/top-level.d.ts +0 -6
  68. package/resources/top-level.d.ts.map +1 -1
  69. package/src/resources/agent.ts +10 -27
  70. package/src/resources/jobs/jobs.ts +18 -6
  71. package/src/resources/jobs/runs/artifacts.ts +11 -13
  72. package/src/resources/jobs/runs/runs.ts +12 -6
  73. package/src/resources/task-agent/index.ts +0 -2
  74. package/src/resources/task-agent/runs.ts +251 -129
  75. package/src/resources/task-agent/task-agent.ts +559 -79
  76. package/src/resources/task-agent/templates.ts +170 -15
  77. package/src/resources/top-level.ts +0 -5
  78. package/src/version.ts +1 -1
  79. package/version.d.mts +1 -1
  80. package/version.d.ts +1 -1
  81. package/version.js +1 -1
  82. package/version.mjs +1 -1
@@ -1,6 +1,6 @@
1
1
  import { APIResource } from "../../core/resource.mjs";
2
2
  import * as RunsAPI from "./runs.mjs";
3
- import { RunCancelParams, RunGetParams, RunGetResponse, RunGetResultParams, RunGetResultResponse, RunListParams, RunListResponse, RunStreamEventsParams, RunStreamEventsResponse, Runs } from "./runs.mjs";
3
+ import { RunGetParams, RunGetResponse, RunGetResultParams, RunGetResultResponse, RunListParams, RunListResponse, RunStreamEventsParams, Runs } from "./runs.mjs";
4
4
  import * as TemplatesAPI from "./templates.mjs";
5
5
  import { TemplateGetResponse, TemplateListParams, TemplateListResponse, Templates } from "./templates.mjs";
6
6
  import { APIPromise } from "../../core/api-promise.mjs";
@@ -12,10 +12,14 @@ export declare class TaskAgent extends APIResource {
12
12
  * Create a Web Search Agent instance.
13
13
  *
14
14
  * `account_id` is JWT-derived and never read from the request body.
15
+ *
16
+ * @deprecated
15
17
  */
16
18
  create(body: TaskAgentCreateParams, options?: RequestOptions): APIPromise<TaskAgentCreateResponse>;
17
19
  /**
18
20
  * Update Agent
21
+ *
22
+ * @deprecated
19
23
  */
20
24
  update(agentID: string, params: TaskAgentUpdateParams, options?: RequestOptions): APIPromise<TaskAgentUpdateResponse>;
21
25
  /**
@@ -23,295 +27,676 @@ export declare class TaskAgent extends APIResource {
23
27
  *
24
28
  * Callers are strictly scoped to their (account, workspace). If `workspace_id` is
25
29
  * omitted, the user's default workspace is used.
30
+ *
31
+ * @deprecated
26
32
  */
27
33
  list(query?: TaskAgentListParams | null | undefined, options?: RequestOptions): APIPromise<TaskAgentListResponse>;
28
34
  /**
29
35
  * Deactivate Agent
36
+ *
37
+ * @deprecated
30
38
  */
31
39
  deactivate(agentID: string, options?: RequestOptions): APIPromise<void>;
32
40
  /**
33
41
  * Get Agent
42
+ *
43
+ * @deprecated
34
44
  */
35
45
  get(agentID: string, options?: RequestOptions): APIPromise<TaskAgentGetResponse>;
36
46
  /**
37
47
  * Create a research run for a Web Search Agent instance.
48
+ *
49
+ * @deprecated
38
50
  */
39
51
  run(agentID: string, body: TaskAgentRunParams, options?: RequestOptions): APIPromise<TaskAgentRunResponse>;
40
52
  }
41
53
  export interface TaskAgentCreateResponse {
54
+ /**
55
+ * Unique web search agent identifier (wsa\_<uuid>).
56
+ */
42
57
  id: string;
58
+ /**
59
+ * When the agent was created.
60
+ */
43
61
  created_at: string;
62
+ /**
63
+ * Agent description shown to users.
64
+ */
44
65
  description: string;
66
+ /**
67
+ * Human-friendly agent name shown to users.
68
+ */
45
69
  display_name: string;
70
+ /**
71
+ * Domain expertise or operating context for the agent.
72
+ */
46
73
  domain_expertise: string;
47
74
  /**
48
- * Canonical effort tier names for the research graph.
75
+ * Default effort level for this agent's runs.
49
76
  */
50
77
  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
78
+ /**
79
+ * Ordered goals for the agent to follow.
80
+ */
51
81
  goals: Array<TaskAgentCreateResponse.Goal>;
82
+ /**
83
+ * Icon identifier used when presenting the agent.
84
+ */
52
85
  icon: string;
86
+ /**
87
+ * Whether the agent can be used to start new runs.
88
+ */
53
89
  is_active: boolean;
90
+ /**
91
+ * JSON schema describing the structured output the agent should produce.
92
+ */
54
93
  output_schema: {
55
94
  [key: string]: unknown;
56
95
  } | null;
57
96
  /**
58
- * Response variant of AgentSources — preserves per-row id on allow rows.
97
+ * Source guidance for the agent.
59
98
  */
60
99
  sources: TaskAgentCreateResponse.Sources;
100
+ /**
101
+ * Suggested prompts users can run with this agent.
102
+ */
61
103
  suggested_questions: Array<TaskAgentCreateResponse.SuggestedQuestion>;
104
+ /**
105
+ * When the agent was last updated.
106
+ */
62
107
  updated_at: string;
108
+ /**
109
+ * Primary use case supported by the agent.
110
+ */
63
111
  use_case: 'research' | 'enrichment' | 'dataset_building';
64
- account_id?: string | null;
112
+ /**
113
+ * Stable agent name.
114
+ */
65
115
  agent_name?: string | null;
66
- workspace_id?: string | null;
67
116
  }
68
117
  export declare namespace TaskAgentCreateResponse {
69
118
  interface Goal {
119
+ /**
120
+ * Unique goal identifier (wsag\_<uuid>).
121
+ */
70
122
  id: string;
123
+ /**
124
+ * Goal text.
125
+ */
71
126
  goal: string;
127
+ /**
128
+ * Zero-based goal position.
129
+ */
72
130
  order: number;
73
131
  }
74
132
  /**
75
- * Response variant of AgentSources — preserves per-row id on allow rows.
133
+ * Source guidance for the agent.
76
134
  */
77
135
  interface Sources {
136
+ /**
137
+ * Source groups the agent is allowed to use.
138
+ */
78
139
  allow?: Array<Sources.Allow>;
140
+ /**
141
+ * Free-text guidance describing sources or domains to avoid.
142
+ */
79
143
  avoid?: string | null;
144
+ /**
145
+ * Source groups the agent should not use.
146
+ */
80
147
  block?: Array<Sources.Block>;
148
+ /**
149
+ * Free-text guidance describing sources or domains to prioritize.
150
+ */
81
151
  prioritize?: string | null;
82
152
  }
83
153
  namespace Sources {
84
154
  interface Allow {
155
+ /**
156
+ * Unique source group identifier (wsas\_<uuid>).
157
+ */
85
158
  id: string;
159
+ /**
160
+ * Domains included in this source group.
161
+ */
86
162
  domains: Array<string>;
163
+ /**
164
+ * Zero-based source group position.
165
+ */
87
166
  order: number;
167
+ /**
168
+ * Source group title.
169
+ */
88
170
  title: string;
89
171
  }
90
- /**
91
- * Lenient response shape — domains are plain strings (no re-validation).
92
- */
93
172
  interface Block {
173
+ /**
174
+ * Unique source group identifier (wsas\_<uuid>).
175
+ */
176
+ id: string;
177
+ /**
178
+ * Domains included in this source group.
179
+ */
94
180
  domains: Array<string>;
181
+ /**
182
+ * Zero-based source group position.
183
+ */
95
184
  order: number;
185
+ /**
186
+ * Source group title.
187
+ */
96
188
  title: string;
97
189
  }
98
190
  }
99
191
  interface SuggestedQuestion {
192
+ /**
193
+ * Unique suggested question identifier (wsasq\_<uuid>).
194
+ */
100
195
  id: string;
196
+ /**
197
+ * Zero-based suggested question position.
198
+ */
101
199
  order: number;
200
+ /**
201
+ * Suggested prompt text.
202
+ */
102
203
  question: string;
103
204
  }
104
205
  }
105
206
  export interface TaskAgentUpdateResponse {
207
+ /**
208
+ * Unique web search agent identifier (wsa\_<uuid>).
209
+ */
106
210
  id: string;
211
+ /**
212
+ * When the agent was created.
213
+ */
107
214
  created_at: string;
215
+ /**
216
+ * Agent description shown to users.
217
+ */
108
218
  description: string;
219
+ /**
220
+ * Human-friendly agent name shown to users.
221
+ */
109
222
  display_name: string;
223
+ /**
224
+ * Domain expertise or operating context for the agent.
225
+ */
110
226
  domain_expertise: string;
111
227
  /**
112
- * Canonical effort tier names for the research graph.
228
+ * Default effort level for this agent's runs.
113
229
  */
114
230
  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
231
+ /**
232
+ * Ordered goals for the agent to follow.
233
+ */
115
234
  goals: Array<TaskAgentUpdateResponse.Goal>;
235
+ /**
236
+ * Icon identifier used when presenting the agent.
237
+ */
116
238
  icon: string;
239
+ /**
240
+ * Whether the agent can be used to start new runs.
241
+ */
117
242
  is_active: boolean;
243
+ /**
244
+ * JSON schema describing the structured output the agent should produce.
245
+ */
118
246
  output_schema: {
119
247
  [key: string]: unknown;
120
248
  } | null;
121
249
  /**
122
- * Response variant of AgentSources — preserves per-row id on allow rows.
250
+ * Source guidance for the agent.
123
251
  */
124
252
  sources: TaskAgentUpdateResponse.Sources;
253
+ /**
254
+ * Suggested prompts users can run with this agent.
255
+ */
125
256
  suggested_questions: Array<TaskAgentUpdateResponse.SuggestedQuestion>;
257
+ /**
258
+ * When the agent was last updated.
259
+ */
126
260
  updated_at: string;
261
+ /**
262
+ * Primary use case supported by the agent.
263
+ */
127
264
  use_case: 'research' | 'enrichment' | 'dataset_building';
128
- account_id?: string | null;
265
+ /**
266
+ * Stable agent name.
267
+ */
129
268
  agent_name?: string | null;
130
- workspace_id?: string | null;
131
269
  }
132
270
  export declare namespace TaskAgentUpdateResponse {
133
271
  interface Goal {
272
+ /**
273
+ * Unique goal identifier (wsag\_<uuid>).
274
+ */
134
275
  id: string;
276
+ /**
277
+ * Goal text.
278
+ */
135
279
  goal: string;
280
+ /**
281
+ * Zero-based goal position.
282
+ */
136
283
  order: number;
137
284
  }
138
285
  /**
139
- * Response variant of AgentSources — preserves per-row id on allow rows.
286
+ * Source guidance for the agent.
140
287
  */
141
288
  interface Sources {
289
+ /**
290
+ * Source groups the agent is allowed to use.
291
+ */
142
292
  allow?: Array<Sources.Allow>;
293
+ /**
294
+ * Free-text guidance describing sources or domains to avoid.
295
+ */
143
296
  avoid?: string | null;
297
+ /**
298
+ * Source groups the agent should not use.
299
+ */
144
300
  block?: Array<Sources.Block>;
301
+ /**
302
+ * Free-text guidance describing sources or domains to prioritize.
303
+ */
145
304
  prioritize?: string | null;
146
305
  }
147
306
  namespace Sources {
148
307
  interface Allow {
308
+ /**
309
+ * Unique source group identifier (wsas\_<uuid>).
310
+ */
149
311
  id: string;
312
+ /**
313
+ * Domains included in this source group.
314
+ */
150
315
  domains: Array<string>;
316
+ /**
317
+ * Zero-based source group position.
318
+ */
151
319
  order: number;
320
+ /**
321
+ * Source group title.
322
+ */
152
323
  title: string;
153
324
  }
154
- /**
155
- * Lenient response shape — domains are plain strings (no re-validation).
156
- */
157
325
  interface Block {
326
+ /**
327
+ * Unique source group identifier (wsas\_<uuid>).
328
+ */
329
+ id: string;
330
+ /**
331
+ * Domains included in this source group.
332
+ */
158
333
  domains: Array<string>;
334
+ /**
335
+ * Zero-based source group position.
336
+ */
159
337
  order: number;
338
+ /**
339
+ * Source group title.
340
+ */
160
341
  title: string;
161
342
  }
162
343
  }
163
344
  interface SuggestedQuestion {
345
+ /**
346
+ * Unique suggested question identifier (wsasq\_<uuid>).
347
+ */
164
348
  id: string;
349
+ /**
350
+ * Zero-based suggested question position.
351
+ */
165
352
  order: number;
353
+ /**
354
+ * Suggested prompt text.
355
+ */
166
356
  question: string;
167
357
  }
168
358
  }
169
- export type TaskAgentListResponse = Array<TaskAgentListResponse.TaskAgentListResponseItem>;
359
+ export interface TaskAgentListResponse {
360
+ /**
361
+ * Items returned in this page.
362
+ */
363
+ items: Array<TaskAgentListResponse.Item>;
364
+ /**
365
+ * Maximum number of items returned.
366
+ */
367
+ limit: number;
368
+ /**
369
+ * Number of items skipped before this page.
370
+ */
371
+ offset: number;
372
+ /**
373
+ * Total number of items matching the query.
374
+ */
375
+ total: number;
376
+ }
170
377
  export declare namespace TaskAgentListResponse {
171
- interface TaskAgentListResponseItem {
378
+ interface Item {
379
+ /**
380
+ * Unique web search agent identifier (wsa\_<uuid>).
381
+ */
172
382
  id: string;
383
+ /**
384
+ * When the agent was created.
385
+ */
173
386
  created_at: string;
387
+ /**
388
+ * Agent description shown to users.
389
+ */
174
390
  description: string;
391
+ /**
392
+ * Human-friendly agent name shown to users.
393
+ */
175
394
  display_name: string;
395
+ /**
396
+ * Domain expertise or operating context for the agent.
397
+ */
176
398
  domain_expertise: string;
177
399
  /**
178
- * Canonical effort tier names for the research graph.
400
+ * Default effort level for this agent's runs.
179
401
  */
180
402
  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
181
- goals: Array<TaskAgentListResponseItem.Goal>;
403
+ /**
404
+ * Ordered goals for the agent to follow.
405
+ */
406
+ goals: Array<Item.Goal>;
407
+ /**
408
+ * Icon identifier used when presenting the agent.
409
+ */
182
410
  icon: string;
411
+ /**
412
+ * Whether the agent can be used to start new runs.
413
+ */
183
414
  is_active: boolean;
415
+ /**
416
+ * JSON schema describing the structured output the agent should produce.
417
+ */
184
418
  output_schema: {
185
419
  [key: string]: unknown;
186
420
  } | null;
187
421
  /**
188
- * Response variant of AgentSources — preserves per-row id on allow rows.
422
+ * Source guidance for the agent.
423
+ */
424
+ sources: Item.Sources;
425
+ /**
426
+ * Suggested prompts users can run with this agent.
427
+ */
428
+ suggested_questions: Array<Item.SuggestedQuestion>;
429
+ /**
430
+ * When the agent was last updated.
189
431
  */
190
- sources: TaskAgentListResponseItem.Sources;
191
- suggested_questions: Array<TaskAgentListResponseItem.SuggestedQuestion>;
192
432
  updated_at: string;
433
+ /**
434
+ * Primary use case supported by the agent.
435
+ */
193
436
  use_case: 'research' | 'enrichment' | 'dataset_building';
194
- account_id?: string | null;
437
+ /**
438
+ * Stable agent name.
439
+ */
195
440
  agent_name?: string | null;
196
- workspace_id?: string | null;
197
441
  }
198
- namespace TaskAgentListResponseItem {
442
+ namespace Item {
199
443
  interface Goal {
444
+ /**
445
+ * Unique goal identifier (wsag\_<uuid>).
446
+ */
200
447
  id: string;
448
+ /**
449
+ * Goal text.
450
+ */
201
451
  goal: string;
452
+ /**
453
+ * Zero-based goal position.
454
+ */
202
455
  order: number;
203
456
  }
204
457
  /**
205
- * Response variant of AgentSources — preserves per-row id on allow rows.
458
+ * Source guidance for the agent.
206
459
  */
207
460
  interface Sources {
461
+ /**
462
+ * Source groups the agent is allowed to use.
463
+ */
208
464
  allow?: Array<Sources.Allow>;
465
+ /**
466
+ * Free-text guidance describing sources or domains to avoid.
467
+ */
209
468
  avoid?: string | null;
469
+ /**
470
+ * Source groups the agent should not use.
471
+ */
210
472
  block?: Array<Sources.Block>;
473
+ /**
474
+ * Free-text guidance describing sources or domains to prioritize.
475
+ */
211
476
  prioritize?: string | null;
212
477
  }
213
478
  namespace Sources {
214
479
  interface Allow {
480
+ /**
481
+ * Unique source group identifier (wsas\_<uuid>).
482
+ */
215
483
  id: string;
484
+ /**
485
+ * Domains included in this source group.
486
+ */
216
487
  domains: Array<string>;
488
+ /**
489
+ * Zero-based source group position.
490
+ */
217
491
  order: number;
492
+ /**
493
+ * Source group title.
494
+ */
218
495
  title: string;
219
496
  }
220
- /**
221
- * Lenient response shape — domains are plain strings (no re-validation).
222
- */
223
497
  interface Block {
498
+ /**
499
+ * Unique source group identifier (wsas\_<uuid>).
500
+ */
501
+ id: string;
502
+ /**
503
+ * Domains included in this source group.
504
+ */
224
505
  domains: Array<string>;
506
+ /**
507
+ * Zero-based source group position.
508
+ */
225
509
  order: number;
510
+ /**
511
+ * Source group title.
512
+ */
226
513
  title: string;
227
514
  }
228
515
  }
229
516
  interface SuggestedQuestion {
517
+ /**
518
+ * Unique suggested question identifier (wsasq\_<uuid>).
519
+ */
230
520
  id: string;
521
+ /**
522
+ * Zero-based suggested question position.
523
+ */
231
524
  order: number;
525
+ /**
526
+ * Suggested prompt text.
527
+ */
232
528
  question: string;
233
529
  }
234
530
  }
235
531
  }
236
532
  export interface TaskAgentGetResponse {
533
+ /**
534
+ * Unique web search agent identifier (wsa\_<uuid>).
535
+ */
237
536
  id: string;
537
+ /**
538
+ * When the agent was created.
539
+ */
238
540
  created_at: string;
541
+ /**
542
+ * Agent description shown to users.
543
+ */
239
544
  description: string;
545
+ /**
546
+ * Human-friendly agent name shown to users.
547
+ */
240
548
  display_name: string;
549
+ /**
550
+ * Domain expertise or operating context for the agent.
551
+ */
241
552
  domain_expertise: string;
242
553
  /**
243
- * Canonical effort tier names for the research graph.
554
+ * Default effort level for this agent's runs.
244
555
  */
245
556
  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
557
+ /**
558
+ * Ordered goals for the agent to follow.
559
+ */
246
560
  goals: Array<TaskAgentGetResponse.Goal>;
561
+ /**
562
+ * Icon identifier used when presenting the agent.
563
+ */
247
564
  icon: string;
565
+ /**
566
+ * Whether the agent can be used to start new runs.
567
+ */
248
568
  is_active: boolean;
569
+ /**
570
+ * JSON schema describing the structured output the agent should produce.
571
+ */
249
572
  output_schema: {
250
573
  [key: string]: unknown;
251
574
  } | null;
252
575
  /**
253
- * Response variant of AgentSources — preserves per-row id on allow rows.
576
+ * Source guidance for the agent.
254
577
  */
255
578
  sources: TaskAgentGetResponse.Sources;
579
+ /**
580
+ * Suggested prompts users can run with this agent.
581
+ */
256
582
  suggested_questions: Array<TaskAgentGetResponse.SuggestedQuestion>;
583
+ /**
584
+ * When the agent was last updated.
585
+ */
257
586
  updated_at: string;
587
+ /**
588
+ * Primary use case supported by the agent.
589
+ */
258
590
  use_case: 'research' | 'enrichment' | 'dataset_building';
259
- account_id?: string | null;
591
+ /**
592
+ * Stable agent name.
593
+ */
260
594
  agent_name?: string | null;
261
- workspace_id?: string | null;
262
595
  }
263
596
  export declare namespace TaskAgentGetResponse {
264
597
  interface Goal {
598
+ /**
599
+ * Unique goal identifier (wsag\_<uuid>).
600
+ */
265
601
  id: string;
602
+ /**
603
+ * Goal text.
604
+ */
266
605
  goal: string;
606
+ /**
607
+ * Zero-based goal position.
608
+ */
267
609
  order: number;
268
610
  }
269
611
  /**
270
- * Response variant of AgentSources — preserves per-row id on allow rows.
612
+ * Source guidance for the agent.
271
613
  */
272
614
  interface Sources {
615
+ /**
616
+ * Source groups the agent is allowed to use.
617
+ */
273
618
  allow?: Array<Sources.Allow>;
619
+ /**
620
+ * Free-text guidance describing sources or domains to avoid.
621
+ */
274
622
  avoid?: string | null;
623
+ /**
624
+ * Source groups the agent should not use.
625
+ */
275
626
  block?: Array<Sources.Block>;
627
+ /**
628
+ * Free-text guidance describing sources or domains to prioritize.
629
+ */
276
630
  prioritize?: string | null;
277
631
  }
278
632
  namespace Sources {
279
633
  interface Allow {
634
+ /**
635
+ * Unique source group identifier (wsas\_<uuid>).
636
+ */
280
637
  id: string;
638
+ /**
639
+ * Domains included in this source group.
640
+ */
281
641
  domains: Array<string>;
642
+ /**
643
+ * Zero-based source group position.
644
+ */
282
645
  order: number;
646
+ /**
647
+ * Source group title.
648
+ */
283
649
  title: string;
284
650
  }
285
- /**
286
- * Lenient response shape — domains are plain strings (no re-validation).
287
- */
288
651
  interface Block {
652
+ /**
653
+ * Unique source group identifier (wsas\_<uuid>).
654
+ */
655
+ id: string;
656
+ /**
657
+ * Domains included in this source group.
658
+ */
289
659
  domains: Array<string>;
660
+ /**
661
+ * Zero-based source group position.
662
+ */
290
663
  order: number;
664
+ /**
665
+ * Source group title.
666
+ */
291
667
  title: string;
292
668
  }
293
669
  }
294
670
  interface SuggestedQuestion {
671
+ /**
672
+ * Unique suggested question identifier (wsasq\_<uuid>).
673
+ */
295
674
  id: string;
675
+ /**
676
+ * Zero-based suggested question position.
677
+ */
296
678
  order: number;
679
+ /**
680
+ * Suggested prompt text.
681
+ */
297
682
  question: string;
298
683
  }
299
684
  }
300
- /**
301
- * Task run status returned by list/create/get endpoints.
302
- */
303
685
  export interface TaskAgentRunResponse {
304
686
  /**
305
687
  * Run identifier, format "task*run*{uuid}".
306
688
  */
307
689
  id: string;
690
+ /**
691
+ * When the run was created.
692
+ */
308
693
  created_at: string;
309
694
  /**
310
- * Canonical effort tier names for the research graph.
695
+ * Effort level used for the run.
311
696
  */
312
697
  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
313
698
  /**
314
- * Interaction ID — pass as previous_interaction_id to reuse context.
699
+ * Interaction ID.
315
700
  */
316
701
  interaction_id: string;
317
702
  /**
@@ -319,31 +704,33 @@ export interface TaskAgentRunResponse {
319
704
  */
320
705
  is_active: boolean;
321
706
  /**
322
- * Lowercase status values used in API responses (distinct from the DB-level
323
- * TaskRunStatus enum).
707
+ * Current run status.
324
708
  */
325
709
  status: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
326
710
  /**
327
- * Web Search Agent instance this run belongs to. Every task run is agent-bound
328
- * (see AGENTS-1666). Use this to build the nested URL
329
- * /api/v2/web-search-agents/{web_search_agent_id}/runs/{id}.
711
+ * Web Search Agent instance this run belongs to.
330
712
  */
331
713
  web_search_agent_id: string;
714
+ /**
715
+ * When the run completed.
716
+ */
332
717
  completed_at?: string | null;
333
718
  /**
334
- * Error detail for a failed run.
719
+ * Error details when the run failed.
335
720
  */
336
721
  error?: TaskAgentRunResponse.Error | null;
337
722
  /**
338
- * Original user prompt before enrichment. Populated for Web Search Agent runs.
723
+ * Prompt submitted for the run.
339
724
  */
340
725
  prompt?: string | null;
726
+ /**
727
+ * When the run started executing.
728
+ */
341
729
  started_at?: string | null;
342
- workspace_id?: string | null;
343
730
  }
344
731
  export declare namespace TaskAgentRunResponse {
345
732
  /**
346
- * Error detail for a failed run.
733
+ * Error details when the run failed.
347
734
  */
348
735
  interface Error {
349
736
  /**
@@ -357,52 +744,111 @@ export declare namespace TaskAgentRunResponse {
357
744
  }
358
745
  }
359
746
  export interface TaskAgentCreateParams {
747
+ /**
748
+ * Stable agent name.
749
+ */
360
750
  agent_name?: string | null;
751
+ /**
752
+ * Agent description shown to users.
753
+ */
361
754
  description?: string | null;
755
+ /**
756
+ * Human-friendly agent name shown to users.
757
+ */
362
758
  display_name?: string | null;
759
+ /**
760
+ * Domain expertise or operating context for the agent.
761
+ */
363
762
  domain_expertise?: string | null;
364
763
  /**
365
- * Canonical effort tier names for the research graph.
764
+ * Default effort level for this agent's runs.
366
765
  */
367
766
  effort?: 'low' | 'medium' | 'high' | 'x-high' | 'max';
767
+ /**
768
+ * Ordered goals for the agent to follow.
769
+ */
368
770
  goals?: Array<string>;
771
+ /**
772
+ * Icon identifier used when presenting the agent.
773
+ */
369
774
  icon?: string | null;
775
+ /**
776
+ * Whether the agent can be used to start new runs.
777
+ */
370
778
  is_active?: boolean;
779
+ /**
780
+ * JSON schema describing the structured output the agent should produce.
781
+ */
371
782
  output_schema?: {
372
783
  [key: string]: unknown;
373
784
  } | null;
374
785
  /**
375
- * Source preferences for a web search agent instance.
786
+ * Source guidance for the agent.
376
787
  */
377
788
  sources?: TaskAgentCreateParams.Sources;
789
+ /**
790
+ * Suggested prompts users can run with this agent.
791
+ */
378
792
  suggested_questions?: Array<string>;
379
793
  /**
380
794
  * Template name to materialize this instance from. When set, the scalar fields and
381
795
  * child rows are copied from the template.
382
796
  */
383
797
  template?: string | null;
798
+ /**
799
+ * Primary use case supported by the agent.
800
+ */
384
801
  use_case?: 'research' | 'enrichment' | 'dataset_building' | null;
385
- workspace_id?: string | null;
386
802
  }
387
803
  export declare namespace TaskAgentCreateParams {
388
804
  /**
389
- * Source preferences for a web search agent instance.
805
+ * Source guidance for the agent.
390
806
  */
391
807
  interface Sources {
808
+ /**
809
+ * Source groups the agent is allowed to use.
810
+ */
392
811
  allow?: Array<Sources.Allow>;
812
+ /**
813
+ * Free-text guidance describing sources or domains to avoid.
814
+ */
393
815
  avoid?: string | null;
816
+ /**
817
+ * Source groups the agent should not use.
818
+ */
394
819
  block?: Array<Sources.Block>;
820
+ /**
821
+ * Free-text guidance describing sources or domains to prioritize.
822
+ */
395
823
  prioritize?: string | null;
396
824
  }
397
825
  namespace Sources {
398
826
  interface Allow {
827
+ /**
828
+ * Domains included in this source group.
829
+ */
399
830
  domains: Array<string>;
831
+ /**
832
+ * Source group title.
833
+ */
400
834
  title: string;
835
+ /**
836
+ * Zero-based source group position.
837
+ */
401
838
  order?: number;
402
839
  }
403
840
  interface Block {
841
+ /**
842
+ * Domains included in this source group.
843
+ */
404
844
  domains: Array<string>;
845
+ /**
846
+ * Source group title.
847
+ */
405
848
  title: string;
849
+ /**
850
+ * Zero-based source group position.
851
+ */
406
852
  order?: number;
407
853
  }
408
854
  }
@@ -425,50 +871,96 @@ export declare namespace TaskAgentUpdateParams {
425
871
  }
426
872
  }
427
873
  export interface TaskAgentListParams {
428
- /**
429
- * Canonical effort tier names for the research graph.
430
- */
431
- filter_effort?: 'low' | 'medium' | 'high' | 'x-high' | 'max' | null;
432
- filter_use_case?: 'research' | 'enrichment' | 'dataset_building' | null;
433
874
  limit?: number;
434
875
  offset?: number;
435
876
  workspace_id?: string | null;
436
877
  }
437
878
  export interface TaskAgentRunParams {
879
+ /**
880
+ * User prompt or task instructions for the run.
881
+ */
438
882
  input: string;
439
883
  /**
440
884
  * Canonical effort tier names for the research graph.
441
885
  */
442
886
  effort?: 'low' | 'medium' | 'high' | 'x-high' | 'max' | null;
887
+ /**
888
+ * Whether to stream run events when supported.
889
+ */
443
890
  enable_events?: boolean;
891
+ /**
892
+ * Existing records to ENRICH: a list of partial rows, or a single object,
893
+ * mirroring output_schema's shape.
894
+ */
895
+ input_data?: Array<{
896
+ [key: string]: unknown;
897
+ }> | {
898
+ [key: string]: unknown;
899
+ } | null;
900
+ /**
901
+ * JSON schema overriding the agent's default structured output for this run.
902
+ */
444
903
  output_schema?: {
445
904
  [key: string]: unknown;
446
905
  } | null;
906
+ /**
907
+ * Previous interaction identifier used to continue a conversation.
908
+ */
447
909
  previous_interaction_id?: string | null;
448
910
  /**
449
- * Source preferences for a web search agent instance.
911
+ * Source guidance overriding the agent default.
450
912
  */
451
913
  sources?: TaskAgentRunParams.Sources | null;
452
914
  }
453
915
  export declare namespace TaskAgentRunParams {
454
916
  /**
455
- * Source preferences for a web search agent instance.
917
+ * Source guidance overriding the agent default.
456
918
  */
457
919
  interface Sources {
920
+ /**
921
+ * Source groups the agent is allowed to use.
922
+ */
458
923
  allow?: Array<Sources.Allow>;
924
+ /**
925
+ * Free-text guidance describing sources or domains to avoid.
926
+ */
459
927
  avoid?: string | null;
928
+ /**
929
+ * Source groups the agent should not use.
930
+ */
460
931
  block?: Array<Sources.Block>;
932
+ /**
933
+ * Free-text guidance describing sources or domains to prioritize.
934
+ */
461
935
  prioritize?: string | null;
462
936
  }
463
937
  namespace Sources {
464
938
  interface Allow {
939
+ /**
940
+ * Domains included in this source group.
941
+ */
465
942
  domains: Array<string>;
943
+ /**
944
+ * Source group title.
945
+ */
466
946
  title: string;
947
+ /**
948
+ * Zero-based source group position.
949
+ */
467
950
  order?: number;
468
951
  }
469
952
  interface Block {
953
+ /**
954
+ * Domains included in this source group.
955
+ */
470
956
  domains: Array<string>;
957
+ /**
958
+ * Source group title.
959
+ */
471
960
  title: string;
961
+ /**
962
+ * Zero-based source group position.
963
+ */
472
964
  order?: number;
473
965
  }
474
966
  }
@@ -476,6 +968,6 @@ export declare namespace TaskAgentRunParams {
476
968
  export declare namespace TaskAgent {
477
969
  export { type TaskAgentCreateResponse as TaskAgentCreateResponse, type TaskAgentUpdateResponse as TaskAgentUpdateResponse, type TaskAgentListResponse as TaskAgentListResponse, type TaskAgentGetResponse as TaskAgentGetResponse, type TaskAgentRunResponse as TaskAgentRunResponse, type TaskAgentCreateParams as TaskAgentCreateParams, type TaskAgentUpdateParams as TaskAgentUpdateParams, type TaskAgentListParams as TaskAgentListParams, type TaskAgentRunParams as TaskAgentRunParams, };
478
970
  export { Templates as Templates, type TemplateListResponse as TemplateListResponse, type TemplateGetResponse as TemplateGetResponse, type TemplateListParams as TemplateListParams, };
479
- export { Runs as Runs, type RunListResponse as RunListResponse, type RunGetResponse as RunGetResponse, type RunGetResultResponse as RunGetResultResponse, type RunStreamEventsResponse as RunStreamEventsResponse, type RunListParams as RunListParams, type RunCancelParams as RunCancelParams, type RunGetParams as RunGetParams, type RunGetResultParams as RunGetResultParams, type RunStreamEventsParams as RunStreamEventsParams, };
971
+ export { Runs as Runs, type RunListResponse as RunListResponse, type RunGetResponse as RunGetResponse, type RunGetResultResponse as RunGetResultResponse, type RunListParams as RunListParams, type RunGetParams as RunGetParams, type RunGetResultParams as RunGetResultParams, type RunStreamEventsParams as RunStreamEventsParams, };
480
972
  }
481
973
  //# sourceMappingURL=task-agent.d.mts.map