@llamaindex/llama-cloud 0.14.1

package/resources/extraction/jobs.d.ts

@@ -0,0 +1,280 @@
+import { APIResource } from "../../core/resource.js";
+import * as FilesAPI from "../files.js";
+import * as RunsAPI from "./runs.js";
+import * as ExtractionAgentsAPI from "./extraction-agents/extraction-agents.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { type Uploadable } from "../../core/uploads.js";
+import { RequestOptions } from "../../internal/request-options.js";
+import { PollingOptions } from "../../core/polling.js";
+export declare class Jobs extends APIResource {
+    /**
+     * Run Job
+     */
+    create(params: JobCreateParams, options?: RequestOptions): APIPromise<ExtractJob>;
+    /**
+     * List Jobs
+     */
+    list(query: JobListParams, options?: RequestOptions): APIPromise<JobListResponse>;
+    /**
+     * Run Job On File
+     */
+    file(params: JobFileParams, options?: RequestOptions): APIPromise<ExtractJob>;
+    /**
+     * Get Job
+     */
+    get(jobID: string, options?: RequestOptions): APIPromise<ExtractJob>;
+    /**
+     * Get Job Result
+     */
+    getResult(jobID: string, query?: JobGetResultParams | null | undefined, options?: RequestOptions): APIPromise<JobGetResultResponse>;
+    /**
+     * Wait for an extraction job to complete by polling until it reaches a terminal state.
+     *
+     * This method polls the job status at regular intervals until the job completes
+     * successfully or fails. It uses configurable backoff strategies to optimize
+     * polling behavior.
+     *
+     * @param jobID - The ID of the extraction job to wait for
+     * @param options - Polling configuration options
+     * @returns The completed ExtractJob
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Create an extraction job
+     * const job = await client.extraction.jobs.create({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * });
+     *
+     * // Wait for it to complete
+     * const completedJob = await client.extraction.jobs.waitForCompletion(
+     *   job.id,
+     *   { verbose: true }
+     * );
+     *
+     * // Get the result
+     * const result = await client.extraction.jobs.getResult(job.id);
+     * ```
+     */
+    waitForCompletion(jobID: string, options?: PollingOptions & RequestOptions): Promise<ExtractJob>;
+    /**
+     * Create an extraction job and wait for it to complete, returning the result.
+     *
+     * This is a convenience method that combines create(), waitForCompletion(),
+     * and getResult() into a single call for the most common end-to-end workflow.
+     *
+     * @param params - Job creation parameters
+     * @param options - Polling configuration and request options
+     * @returns The extraction result (JobGetResultResponse)
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // One-shot: create job, wait for completion, and get result
+     * const result = await client.extraction.jobs.createAndWait({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * }, { verbose: true });
+     *
+     * // Result is ready to use immediately
+     * console.log(result.data);
+     * ```
+     */
+    createAndWait(params: JobCreateParams, options?: PollingOptions & RequestOptions): Promise<JobGetResultResponse>;
+    /**
+     * Create an extraction job and wait for it to complete, returning the result.
+     *
+     * This is an alias for createAndWait() that provides a more concise API.
+     *
+     * @param params - Job creation parameters
+     * @param options - Polling configuration and request options
+     * @returns The extraction result (JobGetResultResponse)
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // One-shot: create job, wait for completion, and get result
+     * const result = await client.extraction.jobs.extract({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * }, { verbose: true });
+     *
+     * // Result is ready to use immediately
+     * console.log(result.data);
+     * ```
+     */
+    extract(params: JobCreateParams, options?: PollingOptions & RequestOptions): Promise<JobGetResultResponse>;
+}
+/**
+ * Schema for an extraction job.
+ */
+export interface ExtractJob {
+    /**
+     * The id of the extraction job
+     */
+    id: string;
+    /**
+     * The agent that the job was run on.
+     */
+    extraction_agent: ExtractionAgentsAPI.ExtractAgent;
+    /**
+     * The status of the extraction job
+     */
+    status: 'PENDING' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED';
+    /**
+     * The error that occurred during extraction
+     */
+    error?: string | null;
+    /**
+     * @deprecated Schema for a file.
+     */
+    file?: FilesAPI.File | null;
+    /**
+     * The id of the file that the extract was extracted from
+     */
+    file_id?: string | null;
+}
+/**
+ * Allows the user to configure webhook options for notifications and callbacks.
+ */
+export interface WebhookConfiguration {
+    /**
+     * List of event names to subscribe to
+     */
+    webhook_events?: Array<'extract.pending' | 'extract.success' | 'extract.error' | 'extract.partial_success' | 'extract.cancelled' | 'parse.pending' | 'parse.success' | 'parse.error' | 'parse.partial_success' | 'parse.cancelled' | 'unmapped_event'> | null;
+    /**
+     * Custom HTTP headers to include with webhook requests.
+     */
+    webhook_headers?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * The output format to use for the webhook. Defaults to string if none supplied.
+     * Currently supported values: string, json
+     */
+    webhook_output_format?: string | null;
+    /**
+     * The URL to send webhook notifications to.
+     */
+    webhook_url?: string | null;
+}
+export type JobListResponse = Array<ExtractJob>;
+/**
+ * Schema for an extraction resultset.
+ */
+export interface JobGetResultResponse {
+    /**
+     * The data extracted from the file
+     */
+    data: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    } | Array<{
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    }> | null;
+    /**
+     * The id of the extraction agent
+     */
+    extraction_agent_id: string;
+    /**
+     * The metadata extracted from the file
+     */
+    extraction_metadata: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    };
+    /**
+     * The id of the extraction run
+     */
+    run_id: string;
+}
+export interface JobCreateParams {
+    /**
+     * Body param: The id of the extraction agent
+     */
+    extraction_agent_id: string;
+    /**
+     * Body param: The id of the file
+     */
+    file_id: string;
+    /**
+     * Query param
+     */
+    from_ui?: boolean;
+    /**
+     * Body param: Configuration parameters for the extraction agent.
+     */
+    config_override?: RunsAPI.ExtractConfig | null;
+    /**
+     * Body param: The data schema to override the extraction agent's data schema with
+     */
+    data_schema_override?: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    } | string | null;
+    /**
+     * Body param: The priority for the request. This field may be ignored or
+     * overwritten depending on the organization tier.
+     */
+    priority?: 'low' | 'medium' | 'high' | 'critical' | null;
+    /**
+     * Body param: The outbound webhook configurations
+     */
+    webhook_configurations?: Array<WebhookConfiguration> | null;
+}
+export interface JobListParams {
+    extraction_agent_id: string;
+}
+export interface JobFileParams {
+    /**
+     * Body param: The id of the extraction agent
+     */
+    extraction_agent_id: string;
+    /**
+     * Body param: The file to run the job on
+     */
+    file: Uploadable;
+    /**
+     * Query param
+     */
+    from_ui?: boolean;
+    /**
+     * Body param: The config to override the extraction agent's config with as a JSON
+     * string
+     */
+    config_override?: string | null;
+    /**
+     * Body param: The data schema to override the extraction agent's data schema with
+     * as a JSON string
+     */
+    data_schema_override?: string | null;
+}
+export interface JobGetResultParams {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export declare namespace Jobs {
+    export { type ExtractJob as ExtractJob, type WebhookConfiguration as WebhookConfiguration, type JobListResponse as JobListResponse, type JobGetResultResponse as JobGetResultResponse, type JobCreateParams as JobCreateParams, type JobListParams as JobListParams, type JobFileParams as JobFileParams, type JobGetResultParams as JobGetResultParams, };
+}
+//# sourceMappingURL=jobs.d.ts.map

package/resources/extraction/jobs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../src/resources/extraction/jobs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,OAAO;OACZ,KAAK,mBAAmB;OACxB,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;OAGlB,EAAqB,cAAc,EAAE;AAE5C,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAKjF;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIjF;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAQ7E;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAIpE;;OAEG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAgCtG;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CACjB,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GACxC,OAAO,CAAC,oBAAoB,CAAC;IAoBhC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,OAAO,CACX,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GACxC,OAAO,CAAC,oBAAoB,CAAC;CAGjC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,CAAC,YAAY,CAAC;IAEnD;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,iBAAiB,GAAG,WAAW,CAAC;IAE1E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAClB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,yBAAyB,GACzB,mBAAmB,GACnB,eAAe,GACf,eAAe,GACf,aAAa,GACb,uBAAuB,GACvB,iBAAiB,GACjB,gBAAgB,CACnB,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EACA;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,GACjG,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC,GACxG,IAAI,CAAC;IAET;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE;QACnB,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;KAC/F,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,oBAAoB,CAAC,EACjB;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,GACjG,MAAM,GACN,IAAI,CAAC;IAET;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,aAAa;IAC5B,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/extraction/jobs.js

@@ -0,0 +1,179 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Jobs = void 0;
+const resource_1 = require("../../core/resource.js");
+const uploads_1 = require("../../internal/uploads.js");
+const path_1 = require("../../internal/utils/path.js");
+const polling_1 = require("../../core/polling.js");
+class Jobs extends resource_1.APIResource {
+    /**
+     * Run Job
+     */
+    create(params, options) {
+        const { from_ui, ...body } = params;
+        return this._client.post('/api/v1/extraction/jobs', { query: { from_ui }, body, ...options });
+    }
+    /**
+     * List Jobs
+     */
+    list(query, options) {
+        return this._client.get('/api/v1/extraction/jobs', { query, ...options });
+    }
+    /**
+     * Run Job On File
+     */
+    file(params, options) {
+        const { from_ui, ...body } = params;
+        return this._client.post('/api/v1/extraction/jobs/file', (0, uploads_1.multipartFormRequestOptions)({ query: { from_ui }, body, ...options }, this._client));
+    }
+    /**
+     * Get Job
+     */
+    get(jobID, options) {
+        return this._client.get((0, path_1.path) `/api/v1/extraction/jobs/${jobID}`, options);
+    }
+    /**
+     * Get Job Result
+     */
+    getResult(jobID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/api/v1/extraction/jobs/${jobID}/result`, { query, ...options });
+    }
+    /**
+     * Wait for an extraction job to complete by polling until it reaches a terminal state.
+     *
+     * This method polls the job status at regular intervals until the job completes
+     * successfully or fails. It uses configurable backoff strategies to optimize
+     * polling behavior.
+     *
+     * @param jobID - The ID of the extraction job to wait for
+     * @param options - Polling configuration options
+     * @returns The completed ExtractJob
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Create an extraction job
+     * const job = await client.extraction.jobs.create({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * });
+     *
+     * // Wait for it to complete
+     * const completedJob = await client.extraction.jobs.waitForCompletion(
+     *   job.id,
+     *   { verbose: true }
+     * );
+     *
+     * // Get the result
+     * const result = await client.extraction.jobs.getResult(job.id);
+     * ```
+     */
+    async waitForCompletion(jobID, options) {
+        const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
+        const getStatus = async () => {
+            return await this.get(jobID, requestOptions);
+        };
+        const isComplete = (job) => {
+            return job.status === 'SUCCESS' || job.status === 'PARTIAL_SUCCESS';
+        };
+        const isError = (job) => {
+            return job.status === 'ERROR' || job.status === 'CANCELLED';
+        };
+        const getErrorMessage = (job) => {
+            const errorParts = [`Job ${jobID} failed with status: ${job.status}`];
+            if (job.error) {
+                errorParts.push(`Error: ${job.error}`);
+            }
+            return errorParts.join(' | ');
+        };
+        return await (0, polling_1.pollUntilComplete)(getStatus, isComplete, isError, getErrorMessage, {
+            pollingInterval,
+            maxInterval,
+            timeout,
+            backoff,
+            verbose,
+        });
+    }
+    /**
+     * Create an extraction job and wait for it to complete, returning the result.
+     *
+     * This is a convenience method that combines create(), waitForCompletion(),
+     * and getResult() into a single call for the most common end-to-end workflow.
+     *
+     * @param params - Job creation parameters
+     * @param options - Polling configuration and request options
+     * @returns The extraction result (JobGetResultResponse)
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // One-shot: create job, wait for completion, and get result
+     * const result = await client.extraction.jobs.createAndWait({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * }, { verbose: true });
+     *
+     * // Result is ready to use immediately
+     * console.log(result.data);
+     * ```
+     */
+    async createAndWait(params, options) {
+        const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
+        // Create the job
+        const job = await this.create(params, requestOptions);
+        // Wait for completion
+        await this.waitForCompletion(job.id, {
+            pollingInterval,
+            maxInterval,
+            timeout: timeout || 2000.0,
+            backoff,
+            verbose,
+            ...requestOptions,
+        });
+        // Get and return the result
+        return await this.getResult(job.id, {}, requestOptions);
+    }
+    /**
+     * Create an extraction job and wait for it to complete, returning the result.
+     *
+     * This is an alias for createAndWait() that provides a more concise API.
+     *
+     * @param params - Job creation parameters
+     * @param options - Polling configuration and request options
+     * @returns The extraction result (JobGetResultResponse)
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // One-shot: create job, wait for completion, and get result
+     * const result = await client.extraction.jobs.extract({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * }, { verbose: true });
+     *
+     * // Result is ready to use immediately
+     * console.log(result.data);
+     * ```
+     */
+    async extract(params, options) {
+        return await this.createAndWait(params, options);
+    }
+}
+exports.Jobs = Jobs;
+//# sourceMappingURL=jobs.js.map

package/resources/extraction/jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../src/resources/extraction/jobs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAOlD,uDAAqE;AACrE,uDAAiD;AACjD,mDAAuE;AAEvE,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAuB,EAAE,OAAwB;QACtD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,KAAoB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAqB,EAAE,OAAwB;QAClD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,8BAA8B,EAC9B,IAAA,qCAA2B,EAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACpF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,KAAa,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,SAAS,CACP,KAAa,EACb,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,KAAK,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,iBAAiB,CAAC,KAAa,EAAE,OAAyC;QAC9E,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,IAAyB,EAAE;YAChD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,CAAC,GAAe,EAAW,EAAE;YAC9C,OAAO,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,CAAC;QACtE,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,GAAe,EAAW,EAAE;YAC3C,OAAO,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,CAAC;QAC9D,CAAC,CAAC;QAEF,MAAM,eAAe,GAAG,CAAC,GAAe,EAAU,EAAE;YAClD,MAAM,UAAU,GAAG,CAAC,OAAO,KAAK,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACtE,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;gBACd,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACzC,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;YACP,OAAO;YACP,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,aAAa,CACjB,MAAuB,EACvB,OAAyC;QAEzC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErG,iBAAiB;QACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAEtD,sBAAsB;QACtB,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE;YACnC,eAAe;YACf,WAAW;YACX,OAAO,EAAE,OAAO,IAAI,MAAM;YAC1B,OAAO;YACP,OAAO;YACP,GAAG,cAAc;SAClB,CAAC,CAAC;QAEH,4BAA4B;QAC5B,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,OAAO,CACX,MAAuB,EACvB,OAAyC;QAEzC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF;AApMD,oBAoMC"}

package/resources/extraction/jobs.mjs

@@ -0,0 +1,175 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { multipartFormRequestOptions } from "../../internal/uploads.mjs";
+import { path } from "../../internal/utils/path.mjs";
+import { pollUntilComplete } from "../../core/polling.mjs";
+export class Jobs extends APIResource {
+    /**
+     * Run Job
+     */
+    create(params, options) {
+        const { from_ui, ...body } = params;
+        return this._client.post('/api/v1/extraction/jobs', { query: { from_ui }, body, ...options });
+    }
+    /**
+     * List Jobs
+     */
+    list(query, options) {
+        return this._client.get('/api/v1/extraction/jobs', { query, ...options });
+    }
+    /**
+     * Run Job On File
+     */
+    file(params, options) {
+        const { from_ui, ...body } = params;
+        return this._client.post('/api/v1/extraction/jobs/file', multipartFormRequestOptions({ query: { from_ui }, body, ...options }, this._client));
+    }
+    /**
+     * Get Job
+     */
+    get(jobID, options) {
+        return this._client.get(path `/api/v1/extraction/jobs/${jobID}`, options);
+    }
+    /**
+     * Get Job Result
+     */
+    getResult(jobID, query = {}, options) {
+        return this._client.get(path `/api/v1/extraction/jobs/${jobID}/result`, { query, ...options });
+    }
+    /**
+     * Wait for an extraction job to complete by polling until it reaches a terminal state.
+     *
+     * This method polls the job status at regular intervals until the job completes
+     * successfully or fails. It uses configurable backoff strategies to optimize
+     * polling behavior.
+     *
+     * @param jobID - The ID of the extraction job to wait for
+     * @param options - Polling configuration options
+     * @returns The completed ExtractJob
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Create an extraction job
+     * const job = await client.extraction.jobs.create({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * });
+     *
+     * // Wait for it to complete
+     * const completedJob = await client.extraction.jobs.waitForCompletion(
+     *   job.id,
+     *   { verbose: true }
+     * );
+     *
+     * // Get the result
+     * const result = await client.extraction.jobs.getResult(job.id);
+     * ```
+     */
+    async waitForCompletion(jobID, options) {
+        const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
+        const getStatus = async () => {
+            return await this.get(jobID, requestOptions);
+        };
+        const isComplete = (job) => {
+            return job.status === 'SUCCESS' || job.status === 'PARTIAL_SUCCESS';
+        };
+        const isError = (job) => {
+            return job.status === 'ERROR' || job.status === 'CANCELLED';
+        };
+        const getErrorMessage = (job) => {
+            const errorParts = [`Job ${jobID} failed with status: ${job.status}`];
+            if (job.error) {
+                errorParts.push(`Error: ${job.error}`);
+            }
+            return errorParts.join(' | ');
+        };
+        return await pollUntilComplete(getStatus, isComplete, isError, getErrorMessage, {
+            pollingInterval,
+            maxInterval,
+            timeout,
+            backoff,
+            verbose,
+        });
+    }
+    /**
+     * Create an extraction job and wait for it to complete, returning the result.
+     *
+     * This is a convenience method that combines create(), waitForCompletion(),
+     * and getResult() into a single call for the most common end-to-end workflow.
+     *
+     * @param params - Job creation parameters
+     * @param options - Polling configuration and request options
+     * @returns The extraction result (JobGetResultResponse)
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // One-shot: create job, wait for completion, and get result
+     * const result = await client.extraction.jobs.createAndWait({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * }, { verbose: true });
+     *
+     * // Result is ready to use immediately
+     * console.log(result.data);
+     * ```
+     */
+    async createAndWait(params, options) {
+        const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
+        // Create the job
+        const job = await this.create(params, requestOptions);
+        // Wait for completion
+        await this.waitForCompletion(job.id, {
+            pollingInterval,
+            maxInterval,
+            timeout: timeout || 2000.0,
+            backoff,
+            verbose,
+            ...requestOptions,
+        });
+        // Get and return the result
+        return await this.getResult(job.id, {}, requestOptions);
+    }
+    /**
+     * Create an extraction job and wait for it to complete, returning the result.
+     *
+     * This is an alias for createAndWait() that provides a more concise API.
+     *
+     * @param params - Job creation parameters
+     * @param options - Polling configuration and request options
+     * @returns The extraction result (JobGetResultResponse)
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails or is cancelled
+     *
+     * @example
+     * ```typescript
+     * import { LlamaCloud } from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // One-shot: create job, wait for completion, and get result
+     * const result = await client.extraction.jobs.extract({
+     *   extraction_agent_id: 'agent_id',
+     *   file_id: 'file_id'
+     * }, { verbose: true });
+     *
+     * // Result is ready to use immediately
+     * console.log(result.data);
+     * ```
+     */
+    async extract(params, options) {
+        return await this.createAndWait(params, options);
+    }
+}
+//# sourceMappingURL=jobs.mjs.map

package/resources/extraction/jobs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.mjs","sourceRoot":"","sources":["../../src/resources/extraction/jobs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAOf,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;OACR,EAAE,iBAAiB,EAAkB;AAE5C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAuB,EAAE,OAAwB;QACtD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,KAAoB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAqB,EAAE,OAAwB;QAClD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,8BAA8B,EAC9B,2BAA2B,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACpF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,KAAa,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,SAAS,CACP,KAAa,EACb,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,KAAK,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,iBAAiB,CAAC,KAAa,EAAE,OAAyC;QAC9E,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,IAAyB,EAAE;YAChD,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,CAAC,GAAe,EAAW,EAAE;YAC9C,OAAO,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,CAAC;QACtE,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,GAAe,EAAW,EAAE;YAC3C,OAAO,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,CAAC;QAC9D,CAAC,CAAC;QAEF,MAAM,eAAe,GAAG,CAAC,GAAe,EAAU,EAAE;YAClD,MAAM,UAAU,GAAG,CAAC,OAAO,KAAK,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACtE,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;gBACd,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACzC,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;YACP,OAAO;YACP,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,aAAa,CACjB,MAAuB,EACvB,OAAyC;QAEzC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAErG,iBAAiB;QACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAEtD,sBAAsB;QACtB,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE;YACnC,eAAe;YACf,WAAW;YACX,OAAO,EAAE,OAAO,IAAI,MAAM;YAC1B,OAAO;YACP,OAAO;YACP,GAAG,cAAc;SAClB,CAAC,CAAC;QAEH,4BAA4B;QAC5B,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,OAAO,CACX,MAAuB,EACvB,OAAyC;QAEzC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF"}