@mixedbread/sdk 0.1.0-alpha.8
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 +210 -0
- package/LICENSE +201 -0
- package/README.md +360 -0
- package/_shims/MultipartBody.d.ts +9 -0
- package/_shims/MultipartBody.d.ts.map +1 -0
- package/_shims/MultipartBody.js +16 -0
- package/_shims/MultipartBody.js.map +1 -0
- package/_shims/MultipartBody.mjs +12 -0
- package/_shims/MultipartBody.mjs.map +1 -0
- package/_shims/README.md +46 -0
- package/_shims/auto/runtime-bun.d.ts +5 -0
- package/_shims/auto/runtime-bun.d.ts.map +1 -0
- package/_shims/auto/runtime-bun.js +21 -0
- package/_shims/auto/runtime-bun.js.map +1 -0
- package/_shims/auto/runtime-bun.mjs +2 -0
- package/_shims/auto/runtime-bun.mjs.map +1 -0
- package/_shims/auto/runtime-node.d.ts +5 -0
- package/_shims/auto/runtime-node.d.ts.map +1 -0
- package/_shims/auto/runtime-node.js +21 -0
- package/_shims/auto/runtime-node.js.map +1 -0
- package/_shims/auto/runtime-node.mjs +2 -0
- package/_shims/auto/runtime-node.mjs.map +1 -0
- package/_shims/auto/runtime.d.ts +5 -0
- package/_shims/auto/runtime.d.ts.map +1 -0
- package/_shims/auto/runtime.js +21 -0
- package/_shims/auto/runtime.js.map +1 -0
- package/_shims/auto/runtime.mjs +2 -0
- package/_shims/auto/runtime.mjs.map +1 -0
- package/_shims/auto/types-node.d.ts +5 -0
- package/_shims/auto/types-node.d.ts.map +1 -0
- package/_shims/auto/types-node.js +21 -0
- package/_shims/auto/types-node.js.map +1 -0
- package/_shims/auto/types-node.mjs +2 -0
- package/_shims/auto/types-node.mjs.map +1 -0
- package/_shims/auto/types.d.ts +101 -0
- package/_shims/auto/types.js +3 -0
- package/_shims/auto/types.mjs +3 -0
- package/_shims/bun-runtime.d.ts +6 -0
- package/_shims/bun-runtime.d.ts.map +1 -0
- package/_shims/bun-runtime.js +14 -0
- package/_shims/bun-runtime.js.map +1 -0
- package/_shims/bun-runtime.mjs +10 -0
- package/_shims/bun-runtime.mjs.map +1 -0
- package/_shims/index.d.ts +81 -0
- package/_shims/index.js +13 -0
- package/_shims/index.mjs +7 -0
- package/_shims/manual-types.d.ts +12 -0
- package/_shims/manual-types.js +3 -0
- package/_shims/manual-types.mjs +3 -0
- package/_shims/node-runtime.d.ts +3 -0
- package/_shims/node-runtime.d.ts.map +1 -0
- package/_shims/node-runtime.js +89 -0
- package/_shims/node-runtime.js.map +1 -0
- package/_shims/node-runtime.mjs +56 -0
- package/_shims/node-runtime.mjs.map +1 -0
- package/_shims/node-types.d.ts +42 -0
- package/_shims/node-types.js +3 -0
- package/_shims/node-types.mjs +3 -0
- package/_shims/registry.d.ts +37 -0
- package/_shims/registry.d.ts.map +1 -0
- package/_shims/registry.js +41 -0
- package/_shims/registry.js.map +1 -0
- package/_shims/registry.mjs +37 -0
- package/_shims/registry.mjs.map +1 -0
- package/_shims/web-runtime.d.ts +5 -0
- package/_shims/web-runtime.d.ts.map +1 -0
- package/_shims/web-runtime.js +78 -0
- package/_shims/web-runtime.js.map +1 -0
- package/_shims/web-runtime.mjs +71 -0
- package/_shims/web-runtime.mjs.map +1 -0
- package/_shims/web-types.d.ts +83 -0
- package/_shims/web-types.js +3 -0
- package/_shims/web-types.mjs +3 -0
- package/core.d.ts +241 -0
- package/core.d.ts.map +1 -0
- package/core.js +914 -0
- package/core.js.map +1 -0
- package/core.mjs +882 -0
- package/core.mjs.map +1 -0
- package/error.d.ts +47 -0
- package/error.d.ts.map +1 -0
- package/error.js +113 -0
- package/error.js.map +1 -0
- package/error.mjs +97 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +148 -0
- package/index.d.ts +148 -0
- package/index.d.ts.map +1 -0
- package/index.js +151 -0
- package/index.js.map +1 -0
- package/index.mjs +108 -0
- package/index.mjs.map +1 -0
- package/lib/polling.d.ts +48 -0
- package/lib/polling.d.ts.map +1 -0
- package/lib/polling.js +75 -0
- package/lib/polling.js.map +1 -0
- package/lib/polling.mjs +71 -0
- package/lib/polling.mjs.map +1 -0
- package/package.json +124 -0
- package/pagination.d.ts +30 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +45 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +41 -0
- package/pagination.mjs.map +1 -0
- package/resource.d.ts +6 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +11 -0
- package/resource.js.map +1 -0
- package/resource.mjs +7 -0
- package/resource.mjs.map +1 -0
- package/resources/extractions/content.d.ts +35 -0
- package/resources/extractions/content.d.ts.map +1 -0
- package/resources/extractions/content.js +19 -0
- package/resources/extractions/content.js.map +1 -0
- package/resources/extractions/content.mjs +15 -0
- package/resources/extractions/content.mjs.map +1 -0
- package/resources/extractions/extractions.d.ts +18 -0
- package/resources/extractions/extractions.d.ts.map +1 -0
- package/resources/extractions/extractions.js +47 -0
- package/resources/extractions/extractions.js.map +1 -0
- package/resources/extractions/extractions.mjs +20 -0
- package/resources/extractions/extractions.mjs.map +1 -0
- package/resources/extractions/index.d.ts +5 -0
- package/resources/extractions/index.d.ts.map +1 -0
- package/resources/extractions/index.js +13 -0
- package/resources/extractions/index.js.map +1 -0
- package/resources/extractions/index.mjs +6 -0
- package/resources/extractions/index.mjs.map +1 -0
- package/resources/extractions/jobs.d.ts +44 -0
- package/resources/extractions/jobs.d.ts.map +1 -0
- package/resources/extractions/jobs.js +29 -0
- package/resources/extractions/jobs.js.map +1 -0
- package/resources/extractions/jobs.mjs +25 -0
- package/resources/extractions/jobs.mjs.map +1 -0
- package/resources/extractions/schema.d.ts +85 -0
- package/resources/extractions/schema.d.ts.map +1 -0
- package/resources/extractions/schema.js +39 -0
- package/resources/extractions/schema.js.map +1 -0
- package/resources/extractions/schema.mjs +35 -0
- package/resources/extractions/schema.mjs.map +1 -0
- package/resources/files.d.ts +125 -0
- package/resources/files.d.ts.map +1 -0
- package/resources/files.js +99 -0
- package/resources/files.js.map +1 -0
- package/resources/files.mjs +71 -0
- package/resources/files.mjs.map +1 -0
- package/resources/index.d.ts +7 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +30 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +7 -0
- package/resources/index.mjs.map +1 -0
- package/resources/parsing/index.d.ts +3 -0
- package/resources/parsing/index.d.ts.map +1 -0
- package/resources/parsing/index.js +10 -0
- package/resources/parsing/index.js.map +1 -0
- package/resources/parsing/index.mjs +4 -0
- package/resources/parsing/index.mjs.map +1 -0
- package/resources/parsing/jobs.d.ts +278 -0
- package/resources/parsing/jobs.d.ts.map +1 -0
- package/resources/parsing/jobs.js +147 -0
- package/resources/parsing/jobs.js.map +1 -0
- package/resources/parsing/jobs.mjs +119 -0
- package/resources/parsing/jobs.mjs.map +1 -0
- package/resources/parsing/parsing.d.ts +10 -0
- package/resources/parsing/parsing.d.ts.map +1 -0
- package/resources/parsing/parsing.js +40 -0
- package/resources/parsing/parsing.js.map +1 -0
- package/resources/parsing/parsing.mjs +13 -0
- package/resources/parsing/parsing.mjs.map +1 -0
- package/resources/shared.d.ts +35 -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/top-level.d.ts +11 -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/resources/vector-stores/files.d.ts +280 -0
- package/resources/vector-stores/files.d.ts.map +1 -0
- package/resources/vector-stores/files.js +167 -0
- package/resources/vector-stores/files.js.map +1 -0
- package/resources/vector-stores/files.mjs +139 -0
- package/resources/vector-stores/files.mjs.map +1 -0
- package/resources/vector-stores/index.d.ts +3 -0
- package/resources/vector-stores/index.d.ts.map +1 -0
- package/resources/vector-stores/index.js +11 -0
- package/resources/vector-stores/index.js.map +1 -0
- package/resources/vector-stores/index.mjs +4 -0
- package/resources/vector-stores/index.mjs.map +1 -0
- package/resources/vector-stores/vector-stores.d.ts +400 -0
- package/resources/vector-stores/vector-stores.d.ts.map +1 -0
- package/resources/vector-stores/vector-stores.js +121 -0
- package/resources/vector-stores/vector-stores.js.map +1 -0
- package/resources/vector-stores/vector-stores.mjs +93 -0
- package/resources/vector-stores/vector-stores.mjs.map +1 -0
- package/shims/node.d.ts +30 -0
- package/shims/node.d.ts.map +1 -0
- package/shims/node.js +31 -0
- package/shims/node.js.map +1 -0
- package/shims/node.mjs +5 -0
- package/shims/node.mjs.map +1 -0
- package/shims/web.d.ts +26 -0
- package/shims/web.d.ts.map +1 -0
- package/shims/web.js +31 -0
- package/shims/web.js.map +1 -0
- package/shims/web.mjs +5 -0
- package/shims/web.mjs.map +1 -0
- package/src/_shims/MultipartBody.ts +9 -0
- package/src/_shims/README.md +46 -0
- package/src/_shims/auto/runtime-bun.ts +4 -0
- package/src/_shims/auto/runtime-node.ts +4 -0
- package/src/_shims/auto/runtime.ts +4 -0
- package/src/_shims/auto/types-node.ts +4 -0
- package/src/_shims/auto/types.d.ts +101 -0
- package/src/_shims/auto/types.js +3 -0
- package/src/_shims/auto/types.mjs +3 -0
- package/src/_shims/bun-runtime.ts +14 -0
- package/src/_shims/index.d.ts +81 -0
- package/src/_shims/index.js +13 -0
- package/src/_shims/index.mjs +7 -0
- package/src/_shims/manual-types.d.ts +12 -0
- package/src/_shims/manual-types.js +3 -0
- package/src/_shims/manual-types.mjs +3 -0
- package/src/_shims/node-runtime.ts +81 -0
- package/src/_shims/node-types.d.ts +42 -0
- package/src/_shims/node-types.js +3 -0
- package/src/_shims/node-types.mjs +3 -0
- package/src/_shims/registry.ts +67 -0
- package/src/_shims/web-runtime.ts +103 -0
- package/src/_shims/web-types.d.ts +83 -0
- package/src/_shims/web-types.js +3 -0
- package/src/_shims/web-types.mjs +3 -0
- package/src/core.ts +1208 -0
- package/src/error.ts +130 -0
- package/src/index.ts +294 -0
- package/src/lib/.keep +4 -0
- package/src/lib/polling.ts +115 -0
- package/src/pagination.ts +82 -0
- package/src/resource.ts +11 -0
- package/src/resources/extractions/content.ts +43 -0
- package/src/resources/extractions/extractions.ts +47 -0
- package/src/resources/extractions/index.ts +14 -0
- package/src/resources/extractions/jobs.ts +55 -0
- package/src/resources/extractions/schema.ts +111 -0
- package/src/resources/files.ts +181 -0
- package/src/resources/index.ts +32 -0
- package/src/resources/parsing/index.ts +12 -0
- package/src/resources/parsing/jobs.ts +438 -0
- package/src/resources/parsing/parsing.ts +32 -0
- package/src/resources/shared.ts +41 -0
- package/src/resources/top-level.ts +14 -0
- package/src/resources/vector-stores/files.ts +434 -0
- package/src/resources/vector-stores/index.ts +30 -0
- package/src/resources/vector-stores/vector-stores.ts +561 -0
- package/src/shims/node.ts +50 -0
- package/src/shims/web.ts +50 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +255 -0
- package/src/version.ts +1 -0
- package/uploads.d.ts +75 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +171 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +158 -0
- package/uploads.mjs.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,278 @@
|
|
1
|
+
import { APIResource } from "../../resource.js";
|
2
|
+
import * as Core from "../../core.js";
|
3
|
+
import { LimitOffset, type LimitOffsetParams } from "../../pagination.js";
|
4
|
+
import { Uploadable } from "../../uploads.js";
|
5
|
+
export declare class Jobs extends APIResource {
|
6
|
+
/**
|
7
|
+
* Start a parse job for the provided file.
|
8
|
+
*
|
9
|
+
* Args: params: The parameters for creating a parse job.
|
10
|
+
*
|
11
|
+
* Returns: The created parsing job.
|
12
|
+
*/
|
13
|
+
create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<ParsingJob>;
|
14
|
+
/**
|
15
|
+
* Get detailed information about a specific parse job.
|
16
|
+
*
|
17
|
+
* Args: job_id: The ID of the parse job.
|
18
|
+
*
|
19
|
+
* Returns: Detailed information about the parse job.
|
20
|
+
*/
|
21
|
+
retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ParsingJob>;
|
22
|
+
/**
|
23
|
+
* List parsing jobs with pagination.
|
24
|
+
*
|
25
|
+
* Args: limit: The number of items to return. offset: The number of items to skip.
|
26
|
+
*
|
27
|
+
* Returns: List of parsing jobs with pagination.
|
28
|
+
*/
|
29
|
+
list(query?: JobListParams, options?: Core.RequestOptions): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse>;
|
30
|
+
list(options?: Core.RequestOptions): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse>;
|
31
|
+
/**
|
32
|
+
* Delete a specific parse job.
|
33
|
+
*
|
34
|
+
* Args: job_id: The ID of the parse job to delete.
|
35
|
+
*
|
36
|
+
* Returns: The deleted parsing job.
|
37
|
+
*/
|
38
|
+
delete(jobId: string, options?: Core.RequestOptions): Core.APIPromise<JobDeleteResponse>;
|
39
|
+
/**
|
40
|
+
* Cancel a specific parse job.
|
41
|
+
*
|
42
|
+
* Args: job_id: The ID of the parse job to cancel.
|
43
|
+
*
|
44
|
+
* Returns: The cancelled parsing job.
|
45
|
+
*/
|
46
|
+
cancel(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ParsingJob>;
|
47
|
+
/**
|
48
|
+
* Poll for a job's status until it reaches a terminal state.
|
49
|
+
*
|
50
|
+
* @param jobId - The ID of the job to poll
|
51
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
52
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
53
|
+
* @param options - Additional request options
|
54
|
+
* @returns The job object once it reaches a terminal state
|
55
|
+
*/
|
56
|
+
poll(jobId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?: Core.RequestOptions): Promise<ParsingJob>;
|
57
|
+
/**
|
58
|
+
* Create a parsing job and wait for it to complete.
|
59
|
+
*
|
60
|
+
* @param body - Parameters for creating a parse job
|
61
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
62
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
63
|
+
* @param options - Additional request options
|
64
|
+
* @returns The job object once it reaches a terminal state
|
65
|
+
*/
|
66
|
+
createAndPoll(body: JobCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?: Core.RequestOptions): Promise<ParsingJob>;
|
67
|
+
/**
|
68
|
+
* Upload a file to the files API and then create a parsing job for it.
|
69
|
+
* Note the job will be asynchronously processed.
|
70
|
+
*
|
71
|
+
* @param file - The file to upload
|
72
|
+
* @param body - Additional parameters for creating a parse job
|
73
|
+
* @param options - Additional request options
|
74
|
+
* @returns The created parsing job
|
75
|
+
*/
|
76
|
+
upload(file: Uploadable, body?: Omit<JobCreateParams, 'file_id'>, options?: Core.RequestOptions): Promise<ParsingJob>;
|
77
|
+
/**
|
78
|
+
* Upload a file and create a parsing job, then poll until processing is complete.
|
79
|
+
*
|
80
|
+
* @param file - The file to upload
|
81
|
+
* @param body - Additional parameters for creating a parse job
|
82
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
83
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
84
|
+
* @param options - Additional request options
|
85
|
+
* @returns The job object once it reaches a terminal state
|
86
|
+
*/
|
87
|
+
uploadAndPoll(file: Uploadable, body?: Omit<JobCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?: Core.RequestOptions): Promise<ParsingJob>;
|
88
|
+
}
|
89
|
+
export declare class JobListResponsesLimitOffset extends LimitOffset<JobListResponse> {
|
90
|
+
}
|
91
|
+
/**
|
92
|
+
* A job for parsing documents with its current state and result.
|
93
|
+
*/
|
94
|
+
export interface ParsingJob {
|
95
|
+
/**
|
96
|
+
* The ID of the job
|
97
|
+
*/
|
98
|
+
id: string;
|
99
|
+
/**
|
100
|
+
* The status of the job
|
101
|
+
*/
|
102
|
+
status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
|
103
|
+
/**
|
104
|
+
* The error of the job
|
105
|
+
*/
|
106
|
+
error?: unknown;
|
107
|
+
/**
|
108
|
+
* Result of document parsing operation.
|
109
|
+
*/
|
110
|
+
result?: ParsingJob.Result | null;
|
111
|
+
/**
|
112
|
+
* The started time of the job
|
113
|
+
*/
|
114
|
+
started_at?: string | null;
|
115
|
+
/**
|
116
|
+
* The finished time of the job
|
117
|
+
*/
|
118
|
+
finished_at?: string | null;
|
119
|
+
/**
|
120
|
+
* The creation time of the job
|
121
|
+
*/
|
122
|
+
created_at?: string;
|
123
|
+
/**
|
124
|
+
* The updated time of the job
|
125
|
+
*/
|
126
|
+
updated_at?: string | null;
|
127
|
+
/**
|
128
|
+
* The type of the object
|
129
|
+
*/
|
130
|
+
object?: 'parsing_job';
|
131
|
+
}
|
132
|
+
export declare namespace ParsingJob {
|
133
|
+
/**
|
134
|
+
* Result of document parsing operation.
|
135
|
+
*/
|
136
|
+
interface Result {
|
137
|
+
/**
|
138
|
+
* The strategy used for chunking the document
|
139
|
+
*/
|
140
|
+
chunking_strategy: 'page';
|
141
|
+
/**
|
142
|
+
* The format of the returned content
|
143
|
+
*/
|
144
|
+
return_format: 'html' | 'markdown' | 'plain';
|
145
|
+
/**
|
146
|
+
* The types of elements extracted
|
147
|
+
*/
|
148
|
+
element_types: Array<'caption' | 'footnote' | 'formula' | 'list-item' | 'page-footer' | 'page-header' | 'picture' | 'section-header' | 'table' | 'text' | 'title'>;
|
149
|
+
/**
|
150
|
+
* List of extracted chunks from the document
|
151
|
+
*/
|
152
|
+
chunks: Array<Result.Chunk>;
|
153
|
+
}
|
154
|
+
namespace Result {
|
155
|
+
/**
|
156
|
+
* A chunk of text extracted from a document page.
|
157
|
+
*/
|
158
|
+
interface Chunk {
|
159
|
+
/**
|
160
|
+
* The full content of the chunk
|
161
|
+
*/
|
162
|
+
content: string;
|
163
|
+
/**
|
164
|
+
* The content to be used for embedding
|
165
|
+
*/
|
166
|
+
content_to_embed: string;
|
167
|
+
/**
|
168
|
+
* List of elements contained in this chunk
|
169
|
+
*/
|
170
|
+
elements: Array<Chunk.Element>;
|
171
|
+
}
|
172
|
+
namespace Chunk {
|
173
|
+
/**
|
174
|
+
* Represents an extracted element from a document with its content and metadata.
|
175
|
+
*/
|
176
|
+
interface Element {
|
177
|
+
/**
|
178
|
+
* The type of the extracted element
|
179
|
+
*/
|
180
|
+
type: 'caption' | 'footnote' | 'formula' | 'list-item' | 'page-footer' | 'page-header' | 'picture' | 'section-header' | 'table' | 'text' | 'title';
|
181
|
+
/**
|
182
|
+
* The confidence score of the extraction
|
183
|
+
*/
|
184
|
+
confidence: number;
|
185
|
+
/**
|
186
|
+
* The bounding box coordinates [x1, y1, x2, y2]
|
187
|
+
*/
|
188
|
+
bbox: Array<unknown>;
|
189
|
+
/**
|
190
|
+
* The page number where the element was found
|
191
|
+
*/
|
192
|
+
page: number;
|
193
|
+
/**
|
194
|
+
* The full content of the extracted element
|
195
|
+
*/
|
196
|
+
content: string;
|
197
|
+
/**
|
198
|
+
* A brief summary of the element's content
|
199
|
+
*/
|
200
|
+
summary?: string | null;
|
201
|
+
}
|
202
|
+
}
|
203
|
+
}
|
204
|
+
}
|
205
|
+
/**
|
206
|
+
* A parsing job item for list responses, omitting result and error fields.
|
207
|
+
*/
|
208
|
+
export interface JobListResponse {
|
209
|
+
/**
|
210
|
+
* The ID of the job
|
211
|
+
*/
|
212
|
+
id: string;
|
213
|
+
/**
|
214
|
+
* The status of the job
|
215
|
+
*/
|
216
|
+
status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
|
217
|
+
/**
|
218
|
+
* The started time of the job
|
219
|
+
*/
|
220
|
+
started_at?: string | null;
|
221
|
+
/**
|
222
|
+
* The finished time of the job
|
223
|
+
*/
|
224
|
+
finished_at?: string | null;
|
225
|
+
/**
|
226
|
+
* The creation time of the job
|
227
|
+
*/
|
228
|
+
created_at?: string;
|
229
|
+
/**
|
230
|
+
* The updated time of the job
|
231
|
+
*/
|
232
|
+
updated_at?: string | null;
|
233
|
+
/**
|
234
|
+
* The type of the object
|
235
|
+
*/
|
236
|
+
object?: 'parsing_job';
|
237
|
+
}
|
238
|
+
/**
|
239
|
+
* A deleted parsing job.
|
240
|
+
*/
|
241
|
+
export interface JobDeleteResponse {
|
242
|
+
/**
|
243
|
+
* The ID of the deleted job
|
244
|
+
*/
|
245
|
+
id: string;
|
246
|
+
/**
|
247
|
+
* Whether the job was deleted
|
248
|
+
*/
|
249
|
+
deleted?: boolean;
|
250
|
+
/**
|
251
|
+
* The type of the object
|
252
|
+
*/
|
253
|
+
object?: 'parsing_job';
|
254
|
+
}
|
255
|
+
export interface JobCreateParams {
|
256
|
+
/**
|
257
|
+
* The ID of the file to parse
|
258
|
+
*/
|
259
|
+
file_id: string;
|
260
|
+
/**
|
261
|
+
* The elements to extract from the document
|
262
|
+
*/
|
263
|
+
element_types?: Array<'caption' | 'footnote' | 'formula' | 'list-item' | 'page-footer' | 'page-header' | 'picture' | 'section-header' | 'table' | 'text' | 'title'> | null;
|
264
|
+
/**
|
265
|
+
* The strategy to use for chunking the content
|
266
|
+
*/
|
267
|
+
chunking_strategy?: 'page';
|
268
|
+
/**
|
269
|
+
* The format of the returned content
|
270
|
+
*/
|
271
|
+
return_format?: 'html' | 'markdown' | 'plain';
|
272
|
+
}
|
273
|
+
export interface JobListParams extends LimitOffsetParams {
|
274
|
+
}
|
275
|
+
export declare namespace Jobs {
|
276
|
+
export { type ParsingJob as ParsingJob, type JobListResponse as JobListResponse, type JobDeleteResponse as JobDeleteResponse, JobListResponsesLimitOffset as JobListResponsesLimitOffset, type JobCreateParams as JobCreateParams, type JobListParams as JobListParams, };
|
277
|
+
}
|
278
|
+
//# sourceMappingURL=jobs.d.ts.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../src/resources/parsing/jobs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAIzF;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAInF;;;;;;OAMG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,eAAe,CAAC;IACjE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,eAAe,CAAC;IAWnG;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAIxF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAIjF;;;;;;;;OAQG;IACG,IAAI,CACR,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;IAatB;;;;;;;;OAQG;IACG,aAAa,CACjB,IAAI,EAAE,eAAe,EACrB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;IAKtB;;;;;;;;OAQG;IACG,MAAM,CACV,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,EACvC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;IAYtB;;;;;;;;;OASG;IACG,aAAa,CACjB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,EACvC,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;CAIvB;AAED,qBAAa,2BAA4B,SAAQ,WAAW,CAAC,eAAe,CAAC;CAAG;AAEhF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;QAE7C;;WAEG;QACH,aAAa,EAAE,KAAK,CAChB,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,aAAa,GACb,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,OAAO,CACV,CAAC;QAEF;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;KAC7B;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAChC;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,IAAI,EACA,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,aAAa,GACb,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,OAAO,CAAC;gBAEZ;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;gBAErB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,OAAO,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACzB;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEzE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CACjB,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,aAAa,GACb,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,OAAO,CACV,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;CAC/C;AAED,MAAM,WAAW,aAAc,SAAQ,iBAAiB;CAAG;AAI3D,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
@@ -0,0 +1,147 @@
|
|
1
|
+
"use strict";
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
4
|
+
if (k2 === undefined) k2 = k;
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
8
|
+
}
|
9
|
+
Object.defineProperty(o, k2, desc);
|
10
|
+
}) : (function(o, m, k, k2) {
|
11
|
+
if (k2 === undefined) k2 = k;
|
12
|
+
o[k2] = m[k];
|
13
|
+
}));
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
16
|
+
}) : function(o, v) {
|
17
|
+
o["default"] = v;
|
18
|
+
});
|
19
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
20
|
+
if (mod && mod.__esModule) return mod;
|
21
|
+
var result = {};
|
22
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
23
|
+
__setModuleDefault(result, mod);
|
24
|
+
return result;
|
25
|
+
};
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
27
|
+
exports.JobListResponsesLimitOffset = exports.Jobs = void 0;
|
28
|
+
const resource_1 = require("../../resource.js");
|
29
|
+
const core_1 = require("../../core.js");
|
30
|
+
const pagination_1 = require("../../pagination.js");
|
31
|
+
const polling = __importStar(require("../../lib/polling.js"));
|
32
|
+
class Jobs extends resource_1.APIResource {
|
33
|
+
/**
|
34
|
+
* Start a parse job for the provided file.
|
35
|
+
*
|
36
|
+
* Args: params: The parameters for creating a parse job.
|
37
|
+
*
|
38
|
+
* Returns: The created parsing job.
|
39
|
+
*/
|
40
|
+
create(body, options) {
|
41
|
+
return this._client.post('/v1/parsing/jobs', { body, ...options });
|
42
|
+
}
|
43
|
+
/**
|
44
|
+
* Get detailed information about a specific parse job.
|
45
|
+
*
|
46
|
+
* Args: job_id: The ID of the parse job.
|
47
|
+
*
|
48
|
+
* Returns: Detailed information about the parse job.
|
49
|
+
*/
|
50
|
+
retrieve(jobId, options) {
|
51
|
+
return this._client.get(`/v1/parsing/jobs/${jobId}`, options);
|
52
|
+
}
|
53
|
+
list(query = {}, options) {
|
54
|
+
if ((0, core_1.isRequestOptions)(query)) {
|
55
|
+
return this.list({}, query);
|
56
|
+
}
|
57
|
+
return this._client.getAPIList('/v1/parsing/jobs', JobListResponsesLimitOffset, { query, ...options });
|
58
|
+
}
|
59
|
+
/**
|
60
|
+
* Delete a specific parse job.
|
61
|
+
*
|
62
|
+
* Args: job_id: The ID of the parse job to delete.
|
63
|
+
*
|
64
|
+
* Returns: The deleted parsing job.
|
65
|
+
*/
|
66
|
+
delete(jobId, options) {
|
67
|
+
return this._client.delete(`/v1/parsing/jobs/${jobId}`, options);
|
68
|
+
}
|
69
|
+
/**
|
70
|
+
* Cancel a specific parse job.
|
71
|
+
*
|
72
|
+
* Args: job_id: The ID of the parse job to cancel.
|
73
|
+
*
|
74
|
+
* Returns: The cancelled parsing job.
|
75
|
+
*/
|
76
|
+
cancel(jobId, options) {
|
77
|
+
return this._client.patch(`/v1/parsing/jobs/${jobId}`, options);
|
78
|
+
}
|
79
|
+
/**
|
80
|
+
* Poll for a job's status until it reaches a terminal state.
|
81
|
+
*
|
82
|
+
* @param jobId - The ID of the job to poll
|
83
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
84
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
85
|
+
* @param options - Additional request options
|
86
|
+
* @returns The job object once it reaches a terminal state
|
87
|
+
*/
|
88
|
+
async poll(jobId, pollIntervalMs, pollTimeoutMs, options) {
|
89
|
+
const pollingIntervalMs = pollIntervalMs || 500;
|
90
|
+
const pollingTimeoutMs = pollTimeoutMs;
|
91
|
+
return polling.poll({
|
92
|
+
fn: () => this.retrieve(jobId, options),
|
93
|
+
condition: (result) => result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
|
94
|
+
intervalSeconds: pollingIntervalMs / 1000,
|
95
|
+
...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
|
96
|
+
});
|
97
|
+
}
|
98
|
+
/**
|
99
|
+
* Create a parsing job and wait for it to complete.
|
100
|
+
*
|
101
|
+
* @param body - Parameters for creating a parse job
|
102
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
103
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
104
|
+
* @param options - Additional request options
|
105
|
+
* @returns The job object once it reaches a terminal state
|
106
|
+
*/
|
107
|
+
async createAndPoll(body, pollIntervalMs, pollTimeoutMs, options) {
|
108
|
+
const job = await this.create(body, options);
|
109
|
+
return this.poll(job.id, pollIntervalMs, pollTimeoutMs, options);
|
110
|
+
}
|
111
|
+
/**
|
112
|
+
* Upload a file to the files API and then create a parsing job for it.
|
113
|
+
* Note the job will be asynchronously processed.
|
114
|
+
*
|
115
|
+
* @param file - The file to upload
|
116
|
+
* @param body - Additional parameters for creating a parse job
|
117
|
+
* @param options - Additional request options
|
118
|
+
* @returns The created parsing job
|
119
|
+
*/
|
120
|
+
async upload(file, body, options) {
|
121
|
+
const fileUploadResponse = await this._client.files.create({ file }, options);
|
122
|
+
return this.create({
|
123
|
+
file_id: fileUploadResponse.id,
|
124
|
+
...body,
|
125
|
+
}, options);
|
126
|
+
}
|
127
|
+
/**
|
128
|
+
* Upload a file and create a parsing job, then poll until processing is complete.
|
129
|
+
*
|
130
|
+
* @param file - The file to upload
|
131
|
+
* @param body - Additional parameters for creating a parse job
|
132
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
133
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
134
|
+
* @param options - Additional request options
|
135
|
+
* @returns The job object once it reaches a terminal state
|
136
|
+
*/
|
137
|
+
async uploadAndPoll(file, body, pollIntervalMs, pollTimeoutMs, options) {
|
138
|
+
const job = await this.upload(file, body, options);
|
139
|
+
return this.poll(job.id, pollIntervalMs, pollTimeoutMs, options);
|
140
|
+
}
|
141
|
+
}
|
142
|
+
exports.Jobs = Jobs;
|
143
|
+
class JobListResponsesLimitOffset extends pagination_1.LimitOffset {
|
144
|
+
}
|
145
|
+
exports.JobListResponsesLimitOffset = JobListResponsesLimitOffset;
|
146
|
+
Jobs.JobListResponsesLimitOffset = JobListResponsesLimitOffset;
|
147
|
+
//# sourceMappingURL=jobs.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../src/resources/parsing/jobs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAuE;AACvE,8DAA6C;AAG7C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;OAMG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAcD,IAAI,CACF,QAA6C,EAAE,EAC/C,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,oBAAoB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CACR,KAAa,EACb,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,iBAAiB,GAAG,cAAc,IAAI,GAAG,CAAC;QAChD,MAAM,gBAAgB,GAAG,aAAa,CAAC;QAEvC,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;YACvC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;YAC9F,eAAe,EAAE,iBAAiB,GAAG,IAAI;YACzC,GAAG,CAAC,gBAAgB,IAAI,EAAE,cAAc,EAAE,gBAAgB,GAAG,IAAI,EAAE,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CACjB,IAAqB,EACrB,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,IAAgB,EAChB,IAAuC,EACvC,OAA6B;QAE7B,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,MAAM,CAChB;YACE,OAAO,EAAE,kBAAkB,CAAC,EAAE;YAC9B,GAAG,IAAI;SACR,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,IAAgB,EAChB,IAAuC,EACvC,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA9JD,oBA8JC;AAED,MAAa,2BAA4B,SAAQ,wBAA4B;CAAG;AAAhF,kEAAgF;AAiQhF,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
|
@@ -0,0 +1,119 @@
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
2
|
+
import { APIResource } from "../../resource.mjs";
|
3
|
+
import { isRequestOptions } from "../../core.mjs";
|
4
|
+
import { LimitOffset } from "../../pagination.mjs";
|
5
|
+
import * as polling from "../../lib/polling.mjs";
|
6
|
+
export class Jobs extends APIResource {
|
7
|
+
/**
|
8
|
+
* Start a parse job for the provided file.
|
9
|
+
*
|
10
|
+
* Args: params: The parameters for creating a parse job.
|
11
|
+
*
|
12
|
+
* Returns: The created parsing job.
|
13
|
+
*/
|
14
|
+
create(body, options) {
|
15
|
+
return this._client.post('/v1/parsing/jobs', { body, ...options });
|
16
|
+
}
|
17
|
+
/**
|
18
|
+
* Get detailed information about a specific parse job.
|
19
|
+
*
|
20
|
+
* Args: job_id: The ID of the parse job.
|
21
|
+
*
|
22
|
+
* Returns: Detailed information about the parse job.
|
23
|
+
*/
|
24
|
+
retrieve(jobId, options) {
|
25
|
+
return this._client.get(`/v1/parsing/jobs/${jobId}`, options);
|
26
|
+
}
|
27
|
+
list(query = {}, options) {
|
28
|
+
if (isRequestOptions(query)) {
|
29
|
+
return this.list({}, query);
|
30
|
+
}
|
31
|
+
return this._client.getAPIList('/v1/parsing/jobs', JobListResponsesLimitOffset, { query, ...options });
|
32
|
+
}
|
33
|
+
/**
|
34
|
+
* Delete a specific parse job.
|
35
|
+
*
|
36
|
+
* Args: job_id: The ID of the parse job to delete.
|
37
|
+
*
|
38
|
+
* Returns: The deleted parsing job.
|
39
|
+
*/
|
40
|
+
delete(jobId, options) {
|
41
|
+
return this._client.delete(`/v1/parsing/jobs/${jobId}`, options);
|
42
|
+
}
|
43
|
+
/**
|
44
|
+
* Cancel a specific parse job.
|
45
|
+
*
|
46
|
+
* Args: job_id: The ID of the parse job to cancel.
|
47
|
+
*
|
48
|
+
* Returns: The cancelled parsing job.
|
49
|
+
*/
|
50
|
+
cancel(jobId, options) {
|
51
|
+
return this._client.patch(`/v1/parsing/jobs/${jobId}`, options);
|
52
|
+
}
|
53
|
+
/**
|
54
|
+
* Poll for a job's status until it reaches a terminal state.
|
55
|
+
*
|
56
|
+
* @param jobId - The ID of the job to poll
|
57
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
58
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
59
|
+
* @param options - Additional request options
|
60
|
+
* @returns The job object once it reaches a terminal state
|
61
|
+
*/
|
62
|
+
async poll(jobId, pollIntervalMs, pollTimeoutMs, options) {
|
63
|
+
const pollingIntervalMs = pollIntervalMs || 500;
|
64
|
+
const pollingTimeoutMs = pollTimeoutMs;
|
65
|
+
return polling.poll({
|
66
|
+
fn: () => this.retrieve(jobId, options),
|
67
|
+
condition: (result) => result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
|
68
|
+
intervalSeconds: pollingIntervalMs / 1000,
|
69
|
+
...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
|
70
|
+
});
|
71
|
+
}
|
72
|
+
/**
|
73
|
+
* Create a parsing job and wait for it to complete.
|
74
|
+
*
|
75
|
+
* @param body - Parameters for creating a parse job
|
76
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
77
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
78
|
+
* @param options - Additional request options
|
79
|
+
* @returns The job object once it reaches a terminal state
|
80
|
+
*/
|
81
|
+
async createAndPoll(body, pollIntervalMs, pollTimeoutMs, options) {
|
82
|
+
const job = await this.create(body, options);
|
83
|
+
return this.poll(job.id, pollIntervalMs, pollTimeoutMs, options);
|
84
|
+
}
|
85
|
+
/**
|
86
|
+
* Upload a file to the files API and then create a parsing job for it.
|
87
|
+
* Note the job will be asynchronously processed.
|
88
|
+
*
|
89
|
+
* @param file - The file to upload
|
90
|
+
* @param body - Additional parameters for creating a parse job
|
91
|
+
* @param options - Additional request options
|
92
|
+
* @returns The created parsing job
|
93
|
+
*/
|
94
|
+
async upload(file, body, options) {
|
95
|
+
const fileUploadResponse = await this._client.files.create({ file }, options);
|
96
|
+
return this.create({
|
97
|
+
file_id: fileUploadResponse.id,
|
98
|
+
...body,
|
99
|
+
}, options);
|
100
|
+
}
|
101
|
+
/**
|
102
|
+
* Upload a file and create a parsing job, then poll until processing is complete.
|
103
|
+
*
|
104
|
+
* @param file - The file to upload
|
105
|
+
* @param body - Additional parameters for creating a parse job
|
106
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
107
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
108
|
+
* @param options - Additional request options
|
109
|
+
* @returns The job object once it reaches a terminal state
|
110
|
+
*/
|
111
|
+
async uploadAndPoll(file, body, pollIntervalMs, pollTimeoutMs, options) {
|
112
|
+
const job = await this.upload(file, body, options);
|
113
|
+
return this.poll(job.id, pollIntervalMs, pollTimeoutMs, options);
|
114
|
+
}
|
115
|
+
}
|
116
|
+
export class JobListResponsesLimitOffset extends LimitOffset {
|
117
|
+
}
|
118
|
+
Jobs.JobListResponsesLimitOffset = JobListResponsesLimitOffset;
|
119
|
+
//# sourceMappingURL=jobs.mjs.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"jobs.mjs","sourceRoot":"","sources":["../../src/resources/parsing/jobs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,WAAW,EAA0B;OACvC,KAAK,OAAO;AAGnB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;OAMG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAcD,IAAI,CACF,QAA6C,EAAE,EAC/C,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,oBAAoB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CACR,KAAa,EACb,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,iBAAiB,GAAG,cAAc,IAAI,GAAG,CAAC;QAChD,MAAM,gBAAgB,GAAG,aAAa,CAAC;QAEvC,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;YACvC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;YAC9F,eAAe,EAAE,iBAAiB,GAAG,IAAI;YACzC,GAAG,CAAC,gBAAgB,IAAI,EAAE,cAAc,EAAE,gBAAgB,GAAG,IAAI,EAAE,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CACjB,IAAqB,EACrB,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,IAAgB,EAChB,IAAuC,EACvC,OAA6B;QAE7B,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,MAAM,CAChB;YACE,OAAO,EAAE,kBAAkB,CAAC,EAAE;YAC9B,GAAG,IAAI;SACR,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,IAAgB,EAChB,IAAuC,EACvC,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,WAA4B;CAAG;AAiQhF,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
|
@@ -0,0 +1,10 @@
|
|
1
|
+
import { APIResource } from "../../resource.js";
|
2
|
+
import * as JobsAPI from "./jobs.js";
|
3
|
+
import { JobCreateParams, JobDeleteResponse, JobListParams, JobListResponse, JobListResponsesLimitOffset, Jobs, ParsingJob } from "./jobs.js";
|
4
|
+
export declare class Parsing extends APIResource {
|
5
|
+
jobs: JobsAPI.Jobs;
|
6
|
+
}
|
7
|
+
export declare namespace Parsing {
|
8
|
+
export { Jobs as Jobs, type ParsingJob as ParsingJob, type JobListResponse as JobListResponse, type JobDeleteResponse as JobDeleteResponse, JobListResponsesLimitOffset as JobListResponsesLimitOffset, type JobCreateParams as JobCreateParams, type JobListParams as JobListParams, };
|
9
|
+
}
|
10
|
+
//# sourceMappingURL=parsing.d.ts.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"parsing.d.ts","sourceRoot":"","sources":["../../src/resources/parsing/parsing.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,2BAA2B,EAC3B,IAAI,EACJ,UAAU,EACX,MAAM,QAAQ,CAAC;AAEhB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;CACrD;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
@@ -0,0 +1,40 @@
|
|
1
|
+
"use strict";
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
4
|
+
if (k2 === undefined) k2 = k;
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
8
|
+
}
|
9
|
+
Object.defineProperty(o, k2, desc);
|
10
|
+
}) : (function(o, m, k, k2) {
|
11
|
+
if (k2 === undefined) k2 = k;
|
12
|
+
o[k2] = m[k];
|
13
|
+
}));
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
16
|
+
}) : function(o, v) {
|
17
|
+
o["default"] = v;
|
18
|
+
});
|
19
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
20
|
+
if (mod && mod.__esModule) return mod;
|
21
|
+
var result = {};
|
22
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
23
|
+
__setModuleDefault(result, mod);
|
24
|
+
return result;
|
25
|
+
};
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
27
|
+
exports.Parsing = void 0;
|
28
|
+
const resource_1 = require("../../resource.js");
|
29
|
+
const JobsAPI = __importStar(require("./jobs.js"));
|
30
|
+
const jobs_1 = require("./jobs.js");
|
31
|
+
class Parsing extends resource_1.APIResource {
|
32
|
+
constructor() {
|
33
|
+
super(...arguments);
|
34
|
+
this.jobs = new JobsAPI.Jobs(this._client);
|
35
|
+
}
|
36
|
+
}
|
37
|
+
exports.Parsing = Parsing;
|
38
|
+
Parsing.Jobs = jobs_1.Jobs;
|
39
|
+
Parsing.JobListResponsesLimitOffset = jobs_1.JobListResponsesLimitOffset;
|
40
|
+
//# sourceMappingURL=parsing.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"parsing.js","sourceRoot":"","sources":["../../src/resources/parsing/parsing.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,mDAAkC;AAClC,oCAQgB;AAEhB,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAFD,0BAEC;AAED,OAAO,CAAC,IAAI,GAAG,WAAI,CAAC;AACpB,OAAO,CAAC,2BAA2B,GAAG,kCAA2B,CAAC"}
|
@@ -0,0 +1,13 @@
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
2
|
+
import { APIResource } from "../../resource.mjs";
|
3
|
+
import * as JobsAPI from "./jobs.mjs";
|
4
|
+
import { JobListResponsesLimitOffset, Jobs, } from "./jobs.mjs";
|
5
|
+
export class Parsing extends APIResource {
|
6
|
+
constructor() {
|
7
|
+
super(...arguments);
|
8
|
+
this.jobs = new JobsAPI.Jobs(this._client);
|
9
|
+
}
|
10
|
+
}
|
11
|
+
Parsing.Jobs = Jobs;
|
12
|
+
Parsing.JobListResponsesLimitOffset = JobListResponsesLimitOffset;
|
13
|
+
//# sourceMappingURL=parsing.mjs.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"parsing.mjs","sourceRoot":"","sources":["../../src/resources/parsing/parsing.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EAKL,2BAA2B,EAC3B,IAAI,GAEL;AAED,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAED,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;AACpB,OAAO,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
|