parallel-web 0.4.1 → 1.0.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 (241) hide show
  1. package/CHANGELOG.md +54 -0
  2. package/api-promise.d.mts +1 -0
  3. package/api-promise.d.mts.map +1 -1
  4. package/api-promise.d.ts +1 -0
  5. package/api-promise.d.ts.map +1 -1
  6. package/api-promise.mjs +1 -0
  7. package/api-promise.mjs.map +1 -1
  8. package/client.d.mts +29 -8
  9. package/client.d.mts.map +1 -1
  10. package/client.d.ts +29 -8
  11. package/client.d.ts.map +1 -1
  12. package/client.js +34 -4
  13. package/client.js.map +1 -1
  14. package/client.mjs +34 -4
  15. package/client.mjs.map +1 -1
  16. package/core/api-promise.d.mts.map +1 -1
  17. package/core/api-promise.d.ts.map +1 -1
  18. package/core/api-promise.mjs.map +1 -1
  19. package/core/error.mjs.map +1 -1
  20. package/core/resource.d.mts.map +1 -1
  21. package/core/resource.d.ts.map +1 -1
  22. package/core/streaming.d.mts.map +1 -1
  23. package/core/streaming.d.ts.map +1 -1
  24. package/core/streaming.mjs.map +1 -1
  25. package/core/uploads.d.mts.map +1 -1
  26. package/core/uploads.d.ts.map +1 -1
  27. package/core/uploads.mjs.map +1 -1
  28. package/error.d.mts +1 -0
  29. package/error.d.mts.map +1 -1
  30. package/error.d.ts +1 -0
  31. package/error.d.ts.map +1 -1
  32. package/error.mjs +1 -0
  33. package/error.mjs.map +1 -1
  34. package/index.d.mts.map +1 -1
  35. package/index.d.ts.map +1 -1
  36. package/index.mjs.map +1 -1
  37. package/internal/decoders/line.mjs.map +1 -1
  38. package/internal/detect-platform.mjs.map +1 -1
  39. package/internal/headers.mjs.map +1 -1
  40. package/internal/parse.d.mts.map +1 -1
  41. package/internal/parse.d.ts.map +1 -1
  42. package/internal/parse.mjs.map +1 -1
  43. package/internal/qs/formats.d.mts +7 -0
  44. package/internal/qs/formats.d.mts.map +1 -0
  45. package/internal/qs/formats.d.ts +7 -0
  46. package/internal/qs/formats.d.ts.map +1 -0
  47. package/internal/qs/formats.js +13 -0
  48. package/internal/qs/formats.js.map +1 -0
  49. package/internal/qs/formats.mjs +9 -0
  50. package/internal/qs/formats.mjs.map +1 -0
  51. package/internal/qs/index.d.mts +10 -0
  52. package/internal/qs/index.d.mts.map +1 -0
  53. package/internal/qs/index.d.ts +10 -0
  54. package/internal/qs/index.d.ts.map +1 -0
  55. package/internal/qs/index.js +14 -0
  56. package/internal/qs/index.js.map +1 -0
  57. package/internal/qs/index.mjs +10 -0
  58. package/internal/qs/index.mjs.map +1 -0
  59. package/internal/qs/stringify.d.mts +3 -0
  60. package/internal/qs/stringify.d.mts.map +1 -0
  61. package/internal/qs/stringify.d.ts +3 -0
  62. package/internal/qs/stringify.d.ts.map +1 -0
  63. package/internal/qs/stringify.js +277 -0
  64. package/internal/qs/stringify.js.map +1 -0
  65. package/internal/qs/stringify.mjs +274 -0
  66. package/internal/qs/stringify.mjs.map +1 -0
  67. package/internal/qs/types.d.mts +57 -0
  68. package/internal/qs/types.d.mts.map +1 -0
  69. package/internal/qs/types.d.ts +57 -0
  70. package/internal/qs/types.d.ts.map +1 -0
  71. package/internal/qs/types.js +3 -0
  72. package/internal/qs/types.js.map +1 -0
  73. package/internal/qs/types.mjs +2 -0
  74. package/internal/qs/types.mjs.map +1 -0
  75. package/internal/qs/utils.d.mts +15 -0
  76. package/internal/qs/utils.d.mts.map +1 -0
  77. package/internal/qs/utils.d.ts +15 -0
  78. package/internal/qs/utils.d.ts.map +1 -0
  79. package/internal/qs/utils.js +230 -0
  80. package/internal/qs/utils.js.map +1 -0
  81. package/internal/qs/utils.mjs +217 -0
  82. package/internal/qs/utils.mjs.map +1 -0
  83. package/internal/request-options.d.mts.map +1 -1
  84. package/internal/request-options.d.ts.map +1 -1
  85. package/internal/shims.d.mts +6 -0
  86. package/internal/shims.d.mts.map +1 -1
  87. package/internal/shims.d.ts +6 -0
  88. package/internal/shims.d.ts.map +1 -1
  89. package/internal/to-file.d.mts.map +1 -1
  90. package/internal/to-file.d.ts.map +1 -1
  91. package/internal/to-file.mjs.map +1 -1
  92. package/internal/types.d.mts +10 -10
  93. package/internal/types.d.mts.map +1 -1
  94. package/internal/types.d.ts +10 -10
  95. package/internal/types.d.ts.map +1 -1
  96. package/internal/uploads.d.mts.map +1 -1
  97. package/internal/uploads.d.ts.map +1 -1
  98. package/internal/uploads.mjs.map +1 -1
  99. package/internal/utils/base64.mjs.map +1 -1
  100. package/internal/utils/log.d.mts.map +1 -1
  101. package/internal/utils/log.d.ts.map +1 -1
  102. package/internal/utils/log.js +3 -2
  103. package/internal/utils/log.js.map +1 -1
  104. package/internal/utils/log.mjs +3 -2
  105. package/internal/utils/log.mjs.map +1 -1
  106. package/internal/utils/path.mjs.map +1 -1
  107. package/internal/utils/query.d.mts +0 -3
  108. package/internal/utils/query.d.mts.map +1 -1
  109. package/internal/utils/query.d.ts +0 -3
  110. package/internal/utils/query.d.ts.map +1 -1
  111. package/internal/utils/query.js +3 -16
  112. package/internal/utils/query.js.map +1 -1
  113. package/internal/utils/query.mjs +2 -16
  114. package/internal/utils/query.mjs.map +1 -1
  115. package/internal/utils/values.mjs.map +1 -1
  116. package/internal/utils.d.mts.map +1 -1
  117. package/internal/utils.d.ts.map +1 -1
  118. package/internal/utils.mjs.map +1 -1
  119. package/package.json +1 -1
  120. package/resource.d.mts +1 -0
  121. package/resource.d.mts.map +1 -1
  122. package/resource.d.ts +1 -0
  123. package/resource.d.ts.map +1 -1
  124. package/resource.mjs +1 -0
  125. package/resource.mjs.map +1 -1
  126. package/resources/beta/beta.d.mts +2 -270
  127. package/resources/beta/beta.d.mts.map +1 -1
  128. package/resources/beta/beta.d.ts +2 -270
  129. package/resources/beta/beta.d.ts.map +1 -1
  130. package/resources/beta/beta.js +0 -39
  131. package/resources/beta/beta.js.map +1 -1
  132. package/resources/beta/beta.mjs +0 -39
  133. package/resources/beta/beta.mjs.map +1 -1
  134. package/resources/beta/findall.d.mts +202 -247
  135. package/resources/beta/findall.d.mts.map +1 -1
  136. package/resources/beta/findall.d.ts +202 -247
  137. package/resources/beta/findall.d.ts.map +1 -1
  138. package/resources/beta/findall.js +28 -27
  139. package/resources/beta/findall.js.map +1 -1
  140. package/resources/beta/findall.mjs +28 -27
  141. package/resources/beta/findall.mjs.map +1 -1
  142. package/resources/beta/index.d.mts +1 -3
  143. package/resources/beta/index.d.mts.map +1 -1
  144. package/resources/beta/index.d.ts +1 -3
  145. package/resources/beta/index.d.ts.map +1 -1
  146. package/resources/beta/index.js +1 -5
  147. package/resources/beta/index.js.map +1 -1
  148. package/resources/beta/index.mjs +0 -2
  149. package/resources/beta/index.mjs.map +1 -1
  150. package/resources/beta.d.mts.map +1 -1
  151. package/resources/beta.d.ts.map +1 -1
  152. package/resources/beta.mjs.map +1 -1
  153. package/resources/index.d.mts +4 -2
  154. package/resources/index.d.mts.map +1 -1
  155. package/resources/index.d.ts +4 -2
  156. package/resources/index.d.ts.map +1 -1
  157. package/resources/index.js +5 -1
  158. package/resources/index.js.map +1 -1
  159. package/resources/index.mjs +2 -0
  160. package/resources/index.mjs.map +1 -1
  161. package/resources/monitor.d.mts +625 -0
  162. package/resources/monitor.d.mts.map +1 -0
  163. package/resources/monitor.d.ts +625 -0
  164. package/resources/monitor.d.ts.map +1 -0
  165. package/resources/monitor.js +140 -0
  166. package/resources/monitor.js.map +1 -0
  167. package/resources/monitor.mjs +136 -0
  168. package/resources/monitor.mjs.map +1 -0
  169. package/resources/{beta/task-group.d.mts → task-group.d.mts} +38 -68
  170. package/resources/task-group.d.mts.map +1 -0
  171. package/resources/{beta/task-group.d.ts → task-group.d.ts} +38 -68
  172. package/resources/task-group.d.ts.map +1 -0
  173. package/resources/{beta/task-group.js → task-group.js} +24 -64
  174. package/resources/task-group.js.map +1 -0
  175. package/resources/{beta/task-group.mjs → task-group.mjs} +24 -64
  176. package/resources/task-group.mjs.map +1 -0
  177. package/resources/task-run.d.mts +100 -83
  178. package/resources/task-run.d.mts.map +1 -1
  179. package/resources/task-run.d.ts +100 -83
  180. package/resources/task-run.d.ts.map +1 -1
  181. package/resources/task-run.js +14 -1
  182. package/resources/task-run.js.map +1 -1
  183. package/resources/task-run.mjs +14 -1
  184. package/resources/task-run.mjs.map +1 -1
  185. package/resources/top-level.d.mts +20 -16
  186. package/resources/top-level.d.mts.map +1 -1
  187. package/resources/top-level.d.ts +20 -16
  188. package/resources/top-level.d.ts.map +1 -1
  189. package/resources.d.mts.map +1 -1
  190. package/resources.d.ts.map +1 -1
  191. package/resources.mjs.map +1 -1
  192. package/src/client.ts +120 -4
  193. package/src/internal/qs/LICENSE.md +13 -0
  194. package/src/internal/qs/README.md +3 -0
  195. package/src/internal/qs/formats.ts +10 -0
  196. package/src/internal/qs/index.ts +13 -0
  197. package/src/internal/qs/stringify.ts +385 -0
  198. package/src/internal/qs/types.ts +71 -0
  199. package/src/internal/qs/utils.ts +265 -0
  200. package/src/internal/types.ts +6 -8
  201. package/src/internal/utils/log.ts +2 -1
  202. package/src/internal/utils/query.ts +2 -18
  203. package/src/resources/beta/api.md +9 -59
  204. package/src/resources/beta/beta.ts +16 -406
  205. package/src/resources/beta/findall.ts +252 -284
  206. package/src/resources/beta/index.ts +8 -30
  207. package/src/resources/index.ts +42 -0
  208. package/src/resources/monitor.ts +752 -0
  209. package/src/resources/{beta/task-group.ts → task-group.ts} +58 -93
  210. package/src/resources/task-run.ts +125 -98
  211. package/src/resources/top-level.ts +24 -16
  212. package/src/version.ts +1 -1
  213. package/streaming.d.mts +1 -0
  214. package/streaming.d.mts.map +1 -1
  215. package/streaming.d.ts +1 -0
  216. package/streaming.d.ts.map +1 -1
  217. package/streaming.mjs +1 -0
  218. package/streaming.mjs.map +1 -1
  219. package/uploads.d.mts +1 -0
  220. package/uploads.d.mts.map +1 -1
  221. package/uploads.d.ts +1 -0
  222. package/uploads.d.ts.map +1 -1
  223. package/uploads.mjs +1 -0
  224. package/uploads.mjs.map +1 -1
  225. package/version.d.mts +1 -1
  226. package/version.d.ts +1 -1
  227. package/version.js +1 -1
  228. package/version.mjs +1 -1
  229. package/resources/beta/task-group.d.mts.map +0 -1
  230. package/resources/beta/task-group.d.ts.map +0 -1
  231. package/resources/beta/task-group.js.map +0 -1
  232. package/resources/beta/task-group.mjs.map +0 -1
  233. package/resources/beta/task-run.d.mts +0 -239
  234. package/resources/beta/task-run.d.mts.map +0 -1
  235. package/resources/beta/task-run.d.ts +0 -239
  236. package/resources/beta/task-run.d.ts.map +0 -1
  237. package/resources/beta/task-run.js +0 -81
  238. package/resources/beta/task-run.js.map +0 -1
  239. package/resources/beta/task-run.mjs +0 -77
  240. package/resources/beta/task-run.mjs.map +0 -1
  241. package/src/resources/beta/task-run.ts +0 -336
