parallel-web 0.1.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 +65 -0
- package/LICENSE +7 -0
- package/README.md +371 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +187 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +187 -0
- package/client.d.ts.map +1 -0
- package/client.js +462 -0
- package/client.js.map +1 -0
- package/client.mjs +458 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/streaming.d.mts +33 -0
- package/core/streaming.d.mts.map +1 -0
- package/core/streaming.d.ts +33 -0
- package/core/streaming.d.ts.map +1 -0
- package/core/streaming.js +263 -0
- package/core/streaming.js.map +1 -0
- package/core/streaming.mjs +258 -0
- package/core/streaming.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/decoders/line.d.mts +17 -0
- package/internal/decoders/line.d.mts.map +1 -0
- package/internal/decoders/line.d.ts +17 -0
- package/internal/decoders/line.d.ts.map +1 -0
- package/internal/decoders/line.js +113 -0
- package/internal/decoders/line.js.map +1 -0
- package/internal/decoders/line.mjs +108 -0
- package/internal/decoders/line.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +45 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +42 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +77 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +77 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +86 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +80 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +148 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/beta/beta.d.mts +86 -0
- package/resources/beta/beta.d.mts.map +1 -0
- package/resources/beta/beta.d.ts +86 -0
- package/resources/beta/beta.d.ts.map +1 -0
- package/resources/beta/beta.js +25 -0
- package/resources/beta/beta.js.map +1 -0
- package/resources/beta/beta.mjs +20 -0
- package/resources/beta/beta.mjs.map +1 -0
- package/resources/beta/index.d.mts +4 -0
- package/resources/beta/index.d.mts.map +1 -0
- package/resources/beta/index.d.ts +4 -0
- package/resources/beta/index.d.ts.map +1 -0
- package/resources/beta/index.js +11 -0
- package/resources/beta/index.js.map +1 -0
- package/resources/beta/index.mjs +5 -0
- package/resources/beta/index.mjs.map +1 -0
- package/resources/beta/task-group.d.mts +178 -0
- package/resources/beta/task-group.d.mts.map +1 -0
- package/resources/beta/task-group.d.ts +178 -0
- package/resources/beta/task-group.d.ts.map +1 -0
- package/resources/beta/task-group.js +62 -0
- package/resources/beta/task-group.js.map +1 -0
- package/resources/beta/task-group.mjs +58 -0
- package/resources/beta/task-group.mjs.map +1 -0
- package/resources/beta/task-run.d.mts +411 -0
- package/resources/beta/task-run.d.mts.map +1 -0
- package/resources/beta/task-run.d.ts +411 -0
- package/resources/beta/task-run.d.ts.map +1 -0
- package/resources/beta/task-run.js +59 -0
- package/resources/beta/task-run.js.map +1 -0
- package/resources/beta/task-run.mjs +55 -0
- package/resources/beta/task-run.mjs.map +1 -0
- package/resources/beta.d.mts +2 -0
- package/resources/beta.d.mts.map +1 -0
- package/resources/beta.d.ts +2 -0
- package/resources/beta.d.ts.map +1 -0
- package/resources/beta.js +6 -0
- package/resources/beta.js.map +1 -0
- package/resources/beta.mjs +3 -0
- package/resources/beta.mjs.map +1 -0
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +4 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +11 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +5 -0
- package/resources/index.mjs.map +1 -0
- package/resources/shared.d.mts +70 -0
- package/resources/shared.d.mts.map +1 -0
- package/resources/shared.d.ts +70 -0
- package/resources/shared.d.ts.map +1 -0
- package/resources/shared.js +4 -0
- package/resources/shared.js.map +1 -0
- package/resources/shared.mjs +3 -0
- package/resources/shared.mjs.map +1 -0
- package/resources/task-run.d.mts +338 -0
- package/resources/task-run.d.mts.map +1 -0
- package/resources/task-run.d.ts +338 -0
- package/resources/task-run.d.ts.map +1 -0
- package/resources/task-run.js +34 -0
- package/resources/task-run.js.map +1 -0
- package/resources/task-run.mjs +30 -0
- package/resources/task-run.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +763 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/streaming.ts +315 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/decoders/line.ts +135 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +64 -0
- package/src/internal/request-options.ts +93 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +127 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/beta/beta.ts +157 -0
- package/src/resources/beta/index.ts +28 -0
- package/src/resources/beta/task-group.ts +270 -0
- package/src/resources/beta/task-run.ts +517 -0
- package/src/resources/beta.ts +3 -0
- package/src/resources/index.ts +19 -0
- package/src/resources/shared.ts +76 -0
- package/src/resources/task-run.ts +394 -0
- package/src/resources.ts +1 -0
- package/src/streaming.ts +2 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/streaming.d.mts +2 -0
- package/streaming.d.mts.map +1 -0
- package/streaming.d.ts +2 -0
- package/streaming.d.ts.map +1 -0
- package/streaming.js +6 -0
- package/streaming.js.map +1 -0
- package/streaming.mjs +2 -0
- package/streaming.mjs.map +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,338 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as Shared from "./shared.js";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class TaskRun extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Initiates a task run.
|
|
8
|
+
*
|
|
9
|
+
* Returns immediately with a run object in status 'queued'.
|
|
10
|
+
*
|
|
11
|
+
* Beta features can be enabled by setting the 'parallel-beta' header.
|
|
12
|
+
*/
|
|
13
|
+
create(body: TaskRunCreateParams, options?: RequestOptions): APIPromise<TaskRun>;
|
|
14
|
+
/**
|
|
15
|
+
* Retrieves run status by run_id.
|
|
16
|
+
*
|
|
17
|
+
* The run result is available from the `/result` endpoint.
|
|
18
|
+
*/
|
|
19
|
+
retrieve(runID: string, options?: RequestOptions): APIPromise<TaskRun>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves a run result by run_id, blocking until the run is completed.
|
|
22
|
+
*/
|
|
23
|
+
result(runID: string, query?: TaskRunResultParams | null | undefined, options?: RequestOptions): APIPromise<TaskRunResult>;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Auto schema for a task input or output.
|
|
27
|
+
*/
|
|
28
|
+
export interface AutoSchema {
|
|
29
|
+
/**
|
|
30
|
+
* The type of schema being defined. Always `auto`.
|
|
31
|
+
*/
|
|
32
|
+
type?: 'auto';
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* A citation for a task output.
|
|
36
|
+
*/
|
|
37
|
+
export interface Citation {
|
|
38
|
+
/**
|
|
39
|
+
* URL of the citation.
|
|
40
|
+
*/
|
|
41
|
+
url: string;
|
|
42
|
+
/**
|
|
43
|
+
* Excerpts from the citation supporting the output. Only certain processors
|
|
44
|
+
* provide excerpts.
|
|
45
|
+
*/
|
|
46
|
+
excerpts?: Array<string> | null;
|
|
47
|
+
/**
|
|
48
|
+
* Title of the citation.
|
|
49
|
+
*/
|
|
50
|
+
title?: string | null;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Citations and reasoning supporting one field of a task output.
|
|
54
|
+
*/
|
|
55
|
+
export interface FieldBasis {
|
|
56
|
+
/**
|
|
57
|
+
* Name of the output field.
|
|
58
|
+
*/
|
|
59
|
+
field: string;
|
|
60
|
+
/**
|
|
61
|
+
* Reasoning for the output field.
|
|
62
|
+
*/
|
|
63
|
+
reasoning: string;
|
|
64
|
+
/**
|
|
65
|
+
* List of citations supporting the output field.
|
|
66
|
+
*/
|
|
67
|
+
citations?: Array<Citation>;
|
|
68
|
+
/**
|
|
69
|
+
* Confidence level for the output field. Only certain processors provide
|
|
70
|
+
* confidence levels.
|
|
71
|
+
*/
|
|
72
|
+
confidence?: string | null;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* JSON schema for a task input or output.
|
|
76
|
+
*/
|
|
77
|
+
export interface JsonSchema {
|
|
78
|
+
/**
|
|
79
|
+
* A JSON Schema object. Only a subset of JSON Schema is supported.
|
|
80
|
+
*/
|
|
81
|
+
json_schema: {
|
|
82
|
+
[key: string]: unknown;
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* The type of schema being defined. Always `json`.
|
|
86
|
+
*/
|
|
87
|
+
type?: 'json';
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Request to run a task.
|
|
91
|
+
*/
|
|
92
|
+
export interface RunInput {
|
|
93
|
+
/**
|
|
94
|
+
* Input to the task, either text or a JSON object.
|
|
95
|
+
*/
|
|
96
|
+
input: string | {
|
|
97
|
+
[key: string]: unknown;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* Processor to use for the task.
|
|
101
|
+
*/
|
|
102
|
+
processor: string;
|
|
103
|
+
/**
|
|
104
|
+
* User-provided metadata stored with the run. Keys and values must be strings with
|
|
105
|
+
* a maximum length of 16 and 512 characters respectively.
|
|
106
|
+
*/
|
|
107
|
+
metadata?: {
|
|
108
|
+
[key: string]: string | number | boolean;
|
|
109
|
+
} | null;
|
|
110
|
+
/**
|
|
111
|
+
* Source policy for web search results.
|
|
112
|
+
*
|
|
113
|
+
* This policy governs which sources are allowed/disallowed in results.
|
|
114
|
+
*/
|
|
115
|
+
source_policy?: Shared.SourcePolicy | null;
|
|
116
|
+
/**
|
|
117
|
+
* Specification for a task.
|
|
118
|
+
*
|
|
119
|
+
* Auto output schemas can be specified by setting `output_schema={"type":"auto"}`.
|
|
120
|
+
* Not specifying a TaskSpec is the same as setting an auto output schema.
|
|
121
|
+
*
|
|
122
|
+
* For convenience bare strings are also accepted as input or output schemas.
|
|
123
|
+
*/
|
|
124
|
+
task_spec?: TaskSpec | null;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Status of a task run.
|
|
128
|
+
*/
|
|
129
|
+
export interface TaskRun {
|
|
130
|
+
/**
|
|
131
|
+
* Timestamp of the creation of the task, as an RFC 3339 string.
|
|
132
|
+
*/
|
|
133
|
+
created_at: string | null;
|
|
134
|
+
/**
|
|
135
|
+
* Whether the run is currently active, i.e. status is one of {'cancelling',
|
|
136
|
+
* 'queued', 'running'}.
|
|
137
|
+
*/
|
|
138
|
+
is_active: boolean;
|
|
139
|
+
/**
|
|
140
|
+
* Timestamp of the last modification to the task, as an RFC 3339 string.
|
|
141
|
+
*/
|
|
142
|
+
modified_at: string | null;
|
|
143
|
+
/**
|
|
144
|
+
* Processor used for the run.
|
|
145
|
+
*/
|
|
146
|
+
processor: string;
|
|
147
|
+
/**
|
|
148
|
+
* ID of the task run.
|
|
149
|
+
*/
|
|
150
|
+
run_id: string;
|
|
151
|
+
/**
|
|
152
|
+
* Status of the run.
|
|
153
|
+
*/
|
|
154
|
+
status: 'queued' | 'action_required' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled';
|
|
155
|
+
/**
|
|
156
|
+
* An error message.
|
|
157
|
+
*/
|
|
158
|
+
error?: Shared.ErrorObject | null;
|
|
159
|
+
/**
|
|
160
|
+
* User-provided metadata stored with the run.
|
|
161
|
+
*/
|
|
162
|
+
metadata?: {
|
|
163
|
+
[key: string]: string | number | boolean;
|
|
164
|
+
} | null;
|
|
165
|
+
/**
|
|
166
|
+
* ID of the taskgroup to which the run belongs.
|
|
167
|
+
*/
|
|
168
|
+
taskgroup_id?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Warnings for the run, if any.
|
|
171
|
+
*/
|
|
172
|
+
warnings?: Array<Shared.Warning> | null;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Output from a task that returns JSON.
|
|
176
|
+
*/
|
|
177
|
+
export interface TaskRunJsonOutput {
|
|
178
|
+
/**
|
|
179
|
+
* Basis for each top-level field in the JSON output.
|
|
180
|
+
*/
|
|
181
|
+
basis: Array<FieldBasis>;
|
|
182
|
+
/**
|
|
183
|
+
* Output from the task as a native JSON object, as determined by the output schema
|
|
184
|
+
* of the task spec.
|
|
185
|
+
*/
|
|
186
|
+
content: {
|
|
187
|
+
[key: string]: unknown;
|
|
188
|
+
};
|
|
189
|
+
/**
|
|
190
|
+
* The type of output being returned, as determined by the output schema of the
|
|
191
|
+
* task spec.
|
|
192
|
+
*/
|
|
193
|
+
type: 'json';
|
|
194
|
+
/**
|
|
195
|
+
* Additional fields from beta features used in this task run. When beta features
|
|
196
|
+
* are specified during both task run creation and result retrieval, this field
|
|
197
|
+
* will be empty and instead the relevant beta attributes will be directly included
|
|
198
|
+
* in the `BetaTaskRunJsonOutput` or corresponding output type. However, if beta
|
|
199
|
+
* features were specified during task run creation but not during result
|
|
200
|
+
* retrieval, this field will contain the dump of fields from those beta features.
|
|
201
|
+
* Each key represents the beta feature version (one amongst parallel-beta headers)
|
|
202
|
+
* and the values correspond to the beta feature attributes, if any. For now, only
|
|
203
|
+
* MCP server beta features have attributes. For example,
|
|
204
|
+
* `{mcp-server-2025-07-17: [{'server_name':'mcp_server', 'tool_call_id': 'tc_123', ...}]}}`
|
|
205
|
+
*/
|
|
206
|
+
beta_fields?: {
|
|
207
|
+
[key: string]: unknown;
|
|
208
|
+
} | null;
|
|
209
|
+
/**
|
|
210
|
+
* Output schema for the Task Run. Populated only if the task was executed with an
|
|
211
|
+
* auto schema.
|
|
212
|
+
*/
|
|
213
|
+
output_schema?: {
|
|
214
|
+
[key: string]: unknown;
|
|
215
|
+
} | null;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Result of a task run.
|
|
219
|
+
*/
|
|
220
|
+
export interface TaskRunResult {
|
|
221
|
+
/**
|
|
222
|
+
* Output from the task conforming to the output schema.
|
|
223
|
+
*/
|
|
224
|
+
output: TaskRunTextOutput | TaskRunJsonOutput;
|
|
225
|
+
/**
|
|
226
|
+
* Status of a task run.
|
|
227
|
+
*/
|
|
228
|
+
run: TaskRun;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Output from a task that returns text.
|
|
232
|
+
*/
|
|
233
|
+
export interface TaskRunTextOutput {
|
|
234
|
+
/**
|
|
235
|
+
* Basis for the output. The basis has a single field 'output'.
|
|
236
|
+
*/
|
|
237
|
+
basis: Array<FieldBasis>;
|
|
238
|
+
/**
|
|
239
|
+
* Text output from the task.
|
|
240
|
+
*/
|
|
241
|
+
content: string;
|
|
242
|
+
/**
|
|
243
|
+
* The type of output being returned, as determined by the output schema of the
|
|
244
|
+
* task spec.
|
|
245
|
+
*/
|
|
246
|
+
type: 'text';
|
|
247
|
+
/**
|
|
248
|
+
* Additional fields from beta features used in this task run. When beta features
|
|
249
|
+
* are specified during both task run creation and result retrieval, this field
|
|
250
|
+
* will be empty and instead the relevant beta attributes will be directly included
|
|
251
|
+
* in the `BetaTaskRunJsonOutput` or corresponding output type. However, if beta
|
|
252
|
+
* features were specified during task run creation but not during result
|
|
253
|
+
* retrieval, this field will contain the dump of fields from those beta features.
|
|
254
|
+
* Each key represents the beta feature version (one amongst parallel-beta headers)
|
|
255
|
+
* and the values correspond to the beta feature attributes, if any. For now, only
|
|
256
|
+
* MCP server beta features have attributes. For example,
|
|
257
|
+
* `{mcp-server-2025-07-17: [{'server_name':'mcp_server', 'tool_call_id': 'tc_123', ...}]}}`
|
|
258
|
+
*/
|
|
259
|
+
beta_fields?: {
|
|
260
|
+
[key: string]: unknown;
|
|
261
|
+
} | null;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Specification for a task.
|
|
265
|
+
*
|
|
266
|
+
* Auto output schemas can be specified by setting `output_schema={"type":"auto"}`.
|
|
267
|
+
* Not specifying a TaskSpec is the same as setting an auto output schema.
|
|
268
|
+
*
|
|
269
|
+
* For convenience bare strings are also accepted as input or output schemas.
|
|
270
|
+
*/
|
|
271
|
+
export interface TaskSpec {
|
|
272
|
+
/**
|
|
273
|
+
* JSON schema or text fully describing the desired output from the task.
|
|
274
|
+
* Descriptions of output fields will determine the form and content of the
|
|
275
|
+
* response. A bare string is equivalent to a text schema with the same
|
|
276
|
+
* description.
|
|
277
|
+
*/
|
|
278
|
+
output_schema: JsonSchema | TextSchema | AutoSchema | string;
|
|
279
|
+
/**
|
|
280
|
+
* Optional JSON schema or text description of expected input to the task. A bare
|
|
281
|
+
* string is equivalent to a text schema with the same description.
|
|
282
|
+
*/
|
|
283
|
+
input_schema?: string | JsonSchema | TextSchema | null;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* Text description for a task input or output.
|
|
287
|
+
*/
|
|
288
|
+
export interface TextSchema {
|
|
289
|
+
/**
|
|
290
|
+
* A text description of the desired output from the task.
|
|
291
|
+
*/
|
|
292
|
+
description: string;
|
|
293
|
+
/**
|
|
294
|
+
* The type of schema being defined. Always `text`.
|
|
295
|
+
*/
|
|
296
|
+
type?: 'text';
|
|
297
|
+
}
|
|
298
|
+
export interface TaskRunCreateParams {
|
|
299
|
+
/**
|
|
300
|
+
* Input to the task, either text or a JSON object.
|
|
301
|
+
*/
|
|
302
|
+
input: string | {
|
|
303
|
+
[key: string]: unknown;
|
|
304
|
+
};
|
|
305
|
+
/**
|
|
306
|
+
* Processor to use for the task.
|
|
307
|
+
*/
|
|
308
|
+
processor: string;
|
|
309
|
+
/**
|
|
310
|
+
* User-provided metadata stored with the run. Keys and values must be strings with
|
|
311
|
+
* a maximum length of 16 and 512 characters respectively.
|
|
312
|
+
*/
|
|
313
|
+
metadata?: {
|
|
314
|
+
[key: string]: string | number | boolean;
|
|
315
|
+
} | null;
|
|
316
|
+
/**
|
|
317
|
+
* Source policy for web search results.
|
|
318
|
+
*
|
|
319
|
+
* This policy governs which sources are allowed/disallowed in results.
|
|
320
|
+
*/
|
|
321
|
+
source_policy?: Shared.SourcePolicy | null;
|
|
322
|
+
/**
|
|
323
|
+
* Specification for a task.
|
|
324
|
+
*
|
|
325
|
+
* Auto output schemas can be specified by setting `output_schema={"type":"auto"}`.
|
|
326
|
+
* Not specifying a TaskSpec is the same as setting an auto output schema.
|
|
327
|
+
*
|
|
328
|
+
* For convenience bare strings are also accepted as input or output schemas.
|
|
329
|
+
*/
|
|
330
|
+
task_spec?: TaskSpec | null;
|
|
331
|
+
}
|
|
332
|
+
export interface TaskRunResultParams {
|
|
333
|
+
timeout?: number;
|
|
334
|
+
}
|
|
335
|
+
export declare namespace TaskRun {
|
|
336
|
+
export { type AutoSchema as AutoSchema, type Citation as Citation, type FieldBasis as FieldBasis, type JsonSchema as JsonSchema, type RunInput as RunInput, type TaskRun as TaskRun, type TaskRunJsonOutput as TaskRunJsonOutput, type TaskRunResult as TaskRunResult, type TaskRunTextOutput as TaskRunTextOutput, type TaskSpec as TaskSpec, type TextSchema as TextSchema, type TaskRunCreateParams as TaskRunCreateParams, type TaskRunResultParams as TaskRunResultParams, };
|
|
337
|
+
}
|
|
338
|
+
//# sourceMappingURL=task-run.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"task-run.d.ts","sourceRoot":"","sources":["../src/resources/task-run.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAItE;;OAEG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;CAG7B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;IAE3C;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,iBAAiB,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAEzB;;;OAGG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEhD;;;OAGG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,iBAAiB,GAAG,iBAAiB,CAAC;IAE9C;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACjD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;OAKG;IACH,aAAa,EAAE,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;IAE7D;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;IAE3C;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.TaskRun = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class TaskRun extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Initiates a task run.
|
|
10
|
+
*
|
|
11
|
+
* Returns immediately with a run object in status 'queued'.
|
|
12
|
+
*
|
|
13
|
+
* Beta features can be enabled by setting the 'parallel-beta' header.
|
|
14
|
+
*/
|
|
15
|
+
create(body, options) {
|
|
16
|
+
return this._client.post('/v1/tasks/runs', { body, ...options });
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Retrieves run status by run_id.
|
|
20
|
+
*
|
|
21
|
+
* The run result is available from the `/result` endpoint.
|
|
22
|
+
*/
|
|
23
|
+
retrieve(runID, options) {
|
|
24
|
+
return this._client.get((0, path_1.path) `/v1/tasks/runs/${runID}`, options);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Retrieves a run result by run_id, blocking until the run is completed.
|
|
28
|
+
*/
|
|
29
|
+
result(runID, query = {}, options) {
|
|
30
|
+
return this._client.get((0, path_1.path) `/v1/tasks/runs/${runID}/result`, { query, ...options });
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
exports.TaskRun = TaskRun;
|
|
34
|
+
//# sourceMappingURL=task-run.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"task-run.js","sourceRoot":"","sources":["../src/resources/task-run.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAa,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,KAAK,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AA/BD,0BA+BC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class TaskRun extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Initiates a task run.
|
|
7
|
+
*
|
|
8
|
+
* Returns immediately with a run object in status 'queued'.
|
|
9
|
+
*
|
|
10
|
+
* Beta features can be enabled by setting the 'parallel-beta' header.
|
|
11
|
+
*/
|
|
12
|
+
create(body, options) {
|
|
13
|
+
return this._client.post('/v1/tasks/runs', { body, ...options });
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Retrieves run status by run_id.
|
|
17
|
+
*
|
|
18
|
+
* The run result is available from the `/result` endpoint.
|
|
19
|
+
*/
|
|
20
|
+
retrieve(runID, options) {
|
|
21
|
+
return this._client.get(path `/v1/tasks/runs/${runID}`, options);
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Retrieves a run result by run_id, blocking until the run is completed.
|
|
25
|
+
*/
|
|
26
|
+
result(runID, query = {}, options) {
|
|
27
|
+
return this._client.get(path `/v1/tasks/runs/${runID}/result`, { query, ...options });
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=task-run.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"task-run.mjs","sourceRoot":"","sources":["../src/resources/task-run.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAa,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,KAAa,EACb,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,KAAK,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF"}
|
package/resources.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.mts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|
package/resources.js
ADDED
package/resources.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.js","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":";;;AAAA,+DAAkC"}
|
package/resources.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
|