@llamaindex/llama-cloud 1.8.0 → 2.0.0

package/src/resources/extraction/jobs.ts

@@ -1,414 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../../core/resource';
-import * as FilesAPI from '../files';
-import * as RunsAPI from './runs';
-import * as ExtractionAgentsAPI from './extraction-agents/extraction-agents';
-import { APIPromise } from '../../core/api-promise';
-import { type Uploadable } from '../../core/uploads';
-import { RequestOptions } from '../../internal/request-options';
-import { multipartFormRequestOptions } from '../../internal/uploads';
-import { path } from '../../internal/utils/path';
-import { pollUntilComplete, PollingOptions, DEFAULT_TIMEOUT } from '../../core/polling';
-
-export class Jobs extends APIResource {
-  /**
-   * Run Job
-   */
-  create(params: JobCreateParams, options?: RequestOptions): APIPromise<ExtractJob> {
-    const { from_ui, ...body } = params;
-    return this._client.post('/api/v1/extraction/jobs', { query: { from_ui }, body, ...options });
-  }
-
-  /**
-   * List Jobs
-   */
-  list(query: JobListParams, options?: RequestOptions): APIPromise<JobListResponse> {
-    return this._client.get('/api/v1/extraction/jobs', { query, ...options });
-  }
-
-  /**
-   * Run Job On File
-   */
-  file(params: JobFileParams, options?: RequestOptions): APIPromise<ExtractJob> {
-    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: string, options?: RequestOptions): APIPromise<ExtractJob> {
-    return this._client.get(path`/api/v1/extraction/jobs/${jobID}`, options);
-  }
-
-  /**
-   * Get Job Result
-   */
-  getResult(
-    jobID: string,
-    query: JobGetResultParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<JobGetResultResponse> {
-    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: string, options?: PollingOptions & RequestOptions): Promise<ExtractJob> {
-    const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
-
-    const getStatus = async (): Promise<ExtractJob> => {
-      return await this.get(jobID, requestOptions);
-    };
-
-    const isComplete = (job: ExtractJob): boolean => {
-      return job.status === 'SUCCESS' || job.status === 'PARTIAL_SUCCESS';
-    };
-
-    const isError = (job: ExtractJob): boolean => {
-      return job.status === 'ERROR' || job.status === 'CANCELLED';
-    };
-
-    const getErrorMessage = (job: ExtractJob): string => {
-      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: JobCreateParams,
-    options?: PollingOptions & RequestOptions,
-  ): Promise<JobGetResultResponse> {
-    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 || DEFAULT_TIMEOUT,
-      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: JobCreateParams,
-    options?: PollingOptions & RequestOptions,
-  ): Promise<JobGetResultResponse> {
-    return await this.createAndWait(params, options);
-  }
-}
-
-/**
- * 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.running'
-    | 'parse.success'
-    | 'parse.error'
-    | 'parse.partial_success'
-    | 'parse.cancelled'
-    | 'classify.pending'
-    | 'classify.success'
-    | 'classify.error'
-    | 'classify.partial_success'
-    | 'classify.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,
-  };
-}