@@ -1,21 +1,20 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
- import { APIResource } from '../../core/resource';
4
- import * as TaskGroupAPI from './task-group';
5
- import * as TaskRunAPI from '../task-run';
6
- import * as BetaTaskRunAPI from './task-run';
7
- import { APIPromise } from '../../core/api-promise';
8
- import { Stream } from '../../core/streaming';
9
- import { buildHeaders } from '../../internal/headers';
10
- import { RequestOptions } from '../../internal/request-options';
11
- import { path } from '../../internal/utils/path';
3
+ import { APIResource } from '../core/resource';
4
+ import * as TaskRunAPI from './task-run';
5
+ import * as FindAllAPI from './beta/findall';
6
+ import { APIPromise } from '../core/api-promise';
7
+ import { Stream } from '../core/streaming';
8
+ import { buildHeaders } from '../internal/headers';
9
+ import { RequestOptions } from '../internal/request-options';
10
+ import { path } from '../internal/utils/path';
12
11
 
13
12
  /**
14
13
  * The Task API executes web research and extraction tasks. Clients submit a natural-language objective with an optional input schema; the service plans retrieval, fetches relevant URLs, and returns outputs that conform to a provided or inferred JSON schema. Supports deep research style queries and can return rich structured JSON outputs. Processors trade-off between cost, latency, and quality. Each processor supports calibrated confidences.
15
14
  * - Output metadata: citations, excerpts, reasoning, and confidence per field
16
15
  *
17
16
  * Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
18
- * - Submit hundreds or thousands of Tasks as a single group
17
+ * - Submit hundreds or thousands of Tasks as a single group
19
18
  * - Observe group progress and receive results as they complete
20
19
  * - Real-time updates via Server-Sent Events (SSE)
21
20
  * - Add tasks to an existing group while it is running
@@ -24,52 +23,20 @@ import { path } from '../../internal/utils/path';
24
23
  export class TaskGroup extends APIResource {
25
24
  /**
26
25
  * Initiates a TaskGroup to group and track multiple runs.
27
- *
28
- * @example
29
- * ```ts
30
- * const taskGroup = await client.beta.taskGroup.create();
31
- * ```
32
26
  */
