@llamaindex/llama-cloud 2.9.0 → 2.10.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 +14 -0
- package/client.d.mts +11 -8
- package/client.d.mts.map +1 -1
- package/client.d.ts +11 -8
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/batches.d.mts +4 -4
- package/resources/batches.d.mts.map +1 -1
- package/resources/batches.d.ts +4 -4
- package/resources/batches.d.ts.map +1 -1
- package/resources/beta/agent-data.d.mts +94 -94
- package/resources/beta/agent-data.d.mts.map +1 -1
- package/resources/beta/agent-data.d.ts +94 -94
- package/resources/beta/agent-data.d.ts.map +1 -1
- package/resources/beta/agent-data.js +41 -41
- package/resources/beta/agent-data.js.map +1 -1
- package/resources/beta/agent-data.mjs +41 -41
- package/resources/beta/agent-data.mjs.map +1 -1
- package/resources/beta/batch/batch.d.mts +36 -29
- package/resources/beta/batch/batch.d.mts.map +1 -1
- package/resources/beta/batch/batch.d.ts +36 -29
- package/resources/beta/batch/batch.d.ts.map +1 -1
- package/resources/beta/batch/batch.js +16 -16
- package/resources/beta/batch/batch.js.map +1 -1
- package/resources/beta/batch/batch.mjs +16 -16
- package/resources/beta/batch/batch.mjs.map +1 -1
- package/resources/beta/batch/index.d.mts +1 -1
- package/resources/beta/batch/index.d.mts.map +1 -1
- package/resources/beta/batch/index.d.ts +1 -1
- package/resources/beta/batch/index.d.ts.map +1 -1
- package/resources/beta/batch/job-items.d.mts +14 -7
- package/resources/beta/batch/job-items.d.mts.map +1 -1
- package/resources/beta/batch/job-items.d.ts +14 -7
- package/resources/beta/batch/job-items.d.ts.map +1 -1
- package/resources/beta/beta.d.mts +6 -6
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +6 -6
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/chat.d.mts +39 -39
- package/resources/beta/chat.d.mts.map +1 -1
- package/resources/beta/chat.d.ts +39 -39
- package/resources/beta/chat.d.ts.map +1 -1
- package/resources/beta/chat.js +14 -14
- package/resources/beta/chat.js.map +1 -1
- package/resources/beta/chat.mjs +14 -14
- package/resources/beta/chat.mjs.map +1 -1
- package/resources/beta/directories/directories.d.mts +48 -39
- package/resources/beta/directories/directories.d.mts.map +1 -1
- package/resources/beta/directories/directories.d.ts +48 -39
- package/resources/beta/directories/directories.d.ts.map +1 -1
- package/resources/beta/directories/directories.js +30 -30
- package/resources/beta/directories/directories.js.map +1 -1
- package/resources/beta/directories/directories.mjs +30 -30
- package/resources/beta/directories/directories.mjs.map +1 -1
- package/resources/beta/directories/files.d.mts +47 -47
- package/resources/beta/directories/files.d.mts.map +1 -1
- package/resources/beta/directories/files.d.ts +47 -47
- package/resources/beta/directories/files.d.ts.map +1 -1
- package/resources/beta/directories/files.js +32 -32
- package/resources/beta/directories/files.js.map +1 -1
- package/resources/beta/directories/files.mjs +32 -32
- package/resources/beta/directories/files.mjs.map +1 -1
- package/resources/beta/directories/index.d.mts +2 -2
- package/resources/beta/directories/index.d.mts.map +1 -1
- package/resources/beta/directories/index.d.ts +2 -2
- package/resources/beta/directories/index.d.ts.map +1 -1
- package/resources/beta/index.d.mts +6 -6
- package/resources/beta/index.d.mts.map +1 -1
- package/resources/beta/index.d.ts +6 -6
- package/resources/beta/index.d.ts.map +1 -1
- package/resources/beta/indexes.d.mts +44 -32
- package/resources/beta/indexes.d.mts.map +1 -1
- package/resources/beta/indexes.d.ts +44 -32
- package/resources/beta/indexes.d.ts.map +1 -1
- package/resources/beta/indexes.js +28 -28
- package/resources/beta/indexes.js.map +1 -1
- package/resources/beta/indexes.mjs +28 -28
- package/resources/beta/indexes.mjs.map +1 -1
- package/resources/beta/retrieval.d.mts +3 -3
- package/resources/beta/retrieval.d.mts.map +1 -1
- package/resources/beta/retrieval.d.ts +3 -3
- package/resources/beta/retrieval.d.ts.map +1 -1
- package/resources/beta/sheets.d.mts +37 -56
- package/resources/beta/sheets.d.mts.map +1 -1
- package/resources/beta/sheets.d.ts +37 -56
- package/resources/beta/sheets.d.ts.map +1 -1
- package/resources/beta/sheets.js +19 -52
- package/resources/beta/sheets.js.map +1 -1
- package/resources/beta/sheets.mjs +19 -52
- package/resources/beta/sheets.mjs.map +1 -1
- package/resources/beta/split.d.mts +2 -2
- package/resources/beta/split.d.mts.map +1 -1
- package/resources/beta/split.d.ts +2 -2
- package/resources/beta/split.d.ts.map +1 -1
- package/resources/classifier/jobs.d.mts +8 -1
- package/resources/classifier/jobs.d.mts.map +1 -1
- package/resources/classifier/jobs.d.ts +8 -1
- package/resources/classifier/jobs.d.ts.map +1 -1
- package/resources/classify.d.mts +27 -11
- package/resources/classify.d.mts.map +1 -1
- package/resources/classify.d.ts +27 -11
- package/resources/classify.d.ts.map +1 -1
- package/resources/configurations.d.mts +73 -43
- package/resources/configurations.d.mts.map +1 -1
- package/resources/configurations.d.ts +73 -43
- package/resources/configurations.d.ts.map +1 -1
- package/resources/configurations.js +9 -9
- package/resources/configurations.js.map +1 -1
- package/resources/configurations.mjs +9 -9
- package/resources/configurations.mjs.map +1 -1
- package/resources/data-sinks.d.mts +16 -16
- package/resources/data-sinks.d.mts.map +1 -1
- package/resources/data-sinks.d.ts +16 -16
- package/resources/data-sinks.d.ts.map +1 -1
- package/resources/data-sinks.js +12 -12
- package/resources/data-sinks.js.map +1 -1
- package/resources/data-sinks.mjs +12 -12
- package/resources/data-sinks.mjs.map +1 -1
- package/resources/data-sources.d.mts +17 -17
- package/resources/data-sources.d.mts.map +1 -1
- package/resources/data-sources.d.ts +17 -17
- package/resources/data-sources.d.ts.map +1 -1
- package/resources/data-sources.js +13 -13
- package/resources/data-sources.js.map +1 -1
- package/resources/data-sources.mjs +13 -13
- package/resources/data-sources.mjs.map +1 -1
- package/resources/extract.d.mts +62 -46
- package/resources/extract.d.mts.map +1 -1
- package/resources/extract.d.ts +62 -46
- package/resources/extract.d.ts.map +1 -1
- package/resources/extract.js +33 -33
- package/resources/extract.js.map +1 -1
- package/resources/extract.mjs +33 -33
- package/resources/extract.mjs.map +1 -1
- package/resources/files.d.mts +41 -41
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +41 -41
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +13 -13
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +13 -13
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.mts +9 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +9 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/parsing.d.mts +131 -51
- package/resources/parsing.d.mts.map +1 -1
- package/resources/parsing.d.ts +131 -51
- package/resources/parsing.d.ts.map +1 -1
- package/resources/parsing.js +33 -12
- package/resources/parsing.js.map +1 -1
- package/resources/parsing.mjs +33 -12
- package/resources/parsing.mjs.map +1 -1
- package/resources/pipelines/data-sources.d.mts +40 -30
- package/resources/pipelines/data-sources.d.mts.map +1 -1
- package/resources/pipelines/data-sources.d.ts +40 -30
- package/resources/pipelines/data-sources.d.ts.map +1 -1
- package/resources/pipelines/data-sources.js +23 -13
- package/resources/pipelines/data-sources.js.map +1 -1
- package/resources/pipelines/data-sources.mjs +23 -13
- package/resources/pipelines/data-sources.mjs.map +1 -1
- package/resources/pipelines/documents.d.mts +28 -12
- package/resources/pipelines/documents.d.mts.map +1 -1
- package/resources/pipelines/documents.d.ts +28 -12
- package/resources/pipelines/documents.d.ts.map +1 -1
- package/resources/pipelines/documents.js +30 -14
- package/resources/pipelines/documents.js.map +1 -1
- package/resources/pipelines/documents.mjs +30 -14
- package/resources/pipelines/documents.mjs.map +1 -1
- package/resources/pipelines/files.d.mts +34 -24
- package/resources/pipelines/files.d.mts.map +1 -1
- package/resources/pipelines/files.d.ts +34 -24
- package/resources/pipelines/files.d.ts.map +1 -1
- package/resources/pipelines/files.js +27 -17
- package/resources/pipelines/files.js.map +1 -1
- package/resources/pipelines/files.mjs +27 -17
- package/resources/pipelines/files.mjs.map +1 -1
- package/resources/pipelines/images.d.mts +17 -17
- package/resources/pipelines/images.d.mts.map +1 -1
- package/resources/pipelines/images.d.ts +17 -17
- package/resources/pipelines/images.d.ts.map +1 -1
- package/resources/pipelines/images.js +13 -13
- package/resources/pipelines/images.js.map +1 -1
- package/resources/pipelines/images.mjs +13 -13
- package/resources/pipelines/images.mjs.map +1 -1
- package/resources/pipelines/index.d.mts +5 -5
- package/resources/pipelines/index.d.mts.map +1 -1
- package/resources/pipelines/index.d.ts +5 -5
- package/resources/pipelines/index.d.ts.map +1 -1
- package/resources/pipelines/metadata.d.mts +4 -0
- package/resources/pipelines/metadata.d.mts.map +1 -1
- package/resources/pipelines/metadata.d.ts +4 -0
- package/resources/pipelines/metadata.d.ts.map +1 -1
- package/resources/pipelines/metadata.js +4 -0
- package/resources/pipelines/metadata.js.map +1 -1
- package/resources/pipelines/metadata.mjs +4 -0
- package/resources/pipelines/metadata.mjs.map +1 -1
- package/resources/pipelines/pipelines.d.mts +149 -126
- package/resources/pipelines/pipelines.d.mts.map +1 -1
- package/resources/pipelines/pipelines.d.ts +149 -126
- package/resources/pipelines/pipelines.d.ts.map +1 -1
- package/resources/pipelines/pipelines.js +39 -23
- package/resources/pipelines/pipelines.js.map +1 -1
- package/resources/pipelines/pipelines.mjs +39 -23
- package/resources/pipelines/pipelines.mjs.map +1 -1
- package/resources/pipelines/sync.d.mts +4 -0
- package/resources/pipelines/sync.d.mts.map +1 -1
- package/resources/pipelines/sync.d.ts +4 -0
- package/resources/pipelines/sync.d.ts.map +1 -1
- package/resources/pipelines/sync.js +4 -0
- package/resources/pipelines/sync.js.map +1 -1
- package/resources/pipelines/sync.mjs +4 -0
- package/resources/pipelines/sync.mjs.map +1 -1
- package/resources/retrievers/index.d.mts +1 -1
- package/resources/retrievers/index.d.mts.map +1 -1
- package/resources/retrievers/index.d.ts +1 -1
- package/resources/retrievers/index.d.ts.map +1 -1
- package/resources/retrievers/retrievers.d.mts +39 -39
- package/resources/retrievers/retrievers.d.mts.map +1 -1
- package/resources/retrievers/retrievers.d.ts +39 -39
- package/resources/retrievers/retrievers.d.ts.map +1 -1
- package/resources/retrievers/retrievers.js +20 -20
- package/resources/retrievers/retrievers.js.map +1 -1
- package/resources/retrievers/retrievers.mjs +20 -20
- package/resources/retrievers/retrievers.mjs.map +1 -1
- package/resources/shared.d.mts +11 -3
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +11 -3
- package/resources/shared.d.ts.map +1 -1
- package/resources/sheets.d.mts +206 -0
- package/resources/sheets.d.mts.map +1 -0
- package/resources/sheets.d.ts +206 -0
- package/resources/sheets.d.ts.map +1 -0
- package/resources/sheets.js +101 -0
- package/resources/sheets.js.map +1 -0
- package/resources/sheets.mjs +97 -0
- package/resources/sheets.mjs.map +1 -0
- package/src/client.ts +33 -12
- package/src/resources/batches.ts +4 -4
- package/src/resources/beta/agent-data.ts +131 -131
- package/src/resources/beta/batch/batch.ts +67 -54
- package/src/resources/beta/batch/index.ts +1 -1
- package/src/resources/beta/batch/job-items.ts +34 -21
- package/src/resources/beta/beta.ts +12 -12
- package/src/resources/beta/chat.ts +57 -57
- package/src/resources/beta/directories/directories.ts +80 -71
- package/src/resources/beta/directories/files.ts +66 -66
- package/src/resources/beta/directories/index.ts +5 -5
- package/src/resources/beta/index.ts +12 -12
- package/src/resources/beta/indexes.ts +68 -53
- package/src/resources/beta/retrieval.ts +3 -3
- package/src/resources/beta/sheets.ts +90 -97
- package/src/resources/beta/split.ts +2 -2
- package/src/resources/classifier/jobs.ts +9 -1
- package/src/resources/classify.ts +67 -39
- package/src/resources/configurations.ts +97 -63
- package/src/resources/data-sinks.ts +26 -26
- package/src/resources/data-sources.ts +43 -43
- package/src/resources/extract.ts +125 -97
- package/src/resources/files.ts +61 -61
- package/src/resources/index.ts +21 -12
- package/src/resources/parsing.ts +285 -204
- package/src/resources/pipelines/data-sources.ts +59 -49
- package/src/resources/pipelines/documents.ts +42 -26
- package/src/resources/pipelines/files.ts +62 -52
- package/src/resources/pipelines/images.ts +36 -36
- package/src/resources/pipelines/index.ts +10 -10
- package/src/resources/pipelines/metadata.ts +4 -0
- package/src/resources/pipelines/pipelines.ts +236 -207
- package/src/resources/pipelines/sync.ts +4 -0
- package/src/resources/retrievers/index.ts +3 -3
- package/src/resources/retrievers/retrievers.ts +64 -64
- package/src/resources/shared.ts +12 -3
- package/src/resources/sheets.ts +322 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
package/src/resources/parsing.ts
CHANGED
|
@@ -27,6 +27,14 @@ export class Parsing extends APIResource {
|
|
|
27
27
|
*
|
|
28
28
|
* The job runs asynchronously. Poll `GET /parse/{job_id}` with `expand=text` or
|
|
29
29
|
* `expand=markdown` to retrieve results.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const parsing = await client.parsing.create({
|
|
34
|
+
* tier: 'fast',
|
|
35
|
+
* version: 'latest',
|
|
36
|
+
* });
|
|
37
|
+
* ```
|
|
30
38
|
*/
|
|
31
39
|
create(
|
|
32
40
|
params: ParsingCreateParams & { upload_file?: Uploadable },
|
|
@@ -56,22 +64,6 @@ export class Parsing extends APIResource {
|
|
|
56
64
|
return this._client.post('/api/v2/parse', { query: { organization_id, project_id }, body, ...options });
|
|
57
65
|
}
|
|
58
66
|
|
|
59
|
-
/**
|
|
60
|
-
* List parse jobs for the current project.
|
|
61
|
-
*
|
|
62
|
-
* Filter by `status` or creation date range. Results are paginated — use
|
|
63
|
-
* `page_token` from the response to fetch subsequent pages.
|
|
64
|
-
*/
|
|
65
|
-
list(
|
|
66
|
-
query: ParsingListParams | null | undefined = {},
|
|
67
|
-
options?: RequestOptions,
|
|
68
|
-
): PagePromise<ParsingListResponsesPaginatedCursor, ParsingListResponse> {
|
|
69
|
-
return this._client.getAPIList('/api/v2/parse', PaginatedCursor<ParsingListResponse>, {
|
|
70
|
-
query,
|
|
71
|
-
...options,
|
|
72
|
-
});
|
|
73
|
-
}
|
|
74
|
-
|
|
75
67
|
/**
|
|
76
68
|
* Retrieve a parse job with optional expanded content.
|
|
77
69
|
*
|
|
@@ -84,6 +76,11 @@ export class Parsing extends APIResource {
|
|
|
84
76
|
*
|
|
85
77
|
* Content metadata fields (e.g. `text_content_metadata`) return presigned URLs for
|
|
86
78
|
* downloading large results.
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* const parsing = await client.parsing.get('job_id');
|
|
83
|
+
* ```
|
|
87
84
|
*/
|
|
88
85
|
get(
|
|
89
86
|
jobID: string,
|
|
@@ -93,6 +90,30 @@ export class Parsing extends APIResource {
|
|
|
93
90
|
return this._client.get(path`/api/v2/parse/${jobID}`, { query, ...options });
|
|
94
91
|
}
|
|
95
92
|
|
|
93
|
+
/**
|
|
94
|
+
* List parse jobs for the current project.
|
|
95
|
+
*
|
|
96
|
+
* Filter by `status` or creation date range. Results are paginated — use
|
|
97
|
+
* `page_token` from the response to fetch subsequent pages.
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```ts
|
|
101
|
+
* // Automatically fetches more pages as needed.
|
|
102
|
+
* for await (const parsingListResponse of client.parsing.list()) {
|
|
103
|
+
* // ...
|
|
104
|
+
* }
|
|
105
|
+
* ```
|
|
106
|
+
*/
|
|
107
|
+
list(
|
|
108
|
+
query: ParsingListParams | null | undefined = {},
|
|
109
|
+
options?: RequestOptions,
|
|
110
|
+
): PagePromise<ParsingListResponsesPaginatedCursor, ParsingListResponse> {
|
|
111
|
+
return this._client.getAPIList('/api/v2/parse', PaginatedCursor<ParsingListResponse>, {
|
|
112
|
+
query,
|
|
113
|
+
...options,
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
|
|
96
117
|
/**
|
|
97
118
|
* Wait for a parse job to complete by polling until it reaches a terminal state.
|
|
98
119
|
*
|
|
@@ -326,13 +347,13 @@ export interface CodeItem {
|
|
|
326
347
|
/**
|
|
327
348
|
* Enum for representing the different available page error handling modes.
|
|
328
349
|
*/
|
|
329
|
-
export type FailPageMode = '
|
|
350
|
+
export type FailPageMode = 'blank_page' | 'error_message' | 'raw_text';
|
|
330
351
|
|
|
331
352
|
export interface FooterItem {
|
|
332
353
|
/**
|
|
333
354
|
* List of items within the footer
|
|
334
355
|
*/
|
|
335
|
-
items: Array<
|
|
356
|
+
items: Array<CodeItem | HeadingItem | ImageItem | LinkItem | ListItem | TableItem | TextItem>;
|
|
336
357
|
|
|
337
358
|
/**
|
|
338
359
|
* Markdown representation preserving formatting
|
|
@@ -354,7 +375,7 @@ export interface HeaderItem {
|
|
|
354
375
|
/**
|
|
355
376
|
* List of items within the header
|
|
356
377
|
*/
|
|
357
|
-
items: Array<
|
|
378
|
+
items: Array<CodeItem | HeadingItem | ImageItem | LinkItem | ListItem | TableItem | TextItem>;
|
|
358
379
|
|
|
359
380
|
/**
|
|
360
381
|
* Markdown representation preserving formatting
|
|
@@ -484,153 +505,153 @@ export interface ListItem {
|
|
|
484
505
|
* Enum for supported file extensions.
|
|
485
506
|
*/
|
|
486
507
|
export type LlamaParseSupportedFileExtensions =
|
|
487
|
-
| '.pdf'
|
|
488
508
|
| '.abw'
|
|
489
509
|
| '.awt'
|
|
510
|
+
| '.azw'
|
|
511
|
+
| '.azw3'
|
|
512
|
+
| '.azw4'
|
|
513
|
+
| '.bmp'
|
|
514
|
+
| '.cb7'
|
|
515
|
+
| '.cbc'
|
|
516
|
+
| '.cbr'
|
|
517
|
+
| '.cbz'
|
|
490
518
|
| '.cgm'
|
|
519
|
+
| '.chm'
|
|
520
|
+
| '.csv'
|
|
491
521
|
| '.cwk'
|
|
522
|
+
| '.dbf'
|
|
523
|
+
| '.dif'
|
|
524
|
+
| '.djvu'
|
|
492
525
|
| '.doc'
|
|
493
526
|
| '.docm'
|
|
494
527
|
| '.docx'
|
|
495
528
|
| '.dot'
|
|
496
529
|
| '.dotm'
|
|
497
530
|
| '.dotx'
|
|
531
|
+
| '.epub'
|
|
532
|
+
| '.et'
|
|
533
|
+
| '.eth'
|
|
534
|
+
| '.fb2'
|
|
535
|
+
| '.fbz'
|
|
498
536
|
| '.fodg'
|
|
499
537
|
| '.fodp'
|
|
500
|
-
| '.
|
|
538
|
+
| '.fods'
|
|
501
539
|
| '.fodt'
|
|
502
|
-
| '.
|
|
540
|
+
| '.fopd'
|
|
541
|
+
| '.gif'
|
|
542
|
+
| '.heic'
|
|
543
|
+
| '.heif'
|
|
544
|
+
| '.htm'
|
|
545
|
+
| '.html'
|
|
546
|
+
| '.htmlz'
|
|
503
547
|
| '.hwp'
|
|
548
|
+
| '.jpeg'
|
|
549
|
+
| '.jpg'
|
|
550
|
+
| '.key'
|
|
551
|
+
| '.lit'
|
|
552
|
+
| '.lrf'
|
|
504
553
|
| '.lwp'
|
|
554
|
+
| '.m4a'
|
|
505
555
|
| '.mcw'
|
|
556
|
+
| '.md'
|
|
557
|
+
| '.mobi'
|
|
558
|
+
| '.mp3'
|
|
559
|
+
| '.mp4'
|
|
560
|
+
| '.mpeg'
|
|
561
|
+
| '.mpga'
|
|
506
562
|
| '.mw'
|
|
507
563
|
| '.mwd'
|
|
564
|
+
| '.numbers'
|
|
508
565
|
| '.odf'
|
|
566
|
+
| '.odg'
|
|
567
|
+
| '.odp'
|
|
568
|
+
| '.ods'
|
|
509
569
|
| '.odt'
|
|
510
570
|
| '.otg'
|
|
571
|
+
| '.otp'
|
|
572
|
+
| '.ots'
|
|
511
573
|
| '.ott'
|
|
512
574
|
| '.pages'
|
|
513
575
|
| '.pbd'
|
|
576
|
+
| '.pdb'
|
|
577
|
+
| '.pdf'
|
|
578
|
+
| '.pml'
|
|
579
|
+
| '.png'
|
|
580
|
+
| '.pot'
|
|
581
|
+
| '.potm'
|
|
582
|
+
| '.potx'
|
|
583
|
+
| '.ppt'
|
|
584
|
+
| '.pptm'
|
|
585
|
+
| '.pptx'
|
|
586
|
+
| '.prc'
|
|
587
|
+
| '.prn'
|
|
514
588
|
| '.psw'
|
|
589
|
+
| '.qpw'
|
|
590
|
+
| '.rb'
|
|
515
591
|
| '.rtf'
|
|
516
592
|
| '.sda'
|
|
517
593
|
| '.sdd'
|
|
518
594
|
| '.sdp'
|
|
519
595
|
| '.sdw'
|
|
520
596
|
| '.sgl'
|
|
597
|
+
| '.slk'
|
|
598
|
+
| '.snb'
|
|
599
|
+
| '.stc'
|
|
521
600
|
| '.std'
|
|
601
|
+
| '.sti'
|
|
522
602
|
| '.stw'
|
|
603
|
+
| '.svg'
|
|
604
|
+
| '.sxc'
|
|
523
605
|
| '.sxd'
|
|
524
606
|
| '.sxg'
|
|
607
|
+
| '.sxi'
|
|
525
608
|
| '.sxm'
|
|
526
609
|
| '.sxw'
|
|
610
|
+
| '.sylk'
|
|
611
|
+
| '.tcr'
|
|
612
|
+
| '.tif'
|
|
613
|
+
| '.tiff'
|
|
614
|
+
| '.tsv'
|
|
615
|
+
| '.txtz'
|
|
527
616
|
| '.uof'
|
|
528
617
|
| '.uop'
|
|
618
|
+
| '.uos'
|
|
619
|
+
| '.uos1'
|
|
620
|
+
| '.uos2'
|
|
529
621
|
| '.uot'
|
|
622
|
+
| '.vdx'
|
|
530
623
|
| '.vor'
|
|
531
|
-
| '.wpd'
|
|
532
|
-
| '.wps'
|
|
533
|
-
| '.wpt'
|
|
534
|
-
| '.wri'
|
|
535
|
-
| '.wn'
|
|
536
|
-
| '.xml'
|
|
537
|
-
| '.zabw'
|
|
538
|
-
| '.key'
|
|
539
|
-
| '.odp'
|
|
540
|
-
| '.odg'
|
|
541
|
-
| '.otp'
|
|
542
|
-
| '.pot'
|
|
543
|
-
| '.potm'
|
|
544
|
-
| '.potx'
|
|
545
|
-
| '.ppt'
|
|
546
|
-
| '.pptm'
|
|
547
|
-
| '.pptx'
|
|
548
|
-
| '.sti'
|
|
549
|
-
| '.sxi'
|
|
550
624
|
| '.vsd'
|
|
551
625
|
| '.vsdm'
|
|
552
626
|
| '.vsdx'
|
|
553
|
-
| '.
|
|
554
|
-
| '.bmp'
|
|
555
|
-
| '.gif'
|
|
556
|
-
| '.heic'
|
|
557
|
-
| '.heif'
|
|
558
|
-
| '.jpg'
|
|
559
|
-
| '.jpeg'
|
|
560
|
-
| '.png'
|
|
561
|
-
| '.svg'
|
|
562
|
-
| '.tif'
|
|
563
|
-
| '.tiff'
|
|
564
|
-
| '.webp'
|
|
565
|
-
| '.htm'
|
|
566
|
-
| '.html'
|
|
567
|
-
| '.xhtm'
|
|
568
|
-
| '.csv'
|
|
569
|
-
| '.dbf'
|
|
570
|
-
| '.dif'
|
|
571
|
-
| '.et'
|
|
572
|
-
| '.eth'
|
|
573
|
-
| '.fods'
|
|
574
|
-
| '.numbers'
|
|
575
|
-
| '.ods'
|
|
576
|
-
| '.ots'
|
|
577
|
-
| '.prn'
|
|
578
|
-
| '.qpw'
|
|
579
|
-
| '.slk'
|
|
580
|
-
| '.stc'
|
|
581
|
-
| '.sxc'
|
|
582
|
-
| '.sylk'
|
|
583
|
-
| '.tsv'
|
|
584
|
-
| '.uos1'
|
|
585
|
-
| '.uos2'
|
|
586
|
-
| '.uos'
|
|
627
|
+
| '.wav'
|
|
587
628
|
| '.wb1'
|
|
588
629
|
| '.wb2'
|
|
589
630
|
| '.wb3'
|
|
631
|
+
| '.webm'
|
|
632
|
+
| '.webp'
|
|
590
633
|
| '.wk1'
|
|
591
634
|
| '.wk2'
|
|
592
635
|
| '.wk3'
|
|
593
636
|
| '.wk4'
|
|
594
637
|
| '.wks'
|
|
638
|
+
| '.wn'
|
|
639
|
+
| '.wpd'
|
|
640
|
+
| '.wps'
|
|
641
|
+
| '.wpt'
|
|
595
642
|
| '.wq1'
|
|
596
643
|
| '.wq2'
|
|
644
|
+
| '.wri'
|
|
645
|
+
| '.xhtm'
|
|
597
646
|
| '.xlr'
|
|
598
647
|
| '.xls'
|
|
599
648
|
| '.xlsb'
|
|
600
649
|
| '.xlsm'
|
|
601
650
|
| '.xlsx'
|
|
602
651
|
| '.xlw'
|
|
603
|
-
| '.
|
|
604
|
-
| '.
|
|
605
|
-
| '.
|
|
606
|
-
| '.cb7'
|
|
607
|
-
| '.cbc'
|
|
608
|
-
| '.cbr'
|
|
609
|
-
| '.cbz'
|
|
610
|
-
| '.chm'
|
|
611
|
-
| '.djvu'
|
|
612
|
-
| '.epub'
|
|
613
|
-
| '.fbz'
|
|
614
|
-
| '.htmlz'
|
|
615
|
-
| '.lit'
|
|
616
|
-
| '.lrf'
|
|
617
|
-
| '.md'
|
|
618
|
-
| '.mobi'
|
|
619
|
-
| '.pdb'
|
|
620
|
-
| '.pml'
|
|
621
|
-
| '.prc'
|
|
622
|
-
| '.rb'
|
|
623
|
-
| '.snb'
|
|
624
|
-
| '.tcr'
|
|
625
|
-
| '.txtz'
|
|
626
|
-
| '.m4a'
|
|
627
|
-
| '.mp3'
|
|
628
|
-
| '.mp4'
|
|
629
|
-
| '.mpeg'
|
|
630
|
-
| '.mpga'
|
|
631
|
-
| '.wav'
|
|
632
|
-
| '.webm'
|
|
633
|
-
| '.yxmd';
|
|
652
|
+
| '.xml'
|
|
653
|
+
| '.yxmd'
|
|
654
|
+
| '.zabw';
|
|
634
655
|
|
|
635
656
|
/**
|
|
636
657
|
* A parse job (v1).
|
|
@@ -661,30 +682,63 @@ export interface ParsingJob {
|
|
|
661
682
|
* Enum for representing the languages supported by the parser.
|
|
662
683
|
*/
|
|
663
684
|
export type ParsingLanguages =
|
|
685
|
+
| 'abq'
|
|
686
|
+
| 'ady'
|
|
664
687
|
| 'af'
|
|
688
|
+
| 'ang'
|
|
689
|
+
| 'ar'
|
|
690
|
+
| 'as'
|
|
691
|
+
| 'ava'
|
|
665
692
|
| 'az'
|
|
693
|
+
| 'be'
|
|
694
|
+
| 'bg'
|
|
695
|
+
| 'bgc'
|
|
696
|
+
| 'bh'
|
|
697
|
+
| 'bho'
|
|
698
|
+
| 'bn'
|
|
666
699
|
| 'bs'
|
|
700
|
+
| 'ch_sim'
|
|
701
|
+
| 'ch_tra'
|
|
702
|
+
| 'che'
|
|
667
703
|
| 'cs'
|
|
668
704
|
| 'cy'
|
|
669
705
|
| 'da'
|
|
706
|
+
| 'dar'
|
|
670
707
|
| 'de'
|
|
671
708
|
| 'en'
|
|
672
709
|
| 'es'
|
|
673
710
|
| 'et'
|
|
711
|
+
| 'fa'
|
|
674
712
|
| 'fr'
|
|
675
713
|
| 'ga'
|
|
714
|
+
| 'gom'
|
|
715
|
+
| 'hi'
|
|
676
716
|
| 'hr'
|
|
677
717
|
| 'hu'
|
|
678
718
|
| 'id'
|
|
719
|
+
| 'inh'
|
|
679
720
|
| 'is'
|
|
680
721
|
| 'it'
|
|
722
|
+
| 'ja'
|
|
723
|
+
| 'kbd'
|
|
724
|
+
| 'kn'
|
|
725
|
+
| 'ko'
|
|
681
726
|
| 'ku'
|
|
682
727
|
| 'la'
|
|
728
|
+
| 'lbe'
|
|
729
|
+
| 'lez'
|
|
683
730
|
| 'lt'
|
|
684
731
|
| 'lv'
|
|
732
|
+
| 'mah'
|
|
733
|
+
| 'mai'
|
|
685
734
|
| 'mi'
|
|
735
|
+
| 'mn'
|
|
736
|
+
| 'mni'
|
|
737
|
+
| 'mr'
|
|
686
738
|
| 'ms'
|
|
687
739
|
| 'mt'
|
|
740
|
+
| 'ne'
|
|
741
|
+
| 'new'
|
|
688
742
|
| 'nl'
|
|
689
743
|
| 'no'
|
|
690
744
|
| 'oc'
|
|
@@ -692,79 +746,46 @@ export type ParsingLanguages =
|
|
|
692
746
|
| 'pl'
|
|
693
747
|
| 'pt'
|
|
694
748
|
| 'ro'
|
|
749
|
+
| 'rs_cyrillic'
|
|
695
750
|
| 'rs_latin'
|
|
751
|
+
| 'ru'
|
|
752
|
+
| 'sa'
|
|
753
|
+
| 'sck'
|
|
696
754
|
| 'sk'
|
|
697
755
|
| 'sl'
|
|
698
756
|
| 'sq'
|
|
699
757
|
| 'sv'
|
|
700
758
|
| 'sw'
|
|
759
|
+
| 'ta'
|
|
760
|
+
| 'tab'
|
|
761
|
+
| 'te'
|
|
762
|
+
| 'th'
|
|
763
|
+
| 'tjk'
|
|
701
764
|
| 'tl'
|
|
702
765
|
| 'tr'
|
|
703
|
-
| 'uz'
|
|
704
|
-
| 'vi'
|
|
705
|
-
| 'ar'
|
|
706
|
-
| 'fa'
|
|
707
766
|
| 'ug'
|
|
708
|
-
| 'ur'
|
|
709
|
-
| 'bn'
|
|
710
|
-
| 'as'
|
|
711
|
-
| 'mni'
|
|
712
|
-
| 'ru'
|
|
713
|
-
| 'rs_cyrillic'
|
|
714
|
-
| 'be'
|
|
715
|
-
| 'bg'
|
|
716
767
|
| 'uk'
|
|
717
|
-
| '
|
|
718
|
-
| '
|
|
719
|
-
| '
|
|
720
|
-
| 'kbd'
|
|
721
|
-
| 'ava'
|
|
722
|
-
| 'dar'
|
|
723
|
-
| 'inh'
|
|
724
|
-
| 'che'
|
|
725
|
-
| 'lbe'
|
|
726
|
-
| 'lez'
|
|
727
|
-
| 'tab'
|
|
728
|
-
| 'tjk'
|
|
729
|
-
| 'hi'
|
|
730
|
-
| 'mr'
|
|
731
|
-
| 'ne'
|
|
732
|
-
| 'bh'
|
|
733
|
-
| 'mai'
|
|
734
|
-
| 'ang'
|
|
735
|
-
| 'bho'
|
|
736
|
-
| 'mah'
|
|
737
|
-
| 'sck'
|
|
738
|
-
| 'new'
|
|
739
|
-
| 'gom'
|
|
740
|
-
| 'sa'
|
|
741
|
-
| 'bgc'
|
|
742
|
-
| 'th'
|
|
743
|
-
| 'ch_sim'
|
|
744
|
-
| 'ch_tra'
|
|
745
|
-
| 'ja'
|
|
746
|
-
| 'ko'
|
|
747
|
-
| 'ta'
|
|
748
|
-
| 'te'
|
|
749
|
-
| 'kn';
|
|
768
|
+
| 'ur'
|
|
769
|
+
| 'uz'
|
|
770
|
+
| 'vi';
|
|
750
771
|
|
|
751
772
|
/**
|
|
752
773
|
* Enum for representing the mode of parsing to be used.
|
|
753
774
|
*/
|
|
754
775
|
export type ParsingMode =
|
|
755
|
-
| '
|
|
756
|
-
| 'parse_page_with_llm'
|
|
757
|
-
| 'parse_page_with_lvm'
|
|
758
|
-
| 'parse_page_with_agent'
|
|
759
|
-
| 'parse_page_with_layout_agent'
|
|
776
|
+
| 'parse_document_with_agent'
|
|
760
777
|
| 'parse_document_with_llm'
|
|
761
778
|
| 'parse_document_with_lvm'
|
|
762
|
-
| '
|
|
779
|
+
| 'parse_page_with_agent'
|
|
780
|
+
| 'parse_page_with_layout_agent'
|
|
781
|
+
| 'parse_page_with_llm'
|
|
782
|
+
| 'parse_page_with_lvm'
|
|
783
|
+
| 'parse_page_without_llm';
|
|
763
784
|
|
|
764
785
|
/**
|
|
765
786
|
* Enum for representing the status of a job
|
|
766
787
|
*/
|
|
767
|
-
export type StatusEnum = '
|
|
788
|
+
export type StatusEnum = 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS';
|
|
768
789
|
|
|
769
790
|
export interface TableItem {
|
|
770
791
|
/**
|
|
@@ -870,7 +891,7 @@ export interface ParsingCreateResponse {
|
|
|
870
891
|
/**
|
|
871
892
|
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
|
|
872
893
|
*/
|
|
873
|
-
status: '
|
|
894
|
+
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
|
|
874
895
|
|
|
875
896
|
/**
|
|
876
897
|
* Creation datetime
|
|
@@ -896,6 +917,11 @@ export interface ParsingCreateResponse {
|
|
|
896
917
|
* Update datetime
|
|
897
918
|
*/
|
|
898
919
|
updated_at?: string | null;
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* Key/value tags associated with this job.
|
|
923
|
+
*/
|
|
924
|
+
user_metadata?: { [key: string]: string } | null;
|
|
899
925
|
}
|
|
900
926
|
|
|
901
927
|
/**
|
|
@@ -915,7 +941,7 @@ export interface ParsingListResponse {
|
|
|
915
941
|
/**
|
|
916
942
|
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
|
|
917
943
|
*/
|
|
918
|
-
status: '
|
|
944
|
+
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
|
|
919
945
|
|
|
920
946
|
/**
|
|
921
947
|
* Creation datetime
|
|
@@ -941,6 +967,11 @@ export interface ParsingListResponse {
|
|
|
941
967
|
* Update datetime
|
|
942
968
|
*/
|
|
943
969
|
updated_at?: string | null;
|
|
970
|
+
|
|
971
|
+
/**
|
|
972
|
+
* Key/value tags associated with this job.
|
|
973
|
+
*/
|
|
974
|
+
user_metadata?: { [key: string]: string } | null;
|
|
944
975
|
}
|
|
945
976
|
|
|
946
977
|
/**
|
|
@@ -1021,7 +1052,7 @@ export namespace ParsingGetResponse {
|
|
|
1021
1052
|
/**
|
|
1022
1053
|
* Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED
|
|
1023
1054
|
*/
|
|
1024
|
-
status: '
|
|
1055
|
+
status: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
|
|
1025
1056
|
|
|
1026
1057
|
/**
|
|
1027
1058
|
* Creation datetime
|
|
@@ -1047,6 +1078,11 @@ export namespace ParsingGetResponse {
|
|
|
1047
1078
|
* Update datetime
|
|
1048
1079
|
*/
|
|
1049
1080
|
updated_at?: string | null;
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* Key/value tags associated with this job.
|
|
1084
|
+
*/
|
|
1085
|
+
user_metadata?: { [key: string]: string } | null;
|
|
1050
1086
|
}
|
|
1051
1087
|
|
|
1052
1088
|
/**
|
|
@@ -1088,7 +1124,7 @@ export namespace ParsingGetResponse {
|
|
|
1088
1124
|
* Image category: 'screenshot' (full page), 'embedded' (images in document), or
|
|
1089
1125
|
* 'layout' (cropped from layout detection)
|
|
1090
1126
|
*/
|
|
1091
|
-
category?: '
|
|
1127
|
+
category?: 'embedded' | 'layout' | 'screenshot' | null;
|
|
1092
1128
|
|
|
1093
1129
|
/**
|
|
1094
1130
|
* MIME type of the image
|
|
@@ -1151,15 +1187,15 @@ export namespace ParsingGetResponse {
|
|
|
1151
1187
|
* List of structured items on the page
|
|
1152
1188
|
*/
|
|
1153
1189
|
items: Array<
|
|
1154
|
-
| ParsingAPI.TextItem
|
|
1155
|
-
| ParsingAPI.HeadingItem
|
|
1156
|
-
| ParsingAPI.ListItem
|
|
1157
1190
|
| ParsingAPI.CodeItem
|
|
1158
|
-
| ParsingAPI.
|
|
1191
|
+
| ParsingAPI.FooterItem
|
|
1192
|
+
| ParsingAPI.HeaderItem
|
|
1193
|
+
| ParsingAPI.HeadingItem
|
|
1159
1194
|
| ParsingAPI.ImageItem
|
|
1160
1195
|
| ParsingAPI.LinkItem
|
|
1161
|
-
| ParsingAPI.
|
|
1162
|
-
| ParsingAPI.
|
|
1196
|
+
| ParsingAPI.ListItem
|
|
1197
|
+
| ParsingAPI.TableItem
|
|
1198
|
+
| ParsingAPI.TextItem
|
|
1163
1199
|
>;
|
|
1164
1200
|
|
|
1165
1201
|
/**
|
|
@@ -1365,7 +1401,7 @@ export interface ParsingCreateParams {
|
|
|
1365
1401
|
* (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus'
|
|
1366
1402
|
* (premium AI with highest accuracy)
|
|
1367
1403
|
*/
|
|
1368
|
-
tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus';
|
|
1404
|
+
tier: 'fast' | 'cost_effective' | 'agentic' | 'agentic_plus' | (string & {});
|
|
1369
1405
|
|
|
1370
1406
|
/**
|
|
1371
1407
|
* Body param: Version for the selected tier. Use `latest`, or pin one of that
|
|
@@ -1374,13 +1410,13 @@ export interface ParsingCreateParams {
|
|
|
1374
1410
|
* Current `latest` by tier:
|
|
1375
1411
|
*
|
|
1376
1412
|
* - `fast`: `2025-12-11`
|
|
1377
|
-
* - `cost_effective`: `2026-06-
|
|
1378
|
-
* - `agentic`: `2026-06-
|
|
1379
|
-
* - `agentic_plus`: `2026-06-
|
|
1413
|
+
* - `cost_effective`: `2026-06-26`
|
|
1414
|
+
* - `agentic`: `2026-06-18`
|
|
1415
|
+
* - `agentic_plus`: `2026-06-18`
|
|
1380
1416
|
*
|
|
1381
1417
|
* Full list: `GET /api/v2/parse/versions`.
|
|
1382
1418
|
*/
|
|
1383
|
-
version: 'latest' | '2026-06-
|
|
1419
|
+
version: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | (string & {});
|
|
1384
1420
|
|
|
1385
1421
|
/**
|
|
1386
1422
|
* Query param
|
|
@@ -1407,6 +1443,12 @@ export interface ParsingCreateParams {
|
|
|
1407
1443
|
*/
|
|
1408
1444
|
client_name?: string | null;
|
|
1409
1445
|
|
|
1446
|
+
/**
|
|
1447
|
+
* Body param: ID of a saved parse configuration. When set, `tier` and `version`
|
|
1448
|
+
* default to the saved configuration's values — omit them or pass `'configured'`.
|
|
1449
|
+
*/
|
|
1450
|
+
configuration_id?: string | null;
|
|
1451
|
+
|
|
1410
1452
|
/**
|
|
1411
1453
|
* Body param: Crop boundaries to process only a portion of each page. Values are
|
|
1412
1454
|
* ratios 0-1 from page edges
|
|
@@ -1472,6 +1514,18 @@ export interface ParsingCreateParams {
|
|
|
1472
1514
|
*/
|
|
1473
1515
|
source_url?: string | null;
|
|
1474
1516
|
|
|
1517
|
+
/**
|
|
1518
|
+
* Body param: Arbitrary key/value tags to attach to this job. Returned when
|
|
1519
|
+
* retrieving the job. Not searchable. Limits apply to the number of entries and
|
|
1520
|
+
* the length of keys and values; oversized metadata is rejected.
|
|
1521
|
+
*/
|
|
1522
|
+
user_metadata?: { [key: string]: string } | null;
|
|
1523
|
+
|
|
1524
|
+
/**
|
|
1525
|
+
* Body param: IDs of saved webhook configurations to notify for this job.
|
|
1526
|
+
*/
|
|
1527
|
+
webhook_configuration_ids?: Array<string> | null;
|
|
1528
|
+
|
|
1475
1529
|
/**
|
|
1476
1530
|
* Body param: Webhook endpoints for job status notifications. Multiple webhooks
|
|
1477
1531
|
* can be configured for different events or services
|
|
@@ -1535,6 +1589,11 @@ export namespace ParsingCreateParams {
|
|
|
1535
1589
|
*/
|
|
1536
1590
|
html?: InputOptions.HTML;
|
|
1537
1591
|
|
|
1592
|
+
/**
|
|
1593
|
+
* Image parsing options (applies to .jpg, .jpeg, .png, .webp files)
|
|
1594
|
+
*/
|
|
1595
|
+
image?: InputOptions.Image;
|
|
1596
|
+
|
|
1538
1597
|
/**
|
|
1539
1598
|
* PDF-specific parsing options (applies to .pdf files)
|
|
1540
1599
|
*/
|
|
@@ -1574,6 +1633,20 @@ export namespace ParsingCreateParams {
|
|
|
1574
1633
|
remove_navigation_elements?: boolean | null;
|
|
1575
1634
|
}
|
|
1576
1635
|
|
|
1636
|
+
/**
|
|
1637
|
+
* Image parsing options (applies to .jpg, .jpeg, .png, .webp files)
|
|
1638
|
+
*/
|
|
1639
|
+
export interface Image {
|
|
1640
|
+
/**
|
|
1641
|
+
* Detect documents photographed with a camera (e.g. phone scans of receipts or
|
|
1642
|
+
* forms), then crop, perspective-correct, and flatten uneven lighting and shadows
|
|
1643
|
+
* before parsing. Supports JPEG, PNG, WebP, and HEIC/HEIF inputs. Improves results
|
|
1644
|
+
* when the document is tilted or surrounded by background. Images that already
|
|
1645
|
+
* look like clean scans are left untouched
|
|
1646
|
+
*/
|
|
1647
|
+
camera_photo_correction?: boolean | null;
|
|
1648
|
+
}
|
|
1649
|
+
|
|
1577
1650
|
/**
|
|
1578
1651
|
* Presentation parsing options (applies to .pptx, .ppt, .odp, .key files)
|
|
1579
1652
|
*/
|
|
@@ -1662,7 +1735,7 @@ export namespace ParsingCreateParams {
|
|
|
1662
1735
|
* (cropped regions from layout detection like figures and diagrams). Empty list
|
|
1663
1736
|
* saves no images
|
|
1664
1737
|
*/
|
|
1665
|
-
images_to_save?: Array<'
|
|
1738
|
+
images_to_save?: Array<'embedded' | 'layout' | 'screenshot'>;
|
|
1666
1739
|
|
|
1667
1740
|
/**
|
|
1668
1741
|
* Markdown formatting options including table styles and link annotations
|
|
@@ -1912,7 +1985,7 @@ export namespace ParsingCreateParams {
|
|
|
1912
1985
|
* 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables
|
|
1913
1986
|
* extract_layout and precise_bounding_box when set
|
|
1914
1987
|
*/
|
|
1915
|
-
specialized_chart_parsing?: '
|
|
1988
|
+
specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient' | null;
|
|
1916
1989
|
}
|
|
1917
1990
|
|
|
1918
1991
|
export namespace ProcessingOptions {
|
|
@@ -2169,12 +2242,12 @@ export namespace ParsingCreateParams {
|
|
|
2169
2242
|
/**
|
|
2170
2243
|
* Enable specialized chart parsing with the specified mode
|
|
2171
2244
|
*/
|
|
2172
|
-
specialized_chart_parsing?: '
|
|
2245
|
+
specialized_chart_parsing?: 'agentic' | 'agentic_plus' | 'efficient' | null;
|
|
2173
2246
|
|
|
2174
2247
|
/**
|
|
2175
2248
|
* Override the parsing tier for matched pages. Must be paired with version
|
|
2176
2249
|
*/
|
|
2177
|
-
tier?: '
|
|
2250
|
+
tier?: 'agentic' | 'agentic_plus' | 'cost_effective' | 'fast' | null;
|
|
2178
2251
|
|
|
2179
2252
|
/**
|
|
2180
2253
|
* Version for the override tier. Required when `tier` is set. Use `latest`, or pin
|
|
@@ -2183,13 +2256,13 @@ export namespace ParsingCreateParams {
|
|
|
2183
2256
|
* Current `latest` by tier:
|
|
2184
2257
|
*
|
|
2185
2258
|
* - `fast`: `2025-12-11`
|
|
2186
|
-
* - `cost_effective`: `2026-06-
|
|
2187
|
-
* - `agentic`: `2026-06-
|
|
2188
|
-
* - `agentic_plus`: `2026-06-
|
|
2259
|
+
* - `cost_effective`: `2026-06-26`
|
|
2260
|
+
* - `agentic`: `2026-06-18`
|
|
2261
|
+
* - `agentic_plus`: `2026-06-18`
|
|
2189
2262
|
*
|
|
2190
2263
|
* Full list: `GET /api/v2/parse/versions`.
|
|
2191
2264
|
*/
|
|
2192
|
-
version?: 'latest' | '2026-06-
|
|
2265
|
+
version?: 'latest' | '2026-06-26' | '2026-06-18' | '2025-12-11' | (string & {}) | null;
|
|
2193
2266
|
}
|
|
2194
2267
|
|
|
2195
2268
|
export namespace ParsingConf {
|
|
@@ -2347,7 +2420,15 @@ export namespace ParsingCreateParams {
|
|
|
2347
2420
|
* Format of the webhook payload body. 'string' (default) sends the payload as a
|
|
2348
2421
|
* JSON-encoded string; 'json' sends it as a JSON object.
|
|
2349
2422
|
*/
|
|
2350
|
-
webhook_output_format?: '
|
|
2423
|
+
webhook_output_format?: 'json' | 'string' | null;
|
|
2424
|
+
|
|
2425
|
+
/**
|
|
2426
|
+
* Shared signing secret used to sign webhook deliveries. When set, each request
|
|
2427
|
+
* includes an HMAC-SHA256 signature of the request body in the 'LC-Signature'
|
|
2428
|
+
* header (value 'sha256=<hex>'). Recompute the HMAC over the raw request body with
|
|
2429
|
+
* this secret to verify the delivery is authentic.
|
|
2430
|
+
*/
|
|
2431
|
+
webhook_signing_secret?: string | null;
|
|
2351
2432
|
|
|
2352
2433
|
/**
|
|
2353
2434
|
* HTTPS URL to receive webhook POST requests. Must be publicly accessible
|
|
@@ -2356,6 +2437,26 @@ export namespace ParsingCreateParams {
|
|
|
2356
2437
|
}
|
|
2357
2438
|
}
|
|
2358
2439
|
|
|
2440
|
+
export interface ParsingGetParams {
|
|
2441
|
+
/**
|
|
2442
|
+
* Fields to include: text, markdown, items, metadata, job_metadata,
|
|
2443
|
+
* text_content_metadata, markdown_content_metadata, items_content_metadata,
|
|
2444
|
+
* metadata_content_metadata, raw_words_content_metadata, xlsx_content_metadata,
|
|
2445
|
+
* output_pdf_content_metadata, images_content_metadata. Metadata fields include
|
|
2446
|
+
* presigned URLs.
|
|
2447
|
+
*/
|
|
2448
|
+
expand?: Array<string>;
|
|
2449
|
+
|
|
2450
|
+
/**
|
|
2451
|
+
* Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg
|
|
2452
|
+
*/
|
|
2453
|
+
image_filenames?: string | null;
|
|
2454
|
+
|
|
2455
|
+
organization_id?: string | null;
|
|
2456
|
+
|
|
2457
|
+
project_id?: string | null;
|
|
2458
|
+
}
|
|
2459
|
+
|
|
2359
2460
|
export interface ParsingListParams extends PaginatedCursorParams {
|
|
2360
2461
|
/**
|
|
2361
2462
|
* Include items created at or after this timestamp (inclusive)
|
|
@@ -2379,27 +2480,7 @@ export interface ParsingListParams extends PaginatedCursorParams {
|
|
|
2379
2480
|
/**
|
|
2380
2481
|
* Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)
|
|
2381
2482
|
*/
|
|
2382
|
-
status?: '
|
|
2383
|
-
}
|
|
2384
|
-
|
|
2385
|
-
export interface ParsingGetParams {
|
|
2386
|
-
/**
|
|
2387
|
-
* Fields to include: text, markdown, items, metadata, job_metadata,
|
|
2388
|
-
* text_content_metadata, markdown_content_metadata, items_content_metadata,
|
|
2389
|
-
* metadata_content_metadata, raw_words_content_metadata, xlsx_content_metadata,
|
|
2390
|
-
* output_pdf_content_metadata, images_content_metadata. Metadata fields include
|
|
2391
|
-
* presigned URLs.
|
|
2392
|
-
*/
|
|
2393
|
-
expand?: Array<string>;
|
|
2394
|
-
|
|
2395
|
-
/**
|
|
2396
|
-
* Filter to specific image filenames (optional). Example: image_0.png,image_1.jpg
|
|
2397
|
-
*/
|
|
2398
|
-
image_filenames?: string | null;
|
|
2399
|
-
|
|
2400
|
-
organization_id?: string | null;
|
|
2401
|
-
|
|
2402
|
-
project_id?: string | null;
|
|
2483
|
+
status?: 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | null;
|
|
2403
2484
|
}
|
|
2404
2485
|
|
|
2405
2486
|
export declare namespace Parsing {
|
|
@@ -2425,7 +2506,7 @@ export declare namespace Parsing {
|
|
|
2425
2506
|
type ParsingGetResponse as ParsingGetResponse,
|
|
2426
2507
|
type ParsingListResponsesPaginatedCursor as ParsingListResponsesPaginatedCursor,
|
|
2427
2508
|
type ParsingCreateParams as ParsingCreateParams,
|
|
2428
|
-
type ParsingListParams as ParsingListParams,
|
|
2429
2509
|
type ParsingGetParams as ParsingGetParams,
|
|
2510
|
+
type ParsingListParams as ParsingListParams,
|
|
2430
2511
|
};
|
|
2431
2512
|
}
|