@llamaindex/llama-cloud 2.3.0 → 2.4.1
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 +34 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/beta/agent-data.d.mts +82 -19
- package/resources/beta/agent-data.d.mts.map +1 -1
- package/resources/beta/agent-data.d.ts +82 -19
- package/resources/beta/agent-data.d.ts.map +1 -1
- package/resources/beta/agent-data.js +76 -11
- package/resources/beta/agent-data.js.map +1 -1
- package/resources/beta/agent-data.mjs +76 -11
- package/resources/beta/agent-data.mjs.map +1 -1
- package/resources/beta/batch/batch.d.mts +27 -0
- package/resources/beta/batch/batch.d.mts.map +1 -1
- package/resources/beta/batch/batch.d.ts +27 -0
- package/resources/beta/batch/batch.d.ts.map +1 -1
- package/resources/beta/batch/batch.js +27 -0
- package/resources/beta/batch/batch.js.map +1 -1
- package/resources/beta/batch/batch.mjs +27 -0
- package/resources/beta/batch/batch.mjs.map +1 -1
- package/resources/beta/batch/job-items.d.mts +18 -0
- package/resources/beta/batch/job-items.d.mts.map +1 -1
- package/resources/beta/batch/job-items.d.ts +18 -0
- package/resources/beta/batch/job-items.d.ts.map +1 -1
- package/resources/beta/batch/job-items.js +18 -0
- package/resources/beta/batch/job-items.js.map +1 -1
- package/resources/beta/batch/job-items.mjs +18 -0
- package/resources/beta/batch/job-items.mjs.map +1 -1
- package/resources/beta/beta.d.mts +2 -2
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +2 -2
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/directories/directories.d.mts +34 -0
- package/resources/beta/directories/directories.d.mts.map +1 -1
- package/resources/beta/directories/directories.d.ts +34 -0
- package/resources/beta/directories/directories.d.ts.map +1 -1
- package/resources/beta/directories/directories.js +34 -0
- package/resources/beta/directories/directories.js.map +1 -1
- package/resources/beta/directories/directories.mjs +34 -0
- package/resources/beta/directories/directories.mjs.map +1 -1
- package/resources/beta/directories/files.d.mts +93 -0
- package/resources/beta/directories/files.d.mts.map +1 -1
- package/resources/beta/directories/files.d.ts +93 -0
- package/resources/beta/directories/files.d.ts.map +1 -1
- package/resources/beta/directories/files.js +50 -0
- package/resources/beta/directories/files.js.map +1 -1
- package/resources/beta/directories/files.mjs +50 -0
- package/resources/beta/directories/files.mjs.map +1 -1
- package/resources/beta/index.d.mts +1 -1
- package/resources/beta/index.d.mts.map +1 -1
- package/resources/beta/index.d.ts +1 -1
- package/resources/beta/index.d.ts.map +1 -1
- package/resources/beta/sheets.d.mts +38 -0
- package/resources/beta/sheets.d.mts.map +1 -1
- package/resources/beta/sheets.d.ts +38 -0
- package/resources/beta/sheets.d.ts.map +1 -1
- package/resources/beta/sheets.js +38 -0
- package/resources/beta/sheets.js.map +1 -1
- package/resources/beta/sheets.mjs +38 -0
- package/resources/beta/sheets.mjs.map +1 -1
- package/resources/beta/split.d.mts +25 -10
- package/resources/beta/split.d.mts.map +1 -1
- package/resources/beta/split.d.ts +25 -10
- package/resources/beta/split.d.ts.map +1 -1
- package/resources/beta/split.js +21 -6
- package/resources/beta/split.js.map +1 -1
- package/resources/beta/split.mjs +21 -6
- package/resources/beta/split.mjs.map +1 -1
- package/resources/classify.d.mts +70 -0
- package/resources/classify.d.mts.map +1 -1
- package/resources/classify.d.ts +70 -0
- package/resources/classify.d.ts.map +1 -1
- package/resources/classify.js +113 -0
- package/resources/classify.js.map +1 -1
- package/resources/classify.mjs +113 -0
- package/resources/classify.mjs.map +1 -1
- package/resources/configurations.d.mts +214 -13
- package/resources/configurations.d.mts.map +1 -1
- package/resources/configurations.d.ts +214 -13
- package/resources/configurations.d.ts.map +1 -1
- package/resources/extract.d.mts +16 -6
- package/resources/extract.d.mts.map +1 -1
- package/resources/extract.d.ts +16 -6
- package/resources/extract.d.ts.map +1 -1
- package/resources/extract.js +14 -1
- package/resources/extract.js.map +1 -1
- package/resources/extract.mjs +14 -1
- package/resources/extract.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/parsing.d.mts +5 -4
- package/resources/parsing.d.mts.map +1 -1
- package/resources/parsing.d.ts +5 -4
- package/resources/parsing.d.ts.map +1 -1
- package/resources/pipelines/documents.d.mts +0 -3
- package/resources/pipelines/documents.d.mts.map +1 -1
- package/resources/pipelines/documents.d.ts +0 -3
- package/resources/pipelines/documents.d.ts.map +1 -1
- package/resources/pipelines/pipelines.d.mts +0 -7
- package/resources/pipelines/pipelines.d.mts.map +1 -1
- package/resources/pipelines/pipelines.d.ts +0 -7
- package/resources/pipelines/pipelines.d.ts.map +1 -1
- package/resources/pipelines/pipelines.js.map +1 -1
- package/resources/pipelines/pipelines.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/index.js.map +1 -1
- package/resources/retrievers/index.mjs.map +1 -1
- package/resources/retrievers/retrievers.d.mts +17 -5
- package/resources/retrievers/retrievers.d.mts.map +1 -1
- package/resources/retrievers/retrievers.d.ts +17 -5
- package/resources/retrievers/retrievers.d.ts.map +1 -1
- package/resources/retrievers/retrievers.js +10 -3
- package/resources/retrievers/retrievers.js.map +1 -1
- package/resources/retrievers/retrievers.mjs +10 -3
- package/resources/retrievers/retrievers.mjs.map +1 -1
- package/src/client.ts +2 -0
- package/src/internal/utils/env.ts +2 -2
- package/src/resources/beta/agent-data.ts +94 -28
- package/src/resources/beta/batch/batch.ts +27 -0
- package/src/resources/beta/batch/job-items.ts +18 -0
- package/src/resources/beta/beta.ts +2 -2
- package/src/resources/beta/directories/directories.ts +34 -0
- package/src/resources/beta/directories/files.ts +86 -0
- package/src/resources/beta/index.ts +1 -1
- package/src/resources/beta/sheets.ts +38 -0
- package/src/resources/beta/split.ts +25 -10
- package/src/resources/classify.ts +130 -0
- package/src/resources/configurations.ts +256 -8
- package/src/resources/extract.ts +16 -7
- package/src/resources/index.ts +1 -0
- package/src/resources/parsing.ts +9 -2
- package/src/resources/pipelines/documents.ts +0 -3
- package/src/resources/pipelines/pipelines.ts +0 -7
- package/src/resources/retrievers/index.ts +1 -0
- package/src/resources/retrievers/retrievers.ts +37 -5
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/beta/split.mjs
CHANGED
|
@@ -5,8 +5,14 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
5
5
|
import { pollUntilComplete, DEFAULT_TIMEOUT } from "../../core/polling.mjs";
|
|
6
6
|
export class Split extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Create a document split job.
|
|
9
|
-
*
|
|
8
|
+
* Create a document split job.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const split = await client.beta.split.create({
|
|
13
|
+
* document_input: { type: 'type', value: 'value' },
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
10
16
|
*/
|
|
11
17
|
create(params, options) {
|
|
12
18
|
const { organization_id, project_id, ...body } = params;
|
|
@@ -17,8 +23,15 @@ export class Split extends APIResource {
|
|
|
17
23
|
});
|
|
18
24
|
}
|
|
19
25
|
/**
|
|
20
|
-
* List document split jobs.
|
|
21
|
-
*
|
|
26
|
+
* List document split jobs.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* // Automatically fetches more pages as needed.
|
|
31
|
+
* for await (const splitListResponse of client.beta.split.list()) {
|
|
32
|
+
* // ...
|
|
33
|
+
* }
|
|
34
|
+
* ```
|
|
22
35
|
*/
|
|
23
36
|
list(query = {}, options) {
|
|
24
37
|
return this._client.getAPIList('/api/v1/beta/split/jobs', (PaginatedCursor), {
|
|
@@ -29,8 +42,10 @@ export class Split extends APIResource {
|
|
|
29
42
|
/**
|
|
30
43
|
* Get a document split job.
|
|
31
44
|
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* const split = await client.beta.split.get('split_job_id');
|
|
48
|
+
* ```
|
|
34
49
|
*/
|
|
35
50
|
get(splitJobID, query = {}, options) {
|
|
36
51
|
return this._client.get(path `/api/v1/beta/split/jobs/${splitJobID}`, { query, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"split.mjs","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;OACR,EAAE,iBAAiB,EAAkB,eAAe,EAAE;AAE7D,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC
|
|
1
|
+
{"version":3,"file":"split.mjs","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;OACR,EAAE,iBAAiB,EAAkB,eAAe,EAAE;AAE7D,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,eAAkC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,UAAkB,EAClB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,iBAAiB,CACrB,UAAkB,EAClB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,eAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,iBAAiB,CACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,WAAW,EACnC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,EAChC,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,aAAa,UAAU,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,uBAAuB;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAmB,EAAE,CAAC;QAC1C,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}
|
package/resources/classify.d.mts
CHANGED
|
@@ -2,6 +2,7 @@ import { APIResource } from "../core/resource.mjs";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
3
|
import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from "../core/pagination.mjs";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
import { PollingOptions } from "../core/polling.mjs";
|
|
5
6
|
export declare class Classify extends APIResource {
|
|
6
7
|
/**
|
|
7
8
|
* Create a classify job.
|
|
@@ -16,6 +17,11 @@ export declare class Classify extends APIResource {
|
|
|
16
17
|
*
|
|
17
18
|
* The job runs asynchronously. Poll `GET /classify/{job_id}` to check status and
|
|
18
19
|
* retrieve results.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const classify = await client.classify.create();
|
|
24
|
+
* ```
|
|
19
25
|
*/
|
|
20
26
|
create(params: ClassifyCreateParams, options?: RequestOptions): APIPromise<ClassifyCreateResponse>;
|
|
21
27
|
/**
|
|
@@ -23,6 +29,14 @@ export declare class Classify extends APIResource {
|
|
|
23
29
|
*
|
|
24
30
|
* Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
|
|
25
31
|
* range.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* // Automatically fetches more pages as needed.
|
|
36
|
+
* for await (const classifyListResponse of client.classify.list()) {
|
|
37
|
+
* // ...
|
|
38
|
+
* }
|
|
39
|
+
* ```
|
|
26
40
|
*/
|
|
27
41
|
list(query?: ClassifyListParams | null | undefined, options?: RequestOptions): PagePromise<ClassifyListResponsesPaginatedCursor, ClassifyListResponse>;
|
|
28
42
|
/**
|
|
@@ -30,8 +44,64 @@ export declare class Classify extends APIResource {
|
|
|
30
44
|
*
|
|
31
45
|
* Returns the job status, configuration, and classify result when complete. The
|
|
32
46
|
* result includes the matched document type, confidence score, and reasoning.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const classify = await client.classify.get('job_id');
|
|
51
|
+
* ```
|
|
33
52
|
*/
|
|
34
53
|
get(jobID: string, query?: ClassifyGetParams | null | undefined, options?: RequestOptions): APIPromise<ClassifyGetResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Wait for a classify job to complete by polling until it reaches a terminal state.
|
|
56
|
+
*
|
|
57
|
+
* @param jobID - The ID of the classify job to wait for
|
|
58
|
+
* @param query - Optional query parameters (organization_id, project_id)
|
|
59
|
+
* @param options - Polling configuration and request options
|
|
60
|
+
* @returns The completed classify job
|
|
61
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
62
|
+
* @throws {PollingError} If the job fails
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```typescript
|
|
66
|
+
* const job = await client.classify.create({
|
|
67
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
68
|
+
* configuration_id: 'cfg-...',
|
|
69
|
+
* });
|
|
70
|
+
*
|
|
71
|
+
* const completed = await client.classify.waitForCompletion(job.id, undefined, { verbose: true });
|
|
72
|
+
* console.log(completed.result);
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
waitForCompletion(jobID: string, query?: ClassifyGetParams, options?: PollingOptions & RequestOptions): Promise<ClassifyGetResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Create a classify job, wait for it to complete, and return the result.
|
|
78
|
+
*
|
|
79
|
+
* This is a convenience method that combines create() and waitForCompletion()
|
|
80
|
+
* into a single call for the most common end-to-end workflow.
|
|
81
|
+
*
|
|
82
|
+
* @param params - Classify job creation parameters
|
|
83
|
+
* @param options - Polling configuration and request options
|
|
84
|
+
* @returns The completed classify job with result populated
|
|
85
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
86
|
+
* @throws {PollingError} If the job fails
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```typescript
|
|
90
|
+
* import { LlamaCloud } from 'llama-cloud';
|
|
91
|
+
*
|
|
92
|
+
* const client = new LlamaCloud({ apiKey: '...' });
|
|
93
|
+
*
|
|
94
|
+
* const result = await client.classify.run({
|
|
95
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
96
|
+
* configuration: {
|
|
97
|
+
* rules: [{ type: 'invoice', description: 'contains invoice number' }],
|
|
98
|
+
* },
|
|
99
|
+
* }, { verbose: true });
|
|
100
|
+
*
|
|
101
|
+
* console.log(result.result);
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
run(params: ClassifyCreateParams, options?: PollingOptions & RequestOptions): Promise<ClassifyGetResponse>;
|
|
35
105
|
}
|
|
36
106
|
export type ClassifyListResponsesPaginatedCursor = PaginatedCursor<ClassifyListResponse>;
|
|
37
107
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classify.d.mts","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;
|
|
1
|
+
{"version":3,"file":"classify.d.mts","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IASlG;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,oBAAoB,CAAC;IAO1E;;;;;;;;;;OAUG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GACxC,OAAO,CAAC,mBAAmB,CAAC;IAgC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,GAAG,CACP,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GACxC,OAAO,CAAC,mBAAmB,CAAC;CAsBhC;AAED,MAAM,MAAM,oCAAoC,GAAG,eAAe,CAAC,oBAAoB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB;IAC/D;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/classify.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { APIResource } from "../core/resource.js";
|
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
3
|
import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from "../core/pagination.js";
|
|
4
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
import { PollingOptions } from "../core/polling.js";
|
|
5
6
|
export declare class Classify extends APIResource {
|
|
6
7
|
/**
|
|
7
8
|
* Create a classify job.
|
|
@@ -16,6 +17,11 @@ export declare class Classify extends APIResource {
|
|
|
16
17
|
*
|
|
17
18
|
* The job runs asynchronously. Poll `GET /classify/{job_id}` to check status and
|
|
18
19
|
* retrieve results.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const classify = await client.classify.create();
|
|
24
|
+
* ```
|
|
19
25
|
*/
|
|
20
26
|
create(params: ClassifyCreateParams, options?: RequestOptions): APIPromise<ClassifyCreateResponse>;
|
|
21
27
|
/**
|
|
@@ -23,6 +29,14 @@ export declare class Classify extends APIResource {
|
|
|
23
29
|
*
|
|
24
30
|
* Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
|
|
25
31
|
* range.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* // Automatically fetches more pages as needed.
|
|
36
|
+
* for await (const classifyListResponse of client.classify.list()) {
|
|
37
|
+
* // ...
|
|
38
|
+
* }
|
|
39
|
+
* ```
|
|
26
40
|
*/
|
|
27
41
|
list(query?: ClassifyListParams | null | undefined, options?: RequestOptions): PagePromise<ClassifyListResponsesPaginatedCursor, ClassifyListResponse>;
|
|
28
42
|
/**
|
|
@@ -30,8 +44,64 @@ export declare class Classify extends APIResource {
|
|
|
30
44
|
*
|
|
31
45
|
* Returns the job status, configuration, and classify result when complete. The
|
|
32
46
|
* result includes the matched document type, confidence score, and reasoning.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const classify = await client.classify.get('job_id');
|
|
51
|
+
* ```
|
|
33
52
|
*/
|
|
34
53
|
get(jobID: string, query?: ClassifyGetParams | null | undefined, options?: RequestOptions): APIPromise<ClassifyGetResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Wait for a classify job to complete by polling until it reaches a terminal state.
|
|
56
|
+
*
|
|
57
|
+
* @param jobID - The ID of the classify job to wait for
|
|
58
|
+
* @param query - Optional query parameters (organization_id, project_id)
|
|
59
|
+
* @param options - Polling configuration and request options
|
|
60
|
+
* @returns The completed classify job
|
|
61
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
62
|
+
* @throws {PollingError} If the job fails
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```typescript
|
|
66
|
+
* const job = await client.classify.create({
|
|
67
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
68
|
+
* configuration_id: 'cfg-...',
|
|
69
|
+
* });
|
|
70
|
+
*
|
|
71
|
+
* const completed = await client.classify.waitForCompletion(job.id, undefined, { verbose: true });
|
|
72
|
+
* console.log(completed.result);
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
waitForCompletion(jobID: string, query?: ClassifyGetParams, options?: PollingOptions & RequestOptions): Promise<ClassifyGetResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Create a classify job, wait for it to complete, and return the result.
|
|
78
|
+
*
|
|
79
|
+
* This is a convenience method that combines create() and waitForCompletion()
|
|
80
|
+
* into a single call for the most common end-to-end workflow.
|
|
81
|
+
*
|
|
82
|
+
* @param params - Classify job creation parameters
|
|
83
|
+
* @param options - Polling configuration and request options
|
|
84
|
+
* @returns The completed classify job with result populated
|
|
85
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
86
|
+
* @throws {PollingError} If the job fails
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```typescript
|
|
90
|
+
* import { LlamaCloud } from 'llama-cloud';
|
|
91
|
+
*
|
|
92
|
+
* const client = new LlamaCloud({ apiKey: '...' });
|
|
93
|
+
*
|
|
94
|
+
* const result = await client.classify.run({
|
|
95
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
96
|
+
* configuration: {
|
|
97
|
+
* rules: [{ type: 'invoice', description: 'contains invoice number' }],
|
|
98
|
+
* },
|
|
99
|
+
* }, { verbose: true });
|
|
100
|
+
*
|
|
101
|
+
* console.log(result.result);
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
run(params: ClassifyCreateParams, options?: PollingOptions & RequestOptions): Promise<ClassifyGetResponse>;
|
|
35
105
|
}
|
|
36
106
|
export type ClassifyListResponsesPaginatedCursor = PaginatedCursor<ClassifyListResponse>;
|
|
37
107
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classify.d.ts","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;
|
|
1
|
+
{"version":3,"file":"classify.d.ts","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IASlG;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,oBAAoB,CAAC;IAO1E;;;;;;;;;;OAUG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GACxC,OAAO,CAAC,mBAAmB,CAAC;IAgC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,GAAG,CACP,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GACxC,OAAO,CAAC,mBAAmB,CAAC;CAsBhC;AAED,MAAM,MAAM,oCAAoC,GAAG,eAAe,CAAC,oBAAoB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB;IAC/D;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/classify.js
CHANGED
|
@@ -5,6 +5,7 @@ exports.Classify = void 0;
|
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
6
|
const pagination_1 = require("../core/pagination.js");
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
const polling_1 = require("../core/polling.js");
|
|
8
9
|
class Classify extends resource_1.APIResource {
|
|
9
10
|
/**
|
|
10
11
|
* Create a classify job.
|
|
@@ -19,6 +20,11 @@ class Classify extends resource_1.APIResource {
|
|
|
19
20
|
*
|
|
20
21
|
* The job runs asynchronously. Poll `GET /classify/{job_id}` to check status and
|
|
21
22
|
* retrieve results.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* const classify = await client.classify.create();
|
|
27
|
+
* ```
|
|
22
28
|
*/
|
|
23
29
|
create(params, options) {
|
|
24
30
|
const { organization_id, project_id, ...body } = params;
|
|
@@ -33,6 +39,14 @@ class Classify extends resource_1.APIResource {
|
|
|
33
39
|
*
|
|
34
40
|
* Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
|
|
35
41
|
* range.
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```ts
|
|
45
|
+
* // Automatically fetches more pages as needed.
|
|
46
|
+
* for await (const classifyListResponse of client.classify.list()) {
|
|
47
|
+
* // ...
|
|
48
|
+
* }
|
|
49
|
+
* ```
|
|
36
50
|
*/
|
|
37
51
|
list(query = {}, options) {
|
|
38
52
|
return this._client.getAPIList('/api/v2/classify', (pagination_1.PaginatedCursor), {
|
|
@@ -45,10 +59,109 @@ class Classify extends resource_1.APIResource {
|
|
|
45
59
|
*
|
|
46
60
|
* Returns the job status, configuration, and classify result when complete. The
|
|
47
61
|
* result includes the matched document type, confidence score, and reasoning.
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```ts
|
|
65
|
+
* const classify = await client.classify.get('job_id');
|
|
66
|
+
* ```
|
|
48
67
|
*/
|
|
49
68
|
get(jobID, query = {}, options) {
|
|
50
69
|
return this._client.get((0, path_1.path) `/api/v2/classify/${jobID}`, { query, ...options });
|
|
51
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
* Wait for a classify job to complete by polling until it reaches a terminal state.
|
|
73
|
+
*
|
|
74
|
+
* @param jobID - The ID of the classify job to wait for
|
|
75
|
+
* @param query - Optional query parameters (organization_id, project_id)
|
|
76
|
+
* @param options - Polling configuration and request options
|
|
77
|
+
* @returns The completed classify job
|
|
78
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
79
|
+
* @throws {PollingError} If the job fails
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```typescript
|
|
83
|
+
* const job = await client.classify.create({
|
|
84
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
85
|
+
* configuration_id: 'cfg-...',
|
|
86
|
+
* });
|
|
87
|
+
*
|
|
88
|
+
* const completed = await client.classify.waitForCompletion(job.id, undefined, { verbose: true });
|
|
89
|
+
* console.log(completed.result);
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
async waitForCompletion(jobID, query, options) {
|
|
93
|
+
const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
|
|
94
|
+
const getStatus = async () => {
|
|
95
|
+
return await this.get(jobID, query, requestOptions);
|
|
96
|
+
};
|
|
97
|
+
const isComplete = (job) => {
|
|
98
|
+
return job.status === 'COMPLETED';
|
|
99
|
+
};
|
|
100
|
+
const isError = (job) => {
|
|
101
|
+
return job.status === 'FAILED';
|
|
102
|
+
};
|
|
103
|
+
const getErrorMessage = (job) => {
|
|
104
|
+
const errorParts = [`Job ${jobID} failed with status: ${job.status}`];
|
|
105
|
+
if (job.error_message) {
|
|
106
|
+
errorParts.push(`Error: ${job.error_message}`);
|
|
107
|
+
}
|
|
108
|
+
return errorParts.join(' | ');
|
|
109
|
+
};
|
|
110
|
+
return await (0, polling_1.pollUntilComplete)(getStatus, isComplete, isError, getErrorMessage, {
|
|
111
|
+
pollingInterval,
|
|
112
|
+
maxInterval,
|
|
113
|
+
timeout: timeout || polling_1.DEFAULT_TIMEOUT,
|
|
114
|
+
backoff,
|
|
115
|
+
verbose,
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Create a classify job, wait for it to complete, and return the result.
|
|
120
|
+
*
|
|
121
|
+
* This is a convenience method that combines create() and waitForCompletion()
|
|
122
|
+
* into a single call for the most common end-to-end workflow.
|
|
123
|
+
*
|
|
124
|
+
* @param params - Classify job creation parameters
|
|
125
|
+
* @param options - Polling configuration and request options
|
|
126
|
+
* @returns The completed classify job with result populated
|
|
127
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
128
|
+
* @throws {PollingError} If the job fails
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```typescript
|
|
132
|
+
* import { LlamaCloud } from 'llama-cloud';
|
|
133
|
+
*
|
|
134
|
+
* const client = new LlamaCloud({ apiKey: '...' });
|
|
135
|
+
*
|
|
136
|
+
* const result = await client.classify.run({
|
|
137
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
138
|
+
* configuration: {
|
|
139
|
+
* rules: [{ type: 'invoice', description: 'contains invoice number' }],
|
|
140
|
+
* },
|
|
141
|
+
* }, { verbose: true });
|
|
142
|
+
*
|
|
143
|
+
* console.log(result.result);
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
async run(params, options) {
|
|
147
|
+
const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
|
|
148
|
+
const job = await this.create(params, requestOptions);
|
|
149
|
+
const getQuery = {};
|
|
150
|
+
if (params.organization_id !== undefined) {
|
|
151
|
+
getQuery.organization_id = params.organization_id;
|
|
152
|
+
}
|
|
153
|
+
if (params.project_id !== undefined) {
|
|
154
|
+
getQuery.project_id = params.project_id;
|
|
155
|
+
}
|
|
156
|
+
return await this.waitForCompletion(job.id, getQuery, {
|
|
157
|
+
pollingInterval,
|
|
158
|
+
maxInterval,
|
|
159
|
+
timeout: timeout || polling_1.DEFAULT_TIMEOUT,
|
|
160
|
+
backoff,
|
|
161
|
+
verbose,
|
|
162
|
+
...requestOptions,
|
|
163
|
+
});
|
|
164
|
+
}
|
|
52
165
|
}
|
|
53
166
|
exports.Classify = Classify;
|
|
54
167
|
//# sourceMappingURL=classify.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classify.js","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA8F;AAE9F,oDAA8C;
|
|
1
|
+
{"version":3,"file":"classify.js","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA8F;AAE9F,oDAA8C;AAC9C,gDAAqF;AAErF,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,4BAAqC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CACD,KAAa,EACb,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,iBAAiB,CACrB,KAAa,EACb,KAAyB,EACzB,OAAyC;QAEzC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErG,MAAM,SAAS,GAAG,KAAK,IAAkC,EAAE;YACzD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,CAAC,GAAwB,EAAW,EAAE;YACvD,OAAO,GAAG,CAAC,MAAM,KAAK,WAAW,CAAC;QACpC,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,GAAwB,EAAW,EAAE;YACpD,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC;QACjC,CAAC,CAAC;QAEF,MAAM,eAAe,GAAG,CAAC,GAAwB,EAAU,EAAE;YAC3D,MAAM,UAAU,GAAG,CAAC,OAAO,KAAK,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACtE,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC;QAEF,OAAO,MAAM,IAAA,2BAAiB,EAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,EAAE;YAC9E,eAAe;YACf,WAAW;YACX,OAAO,EAAE,OAAO,IAAI,yBAAe;YACnC,OAAO;YACP,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,GAAG,CACP,MAA4B,EAC5B,OAAyC;QAEzC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAsB,EAAE,CAAC;QACvC,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,QAAQ,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QACpD,CAAC;QACD,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACpC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QAC1C,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE;YACpD,eAAe;YACf,WAAW;YACX,OAAO,EAAE,OAAO,IAAI,yBAAe;YACnC,OAAO;YACP,OAAO;YACP,GAAG,cAAc;SAClB,CAAC,CAAC;IACL,CAAC;CACF;AAtLD,4BAsLC"}
|
package/resources/classify.mjs
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { APIResource } from "../core/resource.mjs";
|
|
3
3
|
import { PaginatedCursor } from "../core/pagination.mjs";
|
|
4
4
|
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
import { pollUntilComplete, DEFAULT_TIMEOUT } from "../core/polling.mjs";
|
|
5
6
|
export class Classify extends APIResource {
|
|
6
7
|
/**
|
|
7
8
|
* Create a classify job.
|
|
@@ -16,6 +17,11 @@ export class Classify extends APIResource {
|
|
|
16
17
|
*
|
|
17
18
|
* The job runs asynchronously. Poll `GET /classify/{job_id}` to check status and
|
|
18
19
|
* retrieve results.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* const classify = await client.classify.create();
|
|
24
|
+
* ```
|
|
19
25
|
*/
|
|
20
26
|
create(params, options) {
|
|
21
27
|
const { organization_id, project_id, ...body } = params;
|
|
@@ -30,6 +36,14 @@ export class Classify extends APIResource {
|
|
|
30
36
|
*
|
|
31
37
|
* Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
|
|
32
38
|
* range.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* // Automatically fetches more pages as needed.
|
|
43
|
+
* for await (const classifyListResponse of client.classify.list()) {
|
|
44
|
+
* // ...
|
|
45
|
+
* }
|
|
46
|
+
* ```
|
|
33
47
|
*/
|
|
34
48
|
list(query = {}, options) {
|
|
35
49
|
return this._client.getAPIList('/api/v2/classify', (PaginatedCursor), {
|
|
@@ -42,9 +56,108 @@ export class Classify extends APIResource {
|
|
|
42
56
|
*
|
|
43
57
|
* Returns the job status, configuration, and classify result when complete. The
|
|
44
58
|
* result includes the matched document type, confidence score, and reasoning.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* const classify = await client.classify.get('job_id');
|
|
63
|
+
* ```
|
|
45
64
|
*/
|
|
46
65
|
get(jobID, query = {}, options) {
|
|
47
66
|
return this._client.get(path `/api/v2/classify/${jobID}`, { query, ...options });
|
|
48
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Wait for a classify job to complete by polling until it reaches a terminal state.
|
|
70
|
+
*
|
|
71
|
+
* @param jobID - The ID of the classify job to wait for
|
|
72
|
+
* @param query - Optional query parameters (organization_id, project_id)
|
|
73
|
+
* @param options - Polling configuration and request options
|
|
74
|
+
* @returns The completed classify job
|
|
75
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
76
|
+
* @throws {PollingError} If the job fails
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```typescript
|
|
80
|
+
* const job = await client.classify.create({
|
|
81
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
82
|
+
* configuration_id: 'cfg-...',
|
|
83
|
+
* });
|
|
84
|
+
*
|
|
85
|
+
* const completed = await client.classify.waitForCompletion(job.id, undefined, { verbose: true });
|
|
86
|
+
* console.log(completed.result);
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
async waitForCompletion(jobID, query, options) {
|
|
90
|
+
const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
|
|
91
|
+
const getStatus = async () => {
|
|
92
|
+
return await this.get(jobID, query, requestOptions);
|
|
93
|
+
};
|
|
94
|
+
const isComplete = (job) => {
|
|
95
|
+
return job.status === 'COMPLETED';
|
|
96
|
+
};
|
|
97
|
+
const isError = (job) => {
|
|
98
|
+
return job.status === 'FAILED';
|
|
99
|
+
};
|
|
100
|
+
const getErrorMessage = (job) => {
|
|
101
|
+
const errorParts = [`Job ${jobID} failed with status: ${job.status}`];
|
|
102
|
+
if (job.error_message) {
|
|
103
|
+
errorParts.push(`Error: ${job.error_message}`);
|
|
104
|
+
}
|
|
105
|
+
return errorParts.join(' | ');
|
|
106
|
+
};
|
|
107
|
+
return await pollUntilComplete(getStatus, isComplete, isError, getErrorMessage, {
|
|
108
|
+
pollingInterval,
|
|
109
|
+
maxInterval,
|
|
110
|
+
timeout: timeout || DEFAULT_TIMEOUT,
|
|
111
|
+
backoff,
|
|
112
|
+
verbose,
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Create a classify job, wait for it to complete, and return the result.
|
|
117
|
+
*
|
|
118
|
+
* This is a convenience method that combines create() and waitForCompletion()
|
|
119
|
+
* into a single call for the most common end-to-end workflow.
|
|
120
|
+
*
|
|
121
|
+
* @param params - Classify job creation parameters
|
|
122
|
+
* @param options - Polling configuration and request options
|
|
123
|
+
* @returns The completed classify job with result populated
|
|
124
|
+
* @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
|
|
125
|
+
* @throws {PollingError} If the job fails
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```typescript
|
|
129
|
+
* import { LlamaCloud } from 'llama-cloud';
|
|
130
|
+
*
|
|
131
|
+
* const client = new LlamaCloud({ apiKey: '...' });
|
|
132
|
+
*
|
|
133
|
+
* const result = await client.classify.run({
|
|
134
|
+
* file_input: 'dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
|
|
135
|
+
* configuration: {
|
|
136
|
+
* rules: [{ type: 'invoice', description: 'contains invoice number' }],
|
|
137
|
+
* },
|
|
138
|
+
* }, { verbose: true });
|
|
139
|
+
*
|
|
140
|
+
* console.log(result.result);
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
async run(params, options) {
|
|
144
|
+
const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
|
|
145
|
+
const job = await this.create(params, requestOptions);
|
|
146
|
+
const getQuery = {};
|
|
147
|
+
if (params.organization_id !== undefined) {
|
|
148
|
+
getQuery.organization_id = params.organization_id;
|
|
149
|
+
}
|
|
150
|
+
if (params.project_id !== undefined) {
|
|
151
|
+
getQuery.project_id = params.project_id;
|
|
152
|
+
}
|
|
153
|
+
return await this.waitForCompletion(job.id, getQuery, {
|
|
154
|
+
pollingInterval,
|
|
155
|
+
maxInterval,
|
|
156
|
+
timeout: timeout || DEFAULT_TIMEOUT,
|
|
157
|
+
backoff,
|
|
158
|
+
verbose,
|
|
159
|
+
...requestOptions,
|
|
160
|
+
});
|
|
161
|
+
}
|
|
49
162
|
}
|
|
50
163
|
//# sourceMappingURL=classify.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"classify.mjs","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"classify.mjs","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;OACR,EAAE,iBAAiB,EAAkB,eAAe,EAAE;AAE7D,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,eAAqC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CACD,KAAa,EACb,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,iBAAiB,CACrB,KAAa,EACb,KAAyB,EACzB,OAAyC;QAEzC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErG,MAAM,SAAS,GAAG,KAAK,IAAkC,EAAE;YACzD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,CAAC,GAAwB,EAAW,EAAE;YACvD,OAAO,GAAG,CAAC,MAAM,KAAK,WAAW,CAAC;QACpC,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,GAAwB,EAAW,EAAE;YACpD,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC;QACjC,CAAC,CAAC;QAEF,MAAM,eAAe,GAAG,CAAC,GAAwB,EAAU,EAAE;YAC3D,MAAM,UAAU,GAAG,CAAC,OAAO,KAAK,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACtE,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC;QAEF,OAAO,MAAM,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,EAAE;YAC9E,eAAe;YACf,WAAW;YACX,OAAO,EAAE,OAAO,IAAI,eAAe;YACnC,OAAO;YACP,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,GAAG,CACP,MAA4B,EAC5B,OAAyC;QAEzC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAsB,EAAE,CAAC;QACvC,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,QAAQ,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QACpD,CAAC;QACD,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACpC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QAC1C,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE;YACpD,eAAe;YACf,WAAW;YACX,OAAO,EAAE,OAAO,IAAI,eAAe;YACnC,OAAO;YACP,OAAO;YACP,GAAG,cAAc;SAClB,CAAC,CAAC;IACL,CAAC;CACF"}
|