33
27
  create(body: TaskGroupCreateParams, options?: RequestOptions): APIPromise<TaskGroup> {
34
- return this._client.post('/v1beta/tasks/groups', {
35
- body,
36
- ...options,
37
- headers: buildHeaders([{ 'parallel-beta': 'search-extract-2025-10-10' }, options?.headers]),
38
- });
28
+ return this._client.post('/v1/tasks/groups', { body, ...options });
39
29
  }
40
30
 
41
31
  /**
42
32
  * Retrieves aggregated status across runs in a TaskGroup.
43
- *
44
- * @example
45
- * ```ts
46
- * const taskGroup = await client.beta.taskGroup.retrieve(
47
- * 'taskgroup_id',
48
- * );
49
- * ```
50
33
  */
51
34
  retrieve(taskGroupID: string, options?: RequestOptions): APIPromise<TaskGroup> {
52
- return this._client.get(path`/v1beta/tasks/groups/${taskGroupID}`, {
53
- ...options,
54
- headers: buildHeaders([{ 'parallel-beta': 'search-extract-2025-10-10' }, options?.headers]),
55
- });
35
+ return this._client.get(path`/v1/tasks/groups/${taskGroupID}`, options);
56
36
  }
57
37
 
58
38
  /**
59
39
  * Initiates multiple task runs within a TaskGroup.
60
- *
61
- * @example
62
- * ```ts
63
- * const taskGroupRunResponse =
64
- * await client.beta.taskGroup.addRuns('taskgroup_id', {
65
- * inputs: [
66
- * {
67
- * input: 'What was the GDP of France in 2023?',
68
- * processor: 'base',
69
- * },
70
- * ],
71
- * });
72
- * ```
73
40
  */
