parallel-web 0.3.2 → 0.4.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 +44 -0
- package/client.d.mts +40 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +40 -2
- package/client.d.ts.map +1 -1
- package/client.js +39 -0
- package/client.js.map +1 -1
- package/client.mjs +39 -0
- package/client.mjs.map +1 -1
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/package.json +12 -1
- package/resources/beta/beta.d.mts +40 -61
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +40 -61
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/beta.js +11 -2
- package/resources/beta/beta.js.map +1 -1
- package/resources/beta/beta.mjs +11 -2
- package/resources/beta/beta.mjs.map +1 -1
- package/resources/beta/findall.d.mts +167 -8
- package/resources/beta/findall.d.mts.map +1 -1
- package/resources/beta/findall.d.ts +167 -8
- package/resources/beta/findall.d.ts.map +1 -1
- package/resources/beta/findall.js +108 -0
- package/resources/beta/findall.js.map +1 -1
- package/resources/beta/findall.mjs +108 -0
- package/resources/beta/findall.mjs.map +1 -1
- package/resources/beta/index.d.mts +2 -2
- package/resources/beta/index.d.mts.map +1 -1
- package/resources/beta/index.d.ts +2 -2
- package/resources/beta/index.d.ts.map +1 -1
- package/resources/beta/index.js.map +1 -1
- package/resources/beta/index.mjs.map +1 -1
- package/resources/beta/task-group.d.mts +50 -5
- package/resources/beta/task-group.d.mts.map +1 -1
- package/resources/beta/task-group.d.ts +50 -5
- package/resources/beta/task-group.d.ts.map +1 -1
- package/resources/beta/task-group.js +45 -3
- package/resources/beta/task-group.js.map +1 -1
- package/resources/beta/task-group.mjs +45 -3
- package/resources/beta/task-group.mjs.map +1 -1
- package/resources/beta/task-run.d.mts +77 -270
- package/resources/beta/task-run.d.mts.map +1 -1
- package/resources/beta/task-run.d.ts +77 -270
- package/resources/beta/task-run.d.ts.map +1 -1
- package/resources/beta/task-run.js +17 -2
- package/resources/beta/task-run.js.map +1 -1
- package/resources/beta/task-run.mjs +17 -2
- package/resources/beta/task-run.mjs.map +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/shared.d.mts +4 -2
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +4 -2
- package/resources/shared.d.ts.map +1 -1
- package/resources/task-run.d.mts +308 -30
- package/resources/task-run.d.mts.map +1 -1
- package/resources/task-run.d.ts +308 -30
- package/resources/task-run.d.ts.map +1 -1
- package/resources/task-run.js +67 -4
- package/resources/task-run.js.map +1 -1
- package/resources/task-run.mjs +67 -4
- package/resources/task-run.mjs.map +1 -1
- package/resources/top-level.d.mts +317 -0
- package/resources/top-level.d.mts.map +1 -0
- package/resources/top-level.d.ts +317 -0
- package/resources/top-level.d.ts.map +1 -0
- package/resources/top-level.js +4 -0
- package/resources/top-level.js.map +1 -0
- package/resources/top-level.mjs +3 -0
- package/resources/top-level.mjs.map +1 -0
- package/src/client.ts +86 -0
- package/src/internal/utils/env.ts +2 -2
- package/src/resources/beta/api.md +12 -9
- package/src/resources/beta/beta.ts +55 -73
- package/src/resources/beta/findall.ts +187 -7
- package/src/resources/beta/index.ts +7 -4
- package/src/resources/beta/task-group.ts +54 -7
- package/src/resources/beta/task-run.ts +94 -305
- package/src/resources/index.ts +20 -0
- package/src/resources/shared.ts +4 -2
- package/src/resources/task-run.ts +391 -32
- package/src/resources/top-level.ts +385 -0
- 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
|
@@ -6,25 +6,52 @@ import { APIPromise } from "../../core/api-promise.js";
|
|
|
6
6
|
import { Stream } from "../../core/streaming.js";
|
|
7
7
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
8
8
|
/**
|
|
9
|
-
* The Task
|
|
9
|
+
* 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.
|
|
10
|
+
* - Output metadata: citations, excerpts, reasoning, and confidence per field
|
|
11
|
+
*
|
|
12
|
+
* Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
|
|
10
13
|
* - Submit hundreds or thousands of Tasks as a single group
|
|
11
14
|
* - Observe group progress and receive results as they complete
|
|
12
15
|
* - Real-time updates via Server-Sent Events (SSE)
|
|
13
16
|
* - Add tasks to an existing group while it is running
|
|
14
17
|
* - Group-level retry and error aggregation
|
|
15
|
-
* Status: beta and subject to change.
|
|
16
18
|
*/
|
|
17
19
|
export declare class TaskGroup extends APIResource {
|
|
18
20
|
/**
|
|
19
21
|
* Initiates a TaskGroup to group and track multiple runs.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const taskGroup = await client.beta.taskGroup.create();
|
|
26
|
+
* ```
|
|
20
27
|
*/
|
|
21
28
|
create(body: TaskGroupCreateParams, options?: RequestOptions): APIPromise<TaskGroup>;
|
|
22
29
|
/**
|
|
23
30
|
* Retrieves aggregated status across runs in a TaskGroup.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const taskGroup = await client.beta.taskGroup.retrieve(
|
|
35
|
+
* 'taskgroup_id',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
24
38
|
*/
|
|
25
39
|
retrieve(taskGroupID: string, options?: RequestOptions): APIPromise<TaskGroup>;
|
|
26
40
|
/**
|
|
27
41
|
* Initiates multiple task runs within a TaskGroup.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* const taskGroupRunResponse =
|
|
46
|
+
* await client.beta.taskGroup.addRuns('taskgroup_id', {
|
|
47
|
+
* inputs: [
|
|
48
|
+
* {
|
|
49
|
+
* input: 'What was the GDP of France in 2023?',
|
|
50
|
+
* processor: 'base',
|
|
51
|
+
* },
|
|
52
|
+
* ],
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
28
55
|
*/
|
|
29
56
|
addRuns(taskGroupID: string, params: TaskGroupAddRunsParams, options?: RequestOptions): APIPromise<TaskGroupRunResponse>;
|
|
30
57
|
/**
|
|
@@ -32,6 +59,13 @@ export declare class TaskGroup extends APIResource {
|
|
|
32
59
|
*
|
|
33
60
|
* The connection will remain open for up to an hour as long as at least one run in
|
|
34
61
|
* the group is still active.
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```ts
|
|
65
|
+
* const response = await client.beta.taskGroup.events(
|
|
66
|
+
* 'taskgroup_id',
|
|
67
|
+
* );
|
|
68
|
+
* ```
|
|
35
69
|
*/
|
|
36
70
|
events(taskGroupID: string, query?: TaskGroupEventsParams | undefined, options?: RequestOptions): APIPromise<Stream<TaskGroupEventsResponse>>;
|
|
37
71
|
/**
|
|
@@ -45,6 +79,13 @@ export declare class TaskGroup extends APIResource {
|
|
|
45
79
|
* specify the `last_event_id` parameter with the `event_id` of the last event in
|
|
46
80
|
* the stream. The stream will resume from the next event after the
|
|
47
81
|
* `last_event_id`.
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const response = await client.beta.taskGroup.getRuns(
|
|
86
|
+
* 'taskgroup_id',
|
|
87
|
+
* );
|
|
88
|
+
* ```
|
|
48
89
|
*/
|
|
49
90
|
getRuns(taskGroupID: string, query?: TaskGroupGetRunsParams | undefined, options?: RequestOptions): APIPromise<Stream<TaskGroupGetRunsResponse>>;
|
|
50
91
|
}
|
|
@@ -127,7 +168,7 @@ export interface TaskGroupStatus {
|
|
|
127
168
|
/**
|
|
128
169
|
* Event indicating an update to group status.
|
|
129
170
|
*/
|
|
130
|
-
export type TaskGroupEventsResponse = TaskGroupEventsResponse.TaskGroupStatusEvent |
|
|
171
|
+
export type TaskGroupEventsResponse = TaskGroupEventsResponse.TaskGroupStatusEvent | TaskRunAPI.TaskRunEvent | TaskRunAPI.ErrorEvent;
|
|
131
172
|
export declare namespace TaskGroupEventsResponse {
|
|
132
173
|
/**
|
|
133
174
|
* Event indicating an update to group status.
|
|
@@ -152,7 +193,7 @@ export declare namespace TaskGroupEventsResponse {
|
|
|
152
193
|
*
|
|
153
194
|
* May indicate completion, cancellation, or failure.
|
|
154
195
|
*/
|
|
155
|
-
export type TaskGroupGetRunsResponse =
|
|
196
|
+
export type TaskGroupGetRunsResponse = TaskRunAPI.TaskRunEvent | TaskRunAPI.ErrorEvent;
|
|
156
197
|
export interface TaskGroupCreateParams {
|
|
157
198
|
/**
|
|
158
199
|
* User-provided metadata stored with the task group.
|
|
@@ -167,7 +208,11 @@ export interface TaskGroupAddRunsParams {
|
|
|
167
208
|
* request. If you'd like to add more runs, split them across multiple TaskGroup
|
|
168
209
|
* POST requests.
|
|
169
210
|
*/
|
|
170
|
-
inputs: Array<
|
|
211
|
+
inputs: Array<TaskRunAPI.RunInput>;
|
|
212
|
+
/**
|
|
213
|
+
* Query param
|
|
214
|
+
*/
|
|
215
|
+
refresh_status?: boolean;
|
|
171
216
|
/**
|
|
172
217
|
* Body param: Specification for a task.
|
|
173
218
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"task-group.d.ts","sourceRoot":"","sources":["../../src/resources/beta/task-group.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE;OAEV,EAAE,cAAc,EAAE;AAGzB
|
|
1
|
+
{"version":3,"file":"task-group.d.ts","sourceRoot":"","sources":["../../src/resources/beta/task-group.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE;OAEV,EAAE,cAAc,EAAE;AAGzB;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAQpF;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAO9E;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAanC;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,qBAAqB,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;IAY9C;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACL,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,sBAAsB,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;CAWhD;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,sBAAsB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,uBAAuB,CAAC,oBAAoB,GAC5C,UAAU,CAAC,YAAY,GACvB,UAAU,CAAC,UAAU,CAAC;AAE1B,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC;QAErC;;WAEG;QACH,IAAI,EAAE,mBAAmB,CAAC;KAC3B;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC;AAEvF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,MAAM,CAAC,EACH,QAAQ,GACR,iBAAiB,GACjB,SAAS,GACT,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,WAAW,GACX,IAAI,CAAC;CACV;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -6,17 +6,24 @@ const resource_1 = require("../../core/resource.js");
|
|
|
6
6
|
const headers_1 = require("../../internal/headers.js");
|
|
7
7
|
const path_1 = require("../../internal/utils/path.js");
|
|
8
8
|
/**
|
|
9
|
-
* The Task
|
|
9
|
+
* 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.
|
|
10
|
+
* - Output metadata: citations, excerpts, reasoning, and confidence per field
|
|
11
|
+
*
|
|
12
|
+
* Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
|
|
10
13
|
* - Submit hundreds or thousands of Tasks as a single group
|
|
11
14
|
* - Observe group progress and receive results as they complete
|
|
12
15
|
* - Real-time updates via Server-Sent Events (SSE)
|
|
13
16
|
* - Add tasks to an existing group while it is running
|
|
14
17
|
* - Group-level retry and error aggregation
|
|
15
|
-
* Status: beta and subject to change.
|
|
16
18
|
*/
|
|
17
19
|
class TaskGroup extends resource_1.APIResource {
|
|
18
20
|
/**
|
|
19
21
|
* Initiates a TaskGroup to group and track multiple runs.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const taskGroup = await client.beta.taskGroup.create();
|
|
26
|
+
* ```
|
|
20
27
|
*/
|
|
21
28
|
create(body, options) {
|
|
22
29
|
return this._client.post('/v1beta/tasks/groups', {
|
|
@@ -27,6 +34,13 @@ class TaskGroup extends resource_1.APIResource {
|
|
|
27
34
|
}
|
|
28
35
|
/**
|
|
29
36
|
* Retrieves aggregated status across runs in a TaskGroup.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* const taskGroup = await client.beta.taskGroup.retrieve(
|
|
41
|
+
* 'taskgroup_id',
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
30
44
|
*/
|
|
31
45
|
retrieve(taskGroupID, options) {
|
|
32
46
|
return this._client.get((0, path_1.path) `/v1beta/tasks/groups/${taskGroupID}`, {
|
|
@@ -36,10 +50,24 @@ class TaskGroup extends resource_1.APIResource {
|
|
|
36
50
|
}
|
|
37
51
|
/**
|
|
38
52
|
* Initiates multiple task runs within a TaskGroup.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```ts
|
|
56
|
+
* const taskGroupRunResponse =
|
|
57
|
+
* await client.beta.taskGroup.addRuns('taskgroup_id', {
|
|
58
|
+
* inputs: [
|
|
59
|
+
* {
|
|
60
|
+
* input: 'What was the GDP of France in 2023?',
|
|
61
|
+
* processor: 'base',
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
39
66
|
*/
|
|
40
67
|
addRuns(taskGroupID, params, options) {
|
|
41
|
-
const { betas, ...body } = params;
|
|
68
|
+
const { refresh_status, betas, ...body } = params;
|
|
42
69
|
return this._client.post((0, path_1.path) `/v1beta/tasks/groups/${taskGroupID}/runs`, {
|
|
70
|
+
query: { refresh_status },
|
|
43
71
|
body,
|
|
44
72
|
...options,
|
|
45
73
|
headers: (0, headers_1.buildHeaders)([
|
|
@@ -53,6 +81,13 @@ class TaskGroup extends resource_1.APIResource {
|
|
|
53
81
|
*
|
|
54
82
|
* The connection will remain open for up to an hour as long as at least one run in
|
|
55
83
|
* the group is still active.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const response = await client.beta.taskGroup.events(
|
|
88
|
+
* 'taskgroup_id',
|
|
89
|
+
* );
|
|
90
|
+
* ```
|
|
56
91
|
*/
|
|
57
92
|
events(taskGroupID, query = {}, options) {
|
|
58
93
|
return this._client.get((0, path_1.path) `/v1beta/tasks/groups/${taskGroupID}/events`, {
|
|
@@ -76,6 +111,13 @@ class TaskGroup extends resource_1.APIResource {
|
|
|
76
111
|
* specify the `last_event_id` parameter with the `event_id` of the last event in
|
|
77
112
|
* the stream. The stream will resume from the next event after the
|
|
78
113
|
* `last_event_id`.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* const response = await client.beta.taskGroup.getRuns(
|
|
118
|
+
* 'taskgroup_id',
|
|
119
|
+
* );
|
|
120
|
+
* ```
|
|
79
121
|
*/
|
|
80
122
|
getRuns(taskGroupID, query = {}, options) {
|
|
81
123
|
return this._client.get((0, path_1.path) `/v1beta/tasks/groups/${taskGroupID}/runs`, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"task-group.js","sourceRoot":"","sources":["../../src/resources/beta/task-group.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAsD;AAEtD,uDAAiD;AAEjD
|
|
1
|
+
{"version":3,"file":"task-group.js","sourceRoot":"","sources":["../../src/resources/beta/task-group.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;;;;;;;;;GAUG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,eAAe,EAAE,2BAA2B,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,WAAW,EAAE,EAAE;YACjE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,eAAe,EAAE,2BAA2B,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,WAAmB,EACnB,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,WAAW,OAAO,EAAE;YACvE,KAAK,EAAE,EAAE,cAAc,EAAE;YACzB,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,eAAe,EAAE,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,2BAA2B,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAC/E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,WAAW,SAAS,EAAE;YACxE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,EAAE,mBAAmB,EAAE;gBAC7E,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,MAAM,EAAE,IAAI;SACb,CAAgD,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACL,WAAmB,EACnB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,WAAW,OAAO,EAAE;YACtE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,EAAE,mBAAmB,EAAE;gBAC7E,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,MAAM,EAAE,IAAI;SACb,CAAiD,CAAC;IACrD,CAAC;CACF;AAlID,8BAkIC"}
|
|
@@ -3,17 +3,24 @@ import { APIResource } from "../../core/resource.mjs";
|
|
|
3
3
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
4
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
5
|
/**
|
|
6
|
-
* The Task
|
|
6
|
+
* 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.
|
|
7
|
+
* - Output metadata: citations, excerpts, reasoning, and confidence per field
|
|
8
|
+
*
|
|
9
|
+
* Task Groups enable batch execution of many independent Task runs with group-level monitoring and failure handling.
|
|
7
10
|
* - Submit hundreds or thousands of Tasks as a single group
|
|
8
11
|
* - Observe group progress and receive results as they complete
|
|
9
12
|
* - Real-time updates via Server-Sent Events (SSE)
|
|
10
13
|
* - Add tasks to an existing group while it is running
|
|
11
14
|
* - Group-level retry and error aggregation
|
|
12
|
-
* Status: beta and subject to change.
|
|
13
15
|
*/
|
|
14
16
|
export class TaskGroup extends APIResource {
|
|
15
17
|
/**
|
|
16
18
|
* Initiates a TaskGroup to group and track multiple runs.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const taskGroup = await client.beta.taskGroup.create();
|
|
23
|
+
* ```
|
|
17
24
|
*/
|
|
18
25
|
create(body, options) {
|
|
19
26
|
return this._client.post('/v1beta/tasks/groups', {
|
|
@@ -24,6 +31,13 @@ export class TaskGroup extends APIResource {
|
|
|
24
31
|
}
|
|
25
32
|
/**
|
|
26
33
|
* Retrieves aggregated status across runs in a TaskGroup.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const taskGroup = await client.beta.taskGroup.retrieve(
|
|
38
|
+
* 'taskgroup_id',
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
27
41
|
*/
|
|
28
42
|
retrieve(taskGroupID, options) {
|
|
29
43
|
return this._client.get(path `/v1beta/tasks/groups/${taskGroupID}`, {
|
|
@@ -33,10 +47,24 @@ export class TaskGroup extends APIResource {
|
|
|
33
47
|
}
|
|
34
48
|
/**
|
|
35
49
|
* Initiates multiple task runs within a TaskGroup.
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* const taskGroupRunResponse =
|
|
54
|
+
* await client.beta.taskGroup.addRuns('taskgroup_id', {
|
|
55
|
+
* inputs: [
|
|
56
|
+
* {
|
|
57
|
+
* input: 'What was the GDP of France in 2023?',
|
|
58
|
+
* processor: 'base',
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* });
|
|
62
|
+
* ```
|
|
36
63
|
*/
|
|
37
64
|
addRuns(taskGroupID, params, options) {
|
|
38
|
-
const { betas, ...body } = params;
|
|
65
|
+
const { refresh_status, betas, ...body } = params;
|
|
39
66
|
return this._client.post(path `/v1beta/tasks/groups/${taskGroupID}/runs`, {
|
|
67
|
+
query: { refresh_status },
|
|
40
68
|
body,
|
|
41
69
|
...options,
|
|
42
70
|
headers: buildHeaders([
|
|
@@ -50,6 +78,13 @@ export class TaskGroup extends APIResource {
|
|
|
50
78
|
*
|
|
51
79
|
* The connection will remain open for up to an hour as long as at least one run in
|
|
52
80
|
* the group is still active.
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```ts
|
|
84
|
+
* const response = await client.beta.taskGroup.events(
|
|
85
|
+
* 'taskgroup_id',
|
|
86
|
+
* );
|
|
87
|
+
* ```
|
|
53
88
|
*/
|
|
54
89
|
events(taskGroupID, query = {}, options) {
|
|
55
90
|
return this._client.get(path `/v1beta/tasks/groups/${taskGroupID}/events`, {
|
|
@@ -73,6 +108,13 @@ export class TaskGroup extends APIResource {
|
|
|
73
108
|
* specify the `last_event_id` parameter with the `event_id` of the last event in
|
|
74
109
|
* the stream. The stream will resume from the next event after the
|
|
75
110
|
* `last_event_id`.
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* const response = await client.beta.taskGroup.getRuns(
|
|
115
|
+
* 'taskgroup_id',
|
|
116
|
+
* );
|
|
117
|
+
* ```
|
|
76
118
|
*/
|
|
77
119
|
getRuns(taskGroupID, query = {}, options) {
|
|
78
120
|
return this._client.get(path `/v1beta/tasks/groups/${taskGroupID}/runs`, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"task-group.mjs","sourceRoot":"","sources":["../../src/resources/beta/task-group.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf
|
|
1
|
+
{"version":3,"file":"task-group.mjs","sourceRoot":"","sources":["../../src/resources/beta/task-group.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,eAAe,EAAE,2BAA2B,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,WAAW,EAAE,EAAE;YACjE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,eAAe,EAAE,2BAA2B,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,WAAmB,EACnB,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,WAAW,OAAO,EAAE;YACvE,KAAK,EAAE,EAAE,cAAc,EAAE;YACzB,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,eAAe,EAAE,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,2BAA2B,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAC/E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,WAAW,SAAS,EAAE;YACxE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,EAAE,mBAAmB,EAAE;gBAC7E,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,MAAM,EAAE,IAAI;SACb,CAAgD,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CACL,WAAmB,EACnB,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,WAAW,OAAO,EAAE;YACtE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,EAAE,mBAAmB,EAAE;gBAC7E,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,MAAM,EAAE,IAAI;SACb,CAAiD,CAAC;IACrD,CAAC;CACF"}
|