@llamaindex/llama-cloud 2.8.0 → 2.9.1

package/src/resources/beta/sheets.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 import * as FilesAPI from '../files';
-import * as ParsingAPI from '../parsing';
 import { APIPromise } from '../../core/api-promise';
 import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -11,15 +10,14 @@ import { pollUntilComplete, PollingOptions, DEFAULT_TIMEOUT } from '../../core/p
 
 export class Sheets extends APIResource {
   /**
-   * Create a spreadsheet parsing job. Experimental: not production-ready and subject
-   * to change.
+   * Create a spreadsheet parsing job.
    *
-   * @example
-   * ```ts
-   * const sheetsJob = await client.beta.sheets.create({
-   *   file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * });
-   * ```
+   * Provide at most one of `configuration` (an inline parsing configuration) or
+   * `configuration_id` (a saved configuration preset). If neither is provided, a
+   * default configuration is used. Optionally include `webhook_configurations` to
+   * receive `sheets.*` status notifications.
+   *
+   * @deprecated
    */
   create(params: SheetCreateParams, options?: RequestOptions): APIPromise<SheetsJob> {
     const { organization_id, project_id, ...body } = params;
@@ -31,16 +29,9 @@ export class Sheets extends APIResource {
   }
 
   /**
-   * List spreadsheet parsing jobs. Experimental: not production-ready and subject to
-   * change.
+   * List spreadsheet parsing jobs.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const sheetsJob of client.beta.sheets.list()) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     query: SheetListParams | null | undefined = {},
@@ -52,40 +43,12 @@ export class Sheets extends APIResource {
     });
   }
 
-  /**
-   * Delete a spreadsheet parsing job and its associated data. Experimental: not
-   * production-ready and subject to change.
-   *
-   * @example
-   * ```ts
-   * const response = await client.beta.sheets.deleteJob(
-   *   'spreadsheet_job_id',
-   * );
-   * ```
-   */
-  deleteJob(
-    spreadsheetJobID: string,
-    params: SheetDeleteJobParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<unknown> {
-    const { organization_id, project_id } = params ?? {};
-    return this._client.delete(path`/api/v1/beta/sheets/jobs/${spreadsheetJobID}`, {
-      query: { organization_id, project_id },
-      ...options,
-    });
-  }
-
   /**
    * Get a spreadsheet parsing job. When `include_results=True` (default), embeds
    * extracted regions and results if complete, skipping the separate `/results`
-   * call. Experimental: not production-ready and subject to change.
+   * call.
    *
-   * @example
-   * ```ts
-   * const sheetsJob = await client.beta.sheets.get(
-   *   'spreadsheet_job_id',
-   * );
-   * ```
+   * @deprecated
    */
   get(
     spreadsheetJobID: string,
@@ -96,20 +59,12 @@ export class Sheets extends APIResource {
   }
 
   /**
-   * Generate a presigned URL to download a specific extracted region. Experimental:
-   * not production-ready and subject to change.
+   * Generate a presigned URL to download a specific extracted region.
    *
-   * @example
-   * ```ts
-   * const presignedURL =
-   *   await client.beta.sheets.getResultTable('table', {
-   *     spreadsheet_job_id: 'spreadsheet_job_id',
-   *     region_id: 'region_id',
-   *   });
-   * ```
+   * @deprecated
    */
   getResultTable(
-    regionType: 'table' | 'extra' | 'cell_metadata',
+    regionType: 'cell_metadata' | 'extra' | 'table',
     params: SheetGetResultTableParams,
     options?: RequestOptions,
   ): APIPromise<FilesAPI.PresignedURL> {
@@ -120,6 +75,23 @@ export class Sheets extends APIResource {
     );
   }
 
+  /**
+   * Delete a spreadsheet parsing job and its associated data.
+   *
+   * @deprecated
+   */
+  deleteJob(
+    spreadsheetJobID: string,
+    params: SheetDeleteJobParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { organization_id, project_id } = params ?? {};
+    return this._client.delete(path`/api/v1/beta/sheets/jobs/${spreadsheetJobID}`, {
+      query: { organization_id, project_id },
+      ...options,
+    });
+  }
+
   /**
    * Create a spreadsheet parsing job and wait for it to complete, returning the job with results.
    *
@@ -244,7 +216,7 @@ export class Sheets extends APIResource {
 export type SheetsJobsPaginatedCursor = PaginatedCursor<SheetsJob>;
 
 /**
- * A spreadsheet parsing job
+ * A spreadsheet parsing job.
  */
 export interface SheetsJob {
   /**
@@ -253,9 +225,10 @@ export interface SheetsJob {
   id: string;
 
   /**
-   * Configuration for the parsing job
+   * Configuration applied to the parsing job (inline or resolved from a saved
+   * preset).
    */
-  config: SheetsParsingConfig;
+  configuration: SheetsParsingConfig;
 
   /**
    * When the job was created
@@ -275,7 +248,7 @@ export interface SheetsJob {
   /**
    * The status of the parsing job
    */
-  status: ParsingAPI.StatusEnum;
+  status: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS';
 
   /**
    * When the job was last updated
@@ -287,6 +260,16 @@ export interface SheetsJob {
    */
   user_id: string;
 
+  /**
+   * @deprecated Configuration for spreadsheet parsing and region extraction
+   */
+  config?: SheetsParsingConfig | null;
+
+  /**
+   * The saved product configuration ID used at create time, if any.
+   */
+  configuration_id?: string | null;
+
   /**
    * Any errors encountered
    */
@@ -297,6 +280,17 @@ export interface SheetsJob {
    */
   file?: FilesAPI.File | null;
 
+  /**
+   * Per-status entry timestamps. Returned only when requested via
+   * `?expand=metadata_state_transitions`.
+   */
+  metadata_state_transitions?: { [key: string]: unknown } | null;
+
+  /**
+   * Job-time parameters such as webhook configurations.
+   */
+  parameters?: SheetsJob.Parameters;
+
   /**
    * All extracted regions (populated when job is complete)
    */
@@ -314,6 +308,73 @@ export interface SheetsJob {
 }
 
 export namespace SheetsJob {
+  /**
+   * Job-time parameters such as webhook configurations.
+   */
+  export interface Parameters {
+    /**
+     * Webhook configurations for job status notifications.
+     */
+    webhook_configurations?: Array<Parameters.WebhookConfiguration> | null;
+  }
+
+  export namespace Parameters {
+    /**
+     * Configuration for a single outbound webhook endpoint.
+     */
+    export interface WebhookConfiguration {
+      /**
+       * Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
+       * events are delivered.
+       */
+      webhook_events?: Array<
+        | 'classify.cancelled'
+        | 'classify.error'
+        | 'classify.partial_success'
+        | 'classify.pending'
+        | 'classify.running'
+        | 'classify.success'
+        | 'extract.cancelled'
+        | 'extract.error'
+        | 'extract.partial_success'
+        | 'extract.pending'
+        | 'extract.success'
+        | 'parse.cancelled'
+        | 'parse.error'
+        | 'parse.partial_success'
+        | 'parse.pending'
+        | 'parse.running'
+        | 'parse.success'
+        | 'sheets.cancelled'
+        | 'sheets.error'
+        | 'sheets.partial_success'
+        | 'sheets.pending'
+        | 'sheets.success'
+        | 'split.cancelled'
+        | 'split.error'
+        | 'split.pending'
+        | 'split.processing'
+        | 'split.success'
+        | 'unmapped_event'
+      > | null;
+
+      /**
+       * Custom HTTP headers sent with each webhook request (e.g. auth tokens)
+       */
+      webhook_headers?: { [key: string]: string } | null;
+
+      /**
+       * Response format sent to the webhook: 'string' (default) or 'json'
+       */
+      webhook_output_format?: string | null;
+
+      /**
+       * URL to receive webhook POST notifications
+       */
+      webhook_url?: string | null;
+    }
+  }
+
   /**
    * A summary of a single extracted region from a spreadsheet
    */
@@ -442,12 +503,89 @@ export interface SheetCreateParams {
   project_id?: string | null;
 
   /**
-   * Body param: Configuration for the parsing job
+   * Body param: Configuration for spreadsheet parsing and region extraction
+   */
+  config?: SheetsParsingConfig | null;
+
+  /**
+   * Body param: Configuration for spreadsheet parsing and region extraction
+   */
+  configuration?: SheetsParsingConfig | null;
+
+  /**
+   * Body param: Saved configuration ID
    */
-  config?: SheetsParsingConfig;
+  configuration_id?: string | null;
+
+  /**
+   * Body param: Outbound webhook endpoints to notify on job status changes
+   */
+  webhook_configurations?: Array<SheetCreateParams.WebhookConfiguration> | null;
+}
+
+export namespace SheetCreateParams {
+  /**
+   * Configuration for a single outbound webhook endpoint.
+   */
+  export interface WebhookConfiguration {
+    /**
+     * Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
+     * events are delivered.
+     */
+    webhook_events?: Array<
+      | 'classify.cancelled'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.pending'
+      | 'classify.running'
+      | 'classify.success'
+      | 'extract.cancelled'
+      | 'extract.error'
+      | 'extract.partial_success'
+      | 'extract.pending'
+      | 'extract.success'
+      | 'parse.cancelled'
+      | 'parse.error'
+      | 'parse.partial_success'
+      | 'parse.pending'
+      | 'parse.running'
+      | 'parse.success'
+      | 'sheets.cancelled'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'split.cancelled'
+      | 'split.error'
+      | 'split.pending'
+      | 'split.processing'
+      | 'split.success'
+      | 'unmapped_event'
+    > | null;
+
+    /**
+     * Custom HTTP headers sent with each webhook request (e.g. auth tokens)
+     */
+    webhook_headers?: { [key: string]: string } | null;
+
+    /**
+     * Response format sent to the webhook: 'string' (default) or 'json'
+     */
+    webhook_output_format?: string | null;
+
+    /**
+     * URL to receive webhook POST notifications
+     */
+    webhook_url?: string | null;
+  }
 }
 
 export interface SheetListParams extends PaginatedCursorParams {
+  /**
+   * Filter by saved configuration ID
+   */
+  configuration_id?: string | null;
+
   /**
    * Include items created at or after this timestamp (inclusive)
    */
@@ -472,16 +610,16 @@ export interface SheetListParams extends PaginatedCursorParams {
   /**
    * Filter by job status
    */
-  status?: ParsingAPI.StatusEnum | null;
-}
-
-export interface SheetDeleteJobParams {
-  organization_id?: string | null;
-
-  project_id?: string | null;
+  status?: 'CANCELLED' | 'ERROR' | 'PARTIAL_SUCCESS' | 'PENDING' | 'SUCCESS' | null;
 }
 
 export interface SheetGetParams {
+  /**
+   * Optional fields to populate on the response. Valid values:
+   * metadata_state_transitions.
+   */
+  expand?: Array<string>;
+
   include_results?: boolean;
 
   organization_id?: string | null;
@@ -526,6 +664,12 @@ export interface SheetWaitForCompletionParams extends PollingOptions {
   project_id?: string | null;
 }
 
+export interface SheetDeleteJobParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
 export declare namespace Sheets {
   export {
     type SheetsJob as SheetsJob,
@@ -534,9 +678,9 @@ export declare namespace Sheets {
     type SheetsJobsPaginatedCursor as SheetsJobsPaginatedCursor,
     type SheetCreateParams as SheetCreateParams,
     type SheetListParams as SheetListParams,
-    type SheetDeleteJobParams as SheetDeleteJobParams,
     type SheetGetParams as SheetGetParams,
     type SheetGetResultTableParams as SheetGetResultTableParams,
+    type SheetDeleteJobParams as SheetDeleteJobParams,
     type SheetParseParams as SheetParseParams,
     type SheetWaitForCompletionParams as SheetWaitForCompletionParams,
   };

package/src/resources/beta/split.ts

@@ -506,7 +506,7 @@ export namespace SplitCreateParams {
        * be assigned to a defined category. 'omit': pages can be classified as
        * 'uncategorized' but are excluded from results.
        */
-      allow_uncategorized?: 'include' | 'forbid' | 'omit';
+      allow_uncategorized?: 'forbid' | 'include' | 'omit';
     }
   }
 }
@@ -534,7 +534,7 @@ export interface SplitListParams extends PaginatedCursorParams {
   /**
    * Filter by job status (pending, processing, completed, failed, cancelled)
    */
-  status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | null;
+  status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing' | null;
 }
 
 export interface SplitGetParams {

package/src/resources/classifier/jobs.ts

@@ -373,8 +373,9 @@ export namespace JobCreateParams {
   export interface WebhookConfiguration {
     /**
      * Events that trigger this webhook. Options: 'parse.success' (job completed),
-     * 'parse.failure' (job failed), 'parse.partial' (some pages failed). If not
-     * specified, webhook fires for all events
+     * 'parse.error' (job failed), 'parse.partial_success' (some pages failed),
+     * 'parse.pending', 'parse.running', 'parse.cancelled'. If not specified, webhook
+     * fires for all events
      */
     webhook_events?: Array<string> | null;
 
@@ -384,6 +385,12 @@ export namespace JobCreateParams {
      */
     webhook_headers?: { [key: string]: unknown } | null;
 
+    /**
+     * Format of the webhook payload body. 'string' (default) sends the payload as a
+     * JSON-encoded string; 'json' sends it as a JSON object.
+     */
+    webhook_output_format?: 'json' | 'string' | null;
+
     /**
      * HTTPS URL to receive webhook POST requests. Must be publicly accessible
      */

package/src/resources/classify.ts

@@ -281,9 +281,72 @@ export interface ClassifyCreateRequest {
   parse_job_id?: string | null;
 
   /**
-   * Idempotency key scoped to the project
+   * Idempotency key scoped to the project. Reusing a key returns the original job;
+   * the new request body is ignored.
    */
   transaction_id?: string | null;
+
+  /**
+   * Outbound webhook endpoints to notify on job status changes
+   */
+  webhook_configurations?: Array<ClassifyCreateRequest.WebhookConfiguration> | null;
+}
+
+export namespace ClassifyCreateRequest {
+  /**
+   * Configuration for a single outbound webhook endpoint.
+   */
+  export interface WebhookConfiguration {
+    /**
+     * Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
+     * events are delivered.
+     */
+    webhook_events?: Array<
+      | 'classify.cancelled'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.pending'
+      | 'classify.running'
+      | 'classify.success'
+      | 'extract.cancelled'
+      | 'extract.error'
+      | 'extract.partial_success'
+      | 'extract.pending'
+      | 'extract.success'
+      | 'parse.cancelled'
+      | 'parse.error'
+      | 'parse.partial_success'
+      | 'parse.pending'
+      | 'parse.running'
+      | 'parse.success'
+      | 'sheets.cancelled'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'split.cancelled'
+      | 'split.error'
+      | 'split.pending'
+      | 'split.processing'
+      | 'split.success'
+      | 'unmapped_event'
+    > | null;
+
+    /**
+     * Custom HTTP headers sent with each webhook request (e.g. auth tokens)
+     */
+    webhook_headers?: { [key: string]: string } | null;
+
+    /**
+     * Response format sent to the webhook: 'string' (default) or 'json'
+     */
+    webhook_output_format?: string | null;
+
+    /**
+     * URL to receive webhook POST notifications
+     */
+    webhook_url?: string | null;
+  }
 }
 
 /**
@@ -323,7 +386,7 @@ export interface ClassifyCreateResponse {
   /**
    * Whether the input was a file or parse job (FILE or PARSE_JOB)
    */
-  document_input_type: 'url' | 'file_id' | 'parse_job_id';
+  document_input_type: 'file_id' | 'parse_job_id' | 'url';
 
   /**
    * ID of the input file or parse job
@@ -338,7 +401,7 @@ export interface ClassifyCreateResponse {
   /**
    * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
    */
-  status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+  status: 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
 
   /**
    * User who created this job
@@ -398,7 +461,7 @@ export interface ClassifyListResponse {
   /**
    * Whether the input was a file or parse job (FILE or PARSE_JOB)
    */
-  document_input_type: 'url' | 'file_id' | 'parse_job_id';
+  document_input_type: 'file_id' | 'parse_job_id' | 'url';
 
   /**
    * ID of the input file or parse job
@@ -413,7 +476,7 @@ export interface ClassifyListResponse {
   /**
    * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
    */
-  status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+  status: 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
 
   /**
    * User who created this job
@@ -473,7 +536,7 @@ export interface ClassifyGetResponse {
   /**
    * Whether the input was a file or parse job (FILE or PARSE_JOB)
    */
-  document_input_type: 'url' | 'file_id' | 'parse_job_id';
+  document_input_type: 'file_id' | 'parse_job_id' | 'url';
 
   /**
    * ID of the input file or parse job
@@ -488,7 +551,7 @@ export interface ClassifyGetResponse {
   /**
    * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
    */
-  status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+  status: 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING';
 
   /**
    * User who created this job
@@ -568,9 +631,72 @@ export interface ClassifyCreateParams {
   parse_job_id?: string | null;
 
   /**
-   * Body param: Idempotency key scoped to the project
+   * Body param: Idempotency key scoped to the project. Reusing a key returns the
+   * original job; the new request body is ignored.
    */
   transaction_id?: string | null;
+
+  /**
+   * Body param: Outbound webhook endpoints to notify on job status changes
+   */
+  webhook_configurations?: Array<ClassifyCreateParams.WebhookConfiguration> | null;
+}
+
+export namespace ClassifyCreateParams {
+  /**
+   * Configuration for a single outbound webhook endpoint.
+   */
+  export interface WebhookConfiguration {
+    /**
+     * Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all
+     * events are delivered.
+     */
+    webhook_events?: Array<
+      | 'classify.cancelled'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.pending'
+      | 'classify.running'
+      | 'classify.success'
+      | 'extract.cancelled'
+      | 'extract.error'
+      | 'extract.partial_success'
+      | 'extract.pending'
+      | 'extract.success'
+      | 'parse.cancelled'
+      | 'parse.error'
+      | 'parse.partial_success'
+      | 'parse.pending'
+      | 'parse.running'
+      | 'parse.success'
+      | 'sheets.cancelled'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'split.cancelled'
+      | 'split.error'
+      | 'split.pending'
+      | 'split.processing'
+      | 'split.success'
+      | 'unmapped_event'
+    > | null;
+
+    /**
+     * Custom HTTP headers sent with each webhook request (e.g. auth tokens)
+     */
+    webhook_headers?: { [key: string]: string } | null;
+
+    /**
+     * Response format sent to the webhook: 'string' (default) or 'json'
+     */
+    webhook_output_format?: string | null;
+
+    /**
+     * URL to receive webhook POST notifications
+     */
+    webhook_url?: string | null;
+  }
 }
 
 export interface ClassifyListParams extends PaginatedCursorParams {
@@ -601,7 +727,7 @@ export interface ClassifyListParams extends PaginatedCursorParams {
   /**
    * Filter by job status
    */
-  status?: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | null;
+  status?: 'COMPLETED' | 'FAILED' | 'PENDING' | 'RUNNING' | null;
 }
 
 export interface ClassifyGetParams {