74
41
  addRuns(
75
42
  taskGroupID: string,
@@ -77,12 +44,12 @@ export class TaskGroup extends APIResource {
77
44
  options?: RequestOptions,
78
45
  ): APIPromise<TaskGroupRunResponse> {
79
46
  const { refresh_status, betas, ...body } = params;
80
- return this._client.post(path`/v1beta/tasks/groups/${taskGroupID}/runs`, {
47
+ return this._client.post(path`/v1/tasks/groups/${taskGroupID}/runs`, {
81
48
  query: { refresh_status },
82
49
  body,
83
50
  ...options,
84
51
  headers: buildHeaders([
85
- { 'parallel-beta': [...(betas ?? []), 'search-extract-2025-10-10'].toString() },
52
+ { ...(betas?.toString() != null ? { 'parallel-beta': betas?.toString() } : undefined) },
86
53
  options?.headers,
87
54
  ]),
88
55
  });
@@ -93,26 +60,16 @@ export class TaskGroup extends APIResource {
93
60
  *
94
61
  * The connection will remain open for up to an hour as long as at least one run in
95
62
  * the group is still active.
96
- *
97
- * @example
98
- * ```ts
99
- * const response = await client.beta.taskGroup.events(
100
- * 'taskgroup_id',
101
- * );
102
- * ```
103
63
  */
104
64
  events(
105
65
  taskGroupID: string,
106
66
  query: TaskGroupEventsParams | undefined = {},
107
67
  options?: RequestOptions,
108
68
  ): APIPromise<Stream<TaskGroupEventsResponse>> {
109
- return this._client.get(path`/v1beta/tasks/groups/${taskGroupID}/events`, {
69
+ return this._client.get(path`/v1/tasks/groups/${taskGroupID}/events`, {
110
70
  query,
111
71
  ...options,
112
- headers: buildHeaders([
113
- { 'parallel-beta': 'search-extract-2025-10-10', Accept: 'text/event-stream' },
114
- options?.headers,
115
- ]),
72
+ headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
116
73
  stream: true,
117
74
  }) as APIPromise<Stream<TaskGroupEventsResponse>>;
118
75
  }
@@ -128,29 +85,36 @@ export class TaskGroup extends APIResource {
128
85
  * specify the `last_event_id` parameter with the `event_id` of the last event in
129
86
  * the stream. The stream will resume from the next event after the
130
87
  * `last_event_id`.
131
- *
132
- * @example
133
- * ```ts
134
- * const response = await client.beta.taskGroup.getRuns(
135
- * 'taskgroup_id',
136
- * );
137
- * ```
138
88
  */
139
89
  getRuns(
140
90
  taskGroupID: string,
141
91
  query: TaskGroupGetRunsParams | undefined = {},
142
92
  options?: RequestOptions,
143
93
  ): APIPromise<Stream<TaskGroupGetRunsResponse>> {
144
- return this._client.get(path`/v1beta/tasks/groups/${taskGroupID}/runs`, {
94
+ return this._client.get(path`/v1/tasks/groups/${taskGroupID}/runs`, {
145
95
  query,
146
96
  ...options,
147
- headers: buildHeaders([
148
- { 'parallel-beta': 'search-extract-2025-10-10', Accept: 'text/event-stream' },
149
- options?.headers,
150
- ]),
97
+ headers: buildHeaders([{ Accept: 'text/event-stream' }, options?.headers]),
151
98
  stream: true,
152
99
  }) as APIPromise<Stream<TaskGroupGetRunsResponse>>;
153
100
  }
101
+
102
+ /**
103
+ * Retrieves run status by run_id.
104
+ *
105
+ * This endpoint is equivalent to fetching run status directly using the
106
+ * `retrieve()` method or the `tasks/runs` GET endpoint.
107
+ *
108
+ * The run result is available from the `/result` endpoint.
109
+ */
110
+ retrieveRun(
111
+ runID: string,
112
+ params: TaskGroupRetrieveRunParams,
113
+ options?: RequestOptions,
114
+ ): APIPromise<TaskRunAPI.TaskRun> {
115
+ const { taskgroup_id } = params;
116
+ return this._client.get(path`/v1/tasks/groups/${taskgroup_id}/runs/${runID}`, options);
117
+ }
154
118
  }
155
119
 
156
120
  /**
@@ -241,33 +205,28 @@ export interface TaskGroupStatus {
241
205
  /**
242
206
  * Event indicating an update to group status.
243
207
  */
244
- export type TaskGroupEventsResponse =
245
- | TaskGroupEventsResponse.TaskGroupStatusEvent
246
- | TaskRunAPI.TaskRunEvent
247
- | TaskRunAPI.ErrorEvent;
208
+ export interface TaskGroupStatusEvent {
209
+ /**
210
+ * Cursor to resume the event stream.
211
+ */
212
+ event_id: string;
248
213
 
249
- export namespace TaskGroupEventsResponse {
250
214
  /**
251
- * Event indicating an update to group status.
215
+ * Task group status object.
252
216
  */
253
- export interface TaskGroupStatusEvent {
254
- /**
255
- * Cursor to resume the event stream.
256
- */
257
- event_id: string;
258
-
259
- /**
260
- * Task group status object.
261
- */
262
- status: TaskGroupAPI.TaskGroupStatus;
263
-
264
- /**
265
- * Event type; always 'task_group_status'.
266
- */
267
- type: 'task_group_status';
268
- }
217
+ status: TaskGroupStatus;
218
+
219
+ /**
220
+ * Event type; always 'task_group_status'.
221
+ */
222
+ type: 'task_group_status';
269
223
  }
270
224
 
225
+ /**
226
+ * Event indicating an update to group status.
227
+ */
228
+ export type TaskGroupEventsResponse = TaskGroupStatusEvent | TaskRunAPI.TaskRunEvent | TaskRunAPI.ErrorEvent;
229
+
271
230
  /**
272
231
  * Event when a task run transitions to a non-active status.
273
232
  *
@@ -308,7 +267,7 @@ export interface TaskGroupAddRunsParams {
308
267
  /**
309
268
  * Header param: Optional header to specify the beta version(s) to enable.
310
269
  */
311
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
270
+ betas?: Array<FindAllAPI.ParallelBeta>;
312
271
  }
313
272
 
314
273
  export interface TaskGroupEventsParams {
@@ -335,16 +294,22 @@ export interface TaskGroupGetRunsParams {
335
294
  | null;
336
295
  }
337
296
 
297
+ export interface TaskGroupRetrieveRunParams {
298
+ taskgroup_id: string;
299
+ }
300
+
338
301
  export declare namespace TaskGroup {
339
302
  export {
340
303
  type TaskGroup as TaskGroup,
341
304
  type TaskGroupRunResponse as TaskGroupRunResponse,
342
305
  type TaskGroupStatus as TaskGroupStatus,
306
+ type TaskGroupStatusEvent as TaskGroupStatusEvent,
343
307
  type TaskGroupEventsResponse as TaskGroupEventsResponse,
344
308
  type TaskGroupGetRunsResponse as TaskGroupGetRunsResponse,
345
309
  type TaskGroupCreateParams as TaskGroupCreateParams,
346
310
  type TaskGroupAddRunsParams as TaskGroupAddRunsParams,
347
311
  type TaskGroupEventsParams as TaskGroupEventsParams,
348
312
  type TaskGroupGetRunsParams as TaskGroupGetRunsParams,
313
+ type TaskGroupRetrieveRunParams as TaskGroupRetrieveRunParams,
349
314
  };
350
315
  }
@@ -2,7 +2,7 @@
2
2
 
3
3
  import { APIResource } from '../core/resource';
4
4
  import * as Shared from './shared';
5
- import * as BetaTaskRunAPI from './beta/task-run';
5
+ import * as FindAllAPI from './beta/findall';
6
6
  import { APIPromise } from '../core/api-promise';
7
7
  import { Stream } from '../core/streaming';
8
8
  import { buildHeaders } from '../internal/headers';
@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
14
14
  * - Output metadata: citations, excerpts, reasoning, and confidence per field
15
15
  *
16
16
  * Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
17
- * - Submit hundreds or thousands of Tasks as a single group
17
+ * - Submit hundreds or thousands of Tasks as a single group
18
18
  * - Observe group progress and receive results as they complete
19
19
  * - Real-time updates via Server-Sent Events (SSE)
20
20
  * - Add tasks to an existing group while it is running
@@ -107,6 +107,20 @@ export class TaskRun extends APIResource {
107
107
  ]),
108
108
  });
109
109
  }
110
+
111
+ /**
112
+ * Retrieves the input of a run by run_id.
113
+ *
114
+ * @example
115
+ * ```ts
116
+ * const runInput = await client.taskRun.retrieveInput(
117
+ * 'run_id',
118
+ * );
119
+ * ```
120
+ */
121
+ retrieveInput(runID: string, options?: RequestOptions): APIPromise<RunInput> {
122
+ return this._client.get(path`/v1/tasks/runs/${runID}/input`, options);
123
+ }
110
124
  }
111
125
 
112
126
  /**
@@ -278,7 +292,7 @@ export interface RunInput {
278
292
  /**
279
293
  * Advanced search configuration for a task run.
280
294
  */
281
- advanced_settings?: RunInput.AdvancedSettings | null;
295
+ advanced_settings?: TaskAdvancedSettings | null;
282
296
 
283
297
  /**
284
298
  * Controls tracking of task run execution progress. When set to true, progress
@@ -329,16 +343,14 @@ export interface RunInput {
329
343
  webhook?: Webhook | null;
330
344
  }
331
345
 
332
- export namespace RunInput {
346
+ /**
347
+ * Advanced search configuration for a task run.
348
+ */
349
+ export interface TaskAdvancedSettings {
333
350
  /**
334
- * Advanced search configuration for a task run.
351
+ * ISO 3166-1 alpha-2 country code for geo-targeted search results.
335
352
  */
336
- export interface AdvancedSettings {
337
- /**
338
- * ISO 3166-1 alpha-2 country code for geo-targeted search results.
339
- */
340
- location?: string | null;
341
- }
353
+ location?: string | null;
342
354
  }
343
355
 
344
356
  /**
@@ -476,6 +488,52 @@ export interface TaskRunJsonOutput {
476
488
  output_schema?: { [key: string]: unknown } | null;
477
489
  }
478
490
 
491
+ /**
492
+ * A message for a task run progress update.
493
+ */
494
+ export interface TaskRunProgressMessageEvent {
495
+ /**
496
+ * Progress update message.
497
+ */
498
+ message: string;
499
+
500
+ /**
501
+ * Timestamp of the message.
502
+ */
503
+ timestamp: string | null;
504
+
505
+ /**
506
+ * Event type; always starts with 'task_run.progress_msg'.
507
+ */
508
+ type:
509
+ | 'task_run.progress_msg.plan'
510
+ | 'task_run.progress_msg.search'
511
+ | 'task_run.progress_msg.result'
512
+ | 'task_run.progress_msg.tool_call'
513
+ | 'task_run.progress_msg.exec_status';
514
+ }
515
+
516
+ /**
517
+ * A progress update for a task run.
518
+ */
519
+ export interface TaskRunProgressStatsEvent {
520
+ /**
521
+ * Completion percentage of the task run. Ranges from 0 to 100 where 0 indicates no
522
+ * progress and 100 indicates completion.
523
+ */
524
+ progress_meter: number;
525
+
526
+ /**
527
+ * Source stats describing progress so far.
528
+ */
529
+ source_stats: TaskRunSourceStats;
530
+
531
+ /**
532
+ * Event type; always 'task_run.progress_stats'.
533
+ */
534
+ type: 'task_run.progress_stats';
535
+ }
536
+
479
537
  /**
480
538
  * Result of a task run.
481
539
  */
@@ -491,6 +549,26 @@ export interface TaskRunResult {
491
549
  run: TaskRun;
492
550
  }
493
551
 
552
+ /**
553
+ * Source stats for a task run.
554
+ */
555
+ export interface TaskRunSourceStats {
556
+ /**
557
+ * Number of sources considered in processing the task.
558
+ */
559
+ num_sources_considered: number | null;
560
+
561
+ /**
562
+ * Number of sources read in processing the task.
563
+ */
564
+ num_sources_read: number | null;
565
+
566
+ /**
567
+ * A sample of URLs of sources read in processing the task.
568
+ */
569
+ sources_read_sample: Array<string> | null;
570
+ }
571
+
494
572
  /**
495
573
  * Output from a task that returns text.
496
574
  */
@@ -581,81 +659,11 @@ export interface Webhook {
581
659
  * A progress update for a task run.
582
660
  */
583
661
  export type TaskRunEventsResponse =
584
- | TaskRunEventsResponse.TaskRunProgressStatsEvent
585
- | TaskRunEventsResponse.TaskRunProgressMessageEvent
662
+ | TaskRunProgressStatsEvent
663
+ | TaskRunProgressMessageEvent
586
664
  | TaskRunEvent
587
665
  | ErrorEvent;
588
666
 
589
- export namespace TaskRunEventsResponse {
590
- /**
591
- * A progress update for a task run.
592
- */
593
- export interface TaskRunProgressStatsEvent {
594
- /**
595
- * Completion percentage of the task run. Ranges from 0 to 100 where 0 indicates no
596
- * progress and 100 indicates completion.
597
- */
598
- progress_meter: number;
599
-
600
- /**
601
- * Source stats describing progress so far.
602
- */
603
- source_stats: TaskRunProgressStatsEvent.SourceStats;
604
-
605
- /**
606
- * Event type; always 'task_run.progress_stats'.
607
- */
608
- type: 'task_run.progress_stats';
609
- }
610
-
611
- export namespace TaskRunProgressStatsEvent {
612
- /**
613
- * Source stats describing progress so far.
614
- */
615
- export interface SourceStats {
616
- /**
617
- * Number of sources considered in processing the task.
618
- */
619
- num_sources_considered: number | null;
620
-
621
- /**
622
- * Number of sources read in processing the task.
623
- */
624
- num_sources_read: number | null;
625
-
626
- /**
627
- * A sample of URLs of sources read in processing the task.
628
- */
629
- sources_read_sample: Array<string> | null;
630
- }
631
- }
632
-
633
- /**
634
- * A message for a task run progress update.
635
- */
636
- export interface TaskRunProgressMessageEvent {
637
- /**
638
- * Progress update message.
639
- */
640
- message: string;
641
-
642
- /**
643
- * Timestamp of the message.
644
- */
645
- timestamp: string | null;
646
-
647
- /**
648
- * Event type; always starts with 'task_run.progress_msg'.
649
- */
650
- type:
651
- | 'task_run.progress_msg.plan'
652
- | 'task_run.progress_msg.search'
653
- | 'task_run.progress_msg.result'
654
- | 'task_run.progress_msg.tool_call'
655
- | 'task_run.progress_msg.exec_status';
656
- }
657
- }
658
-
659
667
  export interface TaskRunCreateParams {
660
668
  /**
661
669
  * Body param: Input to the task, either text or a JSON object.
@@ -670,7 +678,7 @@ export interface TaskRunCreateParams {
670
678
  /**
671
679
  * Body param: Advanced search configuration for a task run.
672
680
  */
673
- advanced_settings?: TaskRunCreateParams.AdvancedSettings | null;
681
+ advanced_settings?: TaskAdvancedSettings | null;
674
682
 
675
683
  /**
676
684
  * Body param: Controls tracking of task run execution progress. When set to true,
@@ -723,19 +731,7 @@ export interface TaskRunCreateParams {
723
731
  /**
724
732
  * Header param: Optional header to specify the beta version(s) to enable.
725
733
  */
726
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
727
- }
728
-
729
- export namespace TaskRunCreateParams {
730
- /**
731
- * Advanced search configuration for a task run.
732
- */
733
- export interface AdvancedSettings {
734
- /**
735
- * ISO 3166-1 alpha-2 country code for geo-targeted search results.
736
- */
737
- location?: string | null;
738
- }
734
+ betas?: Array<FindAllAPI.ParallelBeta>;
739
735
  }
740
736
 
741
737
  export interface TaskRunResultParams {
@@ -747,7 +743,7 @@ export interface TaskRunResultParams {
747
743
  /**
748
744
  * Header param: Optional header to specify the beta version(s) to enable.
749
745
  */
750
- betas?: Array<BetaTaskRunAPI.ParallelBeta>;
746
+ betas?: Array<FindAllAPI.ParallelBeta>;
751
747
  }
752
748
 
753
749
  export declare namespace TaskRun {
@@ -760,10 +756,14 @@ export declare namespace TaskRun {
760
756
  type McpServer as McpServer,
761
757
  type McpToolCall as McpToolCall,
762
758
  type RunInput as RunInput,
759
+ type TaskAdvancedSettings as TaskAdvancedSettings,
763
760
  type TaskRun as TaskRun,
764
761
  type TaskRunEvent as TaskRunEvent,
765
762
  type TaskRunJsonOutput as TaskRunJsonOutput,
763
+ type TaskRunProgressMessageEvent as TaskRunProgressMessageEvent,
764
+ type TaskRunProgressStatsEvent as TaskRunProgressStatsEvent,
766
765
  type TaskRunResult as TaskRunResult,
766
+ type TaskRunSourceStats as TaskRunSourceStats,
767
767
  type TaskRunTextOutput as TaskRunTextOutput,
768
768
  type TaskSpec as TaskSpec,
769
769
  type TextSchema as TextSchema,
@@ -773,3 +773,30 @@ export declare namespace TaskRun {
773
773
  type TaskRunResultParams as TaskRunResultParams,
774
774
  };
775
775
  }
776
+
777
+ // Backwards-compat namespace members (deprecated). Previously these types
778
+ // existed as nested interfaces under the parent type's namespace; they've
779
+ // since moved to top-level model types. Declaration merging here preserves
780
+ // the old `Parent.Member` import paths.
781
+ type _TaskAdvancedSettings = TaskAdvancedSettings;
782
+ type _TaskRunProgressMessageEvent = TaskRunProgressMessageEvent;
783
+ type _TaskRunProgressStatsEvent = TaskRunProgressStatsEvent;
784
+ type _TaskRunSourceStats = TaskRunSourceStats;
785
+ export namespace RunInput {
786
+ /** @deprecated Use the top-level `TaskAdvancedSettings` instead. */
787
+ export type AdvancedSettings = _TaskAdvancedSettings;
788
+ }
789
+ export namespace TaskRunCreateParams {
790
+ /** @deprecated Use the top-level `TaskAdvancedSettings` instead. */
791
+ export type AdvancedSettings = _TaskAdvancedSettings;
792
+ }
793
+ export namespace TaskRunEventsResponse {
794
+ /** @deprecated Use the top-level `TaskRunProgressMessageEvent` instead. */
795
+ export type TaskRunProgressMessageEvent = _TaskRunProgressMessageEvent;
796
+ /** @deprecated Use the top-level `TaskRunProgressStatsEvent` instead. */
797
+ export type TaskRunProgressStatsEvent = _TaskRunProgressStatsEvent;
798
+ export namespace TaskRunProgressStatsEvent {
799
+ /** @deprecated Use the top-level `TaskRunSourceStats` instead. */
800
+ export type SourceStats = _TaskRunSourceStats;
801
+ }
802
+ }
@@ -23,21 +23,7 @@ export interface AdvancedExtractSettings {
23
23
  * Controls full content extraction. Set to true to enable with defaults, false to
24
24
  * disable, or provide FullContentSettings for fine-grained control.
25
25
  */
26
- full_content?: AdvancedExtractSettings.FullContentSettings | boolean;
27
- }
28
-
29
- export namespace AdvancedExtractSettings {
30
- /**
31
- * Optional settings for returning full content.
32
- */
33
- export interface FullContentSettings {
34
- /**
35
- * Optional limit on the number of characters to include in the full content for
36
- * each url. Full content always starts at the beginning of the page and is
37
- * truncated at the limit if necessary.
38
- */
39
- max_chars_per_result?: number | null;
40
- }
26
+ full_content?: FullContentSettings | boolean;
41
27
  }
42
28
 
43
29
  /**
@@ -82,7 +68,7 @@ export interface ExcerptSettings {
82
68
  /**
83
69
  * Optional upper bound on the total number of characters to include per url.
84
70
  * Excerpts may contain fewer characters than this limit to maximize relevance and
85
- * token efficiency. Values below 1000 will be automatically set to 1000.
71
+ * token efficiency.
86
72
  */
87
73
  max_chars_per_result?: number | null;
88
74
  }
@@ -198,6 +184,18 @@ export interface FetchPolicy {
198
184
  timeout_seconds?: number | null;
199
185
  }
200
186
 
187
+ /**
188
+ * Optional settings for returning full content.
189
+ */
190
+ export interface FullContentSettings {
191
+ /**
192
+ * Optional limit on the number of characters to include in the full content for
193
+ * each url. Full content always starts at the beginning of the page and is
194
+ * truncated at the limit if necessary.
195
+ */
196
+ max_chars_per_result?: number | null;
197
+ }
198
+
201
199
  /**
202
200
  * Search response.
203
201
  */
@@ -376,6 +374,7 @@ export declare namespace TopLevel {
376
374
  type ExtractResponse as ExtractResponse,
377
375
  type ExtractResult as ExtractResult,
378
376
  type FetchPolicy as FetchPolicy,
377
+ type FullContentSettings as FullContentSettings,
379
378
  type SearchResult as SearchResult,
380
379
  type UsageItem as UsageItem,
381
380
  type WebSearchResult as WebSearchResult,
@@ -383,3 +382,12 @@ export declare namespace TopLevel {
383
382
  type SearchParams as SearchParams,
384
383
  };
385
384
  }
385
+
386
+ // Backwards-compat namespace member (deprecated). `AdvancedExtractSettings.FullContentSettings`
387
+ // was previously a nested interface; the shape now lives as the top-level
388
+ // `FullContentSettings` model. Declaration merging here preserves the old path.
389
+ export namespace AdvancedExtractSettings {
390
+ /** @deprecated Use the top-level `FullContentSettings` instead. */
391
+ export type FullContentSettings = TopLevelFullContentSettings;
392
+ }
393
+ type TopLevelFullContentSettings = FullContentSettings;
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.4.1'; // x-release-please-version
1
+ export const VERSION = '1.0.0'; // x-release-please-version
package/streaming.d.mts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/streaming instead */
1
2
  export * from "./core/streaming.mjs";
2
3
  //# sourceMappingURL=streaming.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"streaming.d.mts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"streaming.d.mts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qCAAiC"}
package/streaming.d.ts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/streaming instead */
1
2
  export * from "./core/streaming.js";
2
3
  //# sourceMappingURL=streaming.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,oCAAiC"}
package/streaming.mjs CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/streaming instead */
1
2
  export * from "./core/streaming.mjs";
2
3
  //# sourceMappingURL=streaming.mjs.map
package/streaming.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"streaming.mjs","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"streaming.mjs","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,qCAAiC"}
package/uploads.d.mts CHANGED
@@ -1,2 +1,3 @@
1
+ /** @deprecated Import from ./core/uploads instead */
1
2
  export * from "./core/uploads.mjs";
2
3
  //# sourceMappingURL=uploads.d.mts.map
package/uploads.d.mts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}