@llamaindex/llama-cloud 2.4.1 → 2.9.0

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,8 +10,14 @@ import { pollUntilComplete, PollingOptions, DEFAULT_TIMEOUT } from '../../core/p
 
 export class Sheets extends APIResource {
   /**
-   * Create a spreadsheet parsing job. Experimental: This endpoint is not yet ready
-   * for production use and is subject to change at any time.
+   * Create a spreadsheet parsing job.
+   *
+   * 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.
+   *
+   * Experimental: not production-ready and subject to change.
    *
    * @example
    * ```ts
@@ -31,8 +36,8 @@ export class Sheets extends APIResource {
   }
 
   /**
-   * List spreadsheet parsing jobs. Experimental: This endpoint is not yet ready for
-   * production use and is subject to change at any time.
+   * List spreadsheet parsing jobs. Experimental: not production-ready and subject to
+   * change.
    *
    * @example
    * ```ts
@@ -53,9 +58,8 @@ export class Sheets extends APIResource {
   }
 
   /**
-   * Delete a spreadsheet parsing job and its associated data. Experimental: This
-   * endpoint is not yet ready for production use and is subject to change at any
-   * time.
+   * Delete a spreadsheet parsing job and its associated data. Experimental: not
+   * production-ready and subject to change.
    *
    * @example
    * ```ts
@@ -77,14 +81,9 @@ export class Sheets extends APIResource {
   }
 
   /**
-   * Get a spreadsheet parsing job.
-   *
-   * When include_results=True (default), the response will include extracted regions
-   * and results if the job is complete, eliminating the need for a separate /results
-   * call.
-   *
-   * Experimental: This endpoint is not yet ready for production use and is subject
-   * to change at any time.
+   * 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.
    *
    * @example
    * ```ts
@@ -103,8 +102,7 @@ export class Sheets extends APIResource {
 
   /**
    * Generate a presigned URL to download a specific extracted region. Experimental:
-   * This endpoint is not yet ready for production use and is subject to change at
-   * any time.
+   * not production-ready and subject to change.
    *
    * @example
    * ```ts
@@ -251,7 +249,7 @@ export class Sheets extends APIResource {
 export type SheetsJobsPaginatedCursor = PaginatedCursor<SheetsJob>;
 
 /**
- * A spreadsheet parsing job
+ * A spreadsheet parsing job.
  */
 export interface SheetsJob {
   /**
@@ -260,9 +258,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
@@ -282,7 +281,7 @@ export interface SheetsJob {
   /**
    * The status of the parsing job
    */
-  status: ParsingAPI.StatusEnum;
+  status: 'PENDING' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED';
 
   /**
    * When the job was last updated
@@ -294,6 +293,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
    */
@@ -304,6 +313,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)
    */
@@ -321,6 +341,68 @@ 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<
+        | '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.running'
+        | 'classify.success'
+        | 'classify.error'
+        | 'classify.partial_success'
+        | 'classify.cancelled'
+        | 'sheets.pending'
+        | 'sheets.success'
+        | 'sheets.error'
+        | 'sheets.partial_success'
+        | 'sheets.cancelled'
+        | '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
    */
@@ -449,12 +531,84 @@ 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
    */
-  config?: SheetsParsingConfig;
+  configuration?: SheetsParsingConfig | null;
+
+  /**
+   * Body param: Saved configuration ID
+   */
+  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<
+      | '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.running'
+      | 'classify.success'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.cancelled'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.cancelled'
+      | '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)
    */
@@ -479,7 +633,7 @@ export interface SheetListParams extends PaginatedCursorParams {
   /**
    * Filter by job status
    */
-  status?: ParsingAPI.StatusEnum | null;
+  status?: 'PENDING' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED' | null;
 }
 
 export interface SheetDeleteJobParams {
@@ -489,6 +643,12 @@ export interface SheetDeleteJobParams {
 }
 
 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;

package/src/resources/classifier/jobs.ts

@@ -10,8 +10,7 @@ import { pollUntilComplete, PollingOptions, DEFAULT_TIMEOUT } from '../../core/p
 
 export class Jobs extends APIResource {
   /**
-   * Create a classify job. Experimental: This endpoint is not yet ready for
-   * production use and is subject to change at any time.
+   * Create a classify job. Experimental: not production-ready and subject to change.
    *
    * @deprecated Please use `client.classify.create()`
    */
@@ -25,8 +24,7 @@ export class Jobs extends APIResource {
   }
 
   /**
-   * List classify jobs. Experimental: This endpoint is not yet ready for production
-   * use and is subject to change at any time.
+   * List classify jobs. Experimental: not production-ready and subject to change.
    *
    * @deprecated Please use `client.classify.list()`
    */
@@ -41,8 +39,7 @@ export class Jobs extends APIResource {
   }
 
   /**
-   * Get a classify job. Experimental: This endpoint is not yet ready for production
-   * use and is subject to change at any time.
+   * Get a classify job. Experimental: not production-ready and subject to change.
    *
    * @deprecated Please use `client.classify.get()`
    */
@@ -55,8 +52,8 @@ export class Jobs extends APIResource {
   }
 
   /**
-   * Get the results of a classify job. Experimental: This endpoint is not yet ready
-   * for production use and is subject to change at any time.
+   * Get the results of a classify job. Experimental: not production-ready and
+   * subject to change.
    *
    * @deprecated Please use `client.classify.get()`
    */
@@ -376,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;
 
@@ -387,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?: 'string' | 'json' | null;
+
     /**
      * HTTPS URL to receive webhook POST requests. Must be publicly accessible
      */

package/src/resources/classify.ts

@@ -284,6 +284,63 @@ export interface ClassifyCreateRequest {
    * Idempotency key scoped to the project
    */
   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<
+      | '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.running'
+      | 'classify.success'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.cancelled'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.cancelled'
+      | '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;
+  }
 }
 
 /**
@@ -571,6 +628,63 @@ export interface ClassifyCreateParams {
    * Body param: Idempotency key scoped to the project
    */
   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<
+      | '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.running'
+      | 'classify.success'
+      | 'classify.error'
+      | 'classify.partial_success'
+      | 'classify.cancelled'
+      | 'sheets.pending'
+      | 'sheets.success'
+      | 'sheets.error'
+      | 'sheets.partial_success'
+      | 'sheets.cancelled'
+      | '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 {