@llamaindex/llama-cloud 1.7.0 → 2.0.0

package/src/resources/beta/split.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as SplitAPI from './split';
 import { APIPromise } from '../../core/api-promise';
 import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -279,7 +280,7 @@ export interface SplitCreateResponse {
 
   /**
    * Current status of the job. Valid values are: pending, processing, completed,
-   * failed.
+   * failed, cancelled.
    */
   status: string;
 
@@ -288,6 +289,11 @@ export interface SplitCreateResponse {
    */
   user_id: string;
 
+  /**
+   * Split configuration ID used for this job.
+   */
+  configuration_id?: string | null;
+
   /**
    * Creation datetime
    */
@@ -335,7 +341,7 @@ export interface SplitListResponse {
 
   /**
    * Current status of the job. Valid values are: pending, processing, completed,
-   * failed.
+   * failed, cancelled.
    */
   status: string;
 
@@ -344,6 +350,11 @@ export interface SplitListResponse {
    */
   user_id: string;
 
+  /**
+   * Split configuration ID used for this job.
+   */
+  configuration_id?: string | null;
+
   /**
    * Creation datetime
    */
@@ -391,7 +402,7 @@ export interface SplitGetResponse {
 
   /**
    * Current status of the job. Valid values are: pending, processing, completed,
-   * failed.
+   * failed, cancelled.
    */
   status: string;
 
@@ -400,6 +411,11 @@ export interface SplitGetResponse {
    */
   user_id: string;
 
+  /**
+   * Split configuration ID used for this job.
+   */
+  configuration_id?: string | null;
+
   /**
    * Creation datetime
    */
@@ -422,11 +438,6 @@ export interface SplitGetResponse {
 }
 
 export interface SplitCreateParams {
-  /**
-   * Body param: Categories to split documents into.
-   */
-  categories: Array<SplitCategory>;
-
   /**
    * Body param: Document to be split.
    */
@@ -443,30 +454,72 @@ export interface SplitCreateParams {
   project_id?: string | null;
 
   /**
-   * Body param: Strategy for splitting documents.
+   * Body param: Split configuration with categories and splitting strategy.
    */
-  splitting_strategy?: SplitCreateParams.SplittingStrategy;
+  configuration?: SplitCreateParams.Configuration | null;
+
+  /**
+   * Body param: Saved split configuration ID.
+   */
+  configuration_id?: string | null;
 }
 
 export namespace SplitCreateParams {
   /**
-   * Strategy for splitting documents.
+   * Split configuration with categories and splitting strategy.
    */
-  export interface SplittingStrategy {
+  export interface Configuration {
     /**
-     * Controls handling of pages that don't match any category. 'include': pages can
-     * be grouped as 'uncategorized' and included in results. 'forbid': all pages must
-     * be assigned to a defined category. 'omit': pages can be classified as
-     * 'uncategorized' but are excluded from results.
+     * Categories to split documents into.
      */
-    allow_uncategorized?: 'include' | 'forbid' | 'omit';
+    categories: Array<SplitAPI.SplitCategory>;
+
+    /**
+     * Strategy for splitting documents.
+     */
+    splitting_strategy?: Configuration.SplittingStrategy;
+  }
+
+  export namespace Configuration {
+    /**
+     * Strategy for splitting documents.
+     */
+    export interface SplittingStrategy {
+      /**
+       * Controls handling of pages that don't match any category. 'include': pages can
+       * be grouped as 'uncategorized' and included in results. 'forbid': all pages must
+       * be assigned to a defined category. 'omit': pages can be classified as
+       * 'uncategorized' but are excluded from results.
+       */
+      allow_uncategorized?: 'include' | 'forbid' | 'omit';
+    }
   }
 }
 
 export interface SplitListParams extends PaginatedCursorParams {
+  /**
+   * Include jobs created at or after this timestamp (inclusive)
+   */
+  created_at_on_or_after?: string | null;
+
+  /**
+   * Include jobs created at or before this timestamp (inclusive)
+   */
+  created_at_on_or_before?: string | null;
+
+  /**
+   * Filter by specific job IDs
+   */
+  job_ids?: Array<string> | null;
+
   organization_id?: string | null;
 
   project_id?: string | null;
+
+  /**
+   * Filter by job status (pending, processing, completed, failed, cancelled)
+   */
+  status?: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | null;
 }
 
 export interface SplitGetParams {

package/src/resources/classifier/jobs.ts

@@ -12,6 +12,8 @@ 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.
+   *
+   * @deprecated Please use `client.classify.create()`
    */
   create(params: JobCreateParams, options?: RequestOptions): APIPromise<ClassifyJob> {
     const { organization_id, project_id, ...body } = params;
@@ -25,6 +27,8 @@ 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.
+   *
+   * @deprecated Please use `client.classify.list()`
    */
   list(
     query: JobListParams | null | undefined = {},
@@ -39,6 +43,8 @@ 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.
+   *
+   * @deprecated Please use `client.classify.get()`
    */
   get(
     classifyJobID: string,
@@ -51,6 +57,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.
+   *
+   * @deprecated Please use `client.classify.get()`
    */
   getResults(
     classifyJobID: string,
@@ -359,19 +367,28 @@ export interface JobCreateParams {
 }
 
 export namespace JobCreateParams {
+  /**
+   * Webhook configuration for receiving parsing job notifications.
+   *
+   * Webhooks are called when specified events occur during job processing. Configure
+   * multiple webhook configurations to send to different endpoints.
+   */
   export interface WebhookConfiguration {
     /**
-     * List of events that trigger webhook notifications
+     * 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
      */
     webhook_events?: Array<string> | null;
 
     /**
-     * Custom headers to include in webhook requests
+     * Custom HTTP headers to include in webhook requests. Use for authentication
+     * tokens or custom routing. Example: {'Authorization': 'Bearer xyz'}
      */
     webhook_headers?: { [key: string]: unknown } | null;
 
     /**
-     * Webhook URL for receiving parsing notifications
+     * HTTPS URL to receive webhook POST requests. Must be publicly accessible
      */
     webhook_url?: string | null;
   }

package/src/resources/classify.ts

@@ -0,0 +1,486 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Classify extends APIResource {
+  /**
+   * Create a classify job.
+   *
+   * Classifies a document against a set of rules. Provide either `file_id` or
+   * `parse_job_id` as the document input, and either inline `configuration` with
+   * rules or a `configuration_id` referencing a saved preset.
+   *
+   * Each rule has a `type` (the label to assign) and a `description` (natural
+   * language criteria). The classifier returns the best matching rule with a
+   * confidence score.
+   *
+   * The job runs asynchronously. Poll `GET /classify/{job_id}` to check status and
+   * retrieve results.
+   */
+  create(params: ClassifyCreateParams, options?: RequestOptions): APIPromise<ClassifyCreateResponse> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v2/classify', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List classify jobs with optional filtering and pagination.
+   *
+   * Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
+   * range.
+   */
+  list(
+    query: ClassifyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ClassifyListResponsesPaginatedCursor, ClassifyListResponse> {
+    return this._client.getAPIList('/api/v2/classify', PaginatedCursor<ClassifyListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Get a classify job by ID.
+   *
+   * Returns the job status, configuration, and classify result when complete. The
+   * result includes the matched document type, confidence score, and reasoning.
+   */
+  get(
+    jobID: string,
+    query: ClassifyGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ClassifyGetResponse> {
+    return this._client.get(path`/api/v2/classify/${jobID}`, { query, ...options });
+  }
+}
+
+export type ClassifyListResponsesPaginatedCursor = PaginatedCursor<ClassifyListResponse>;
+
+/**
+ * Configuration for a classify job.
+ */
+export interface ClassifyConfiguration {
+  /**
+   * Classify rules to evaluate against the document (at least one required)
+   */
+  rules: Array<ClassifyConfiguration.Rule>;
+
+  /**
+   * Classify execution mode
+   */
+  mode?: 'FAST';
+
+  /**
+   * Parsing configuration for classify jobs.
+   */
+  parsing_configuration?: ClassifyConfiguration.ParsingConfiguration | null;
+}
+
+export namespace ClassifyConfiguration {
+  /**
+   * A rule for classifying documents.
+   */
+  export interface Rule {
+    /**
+     * Natural language criteria for matching this rule
+     */
+    description: string;
+
+    /**
+     * Document type to assign when rule matches
+     */
+    type: string;
+  }
+
+  /**
+   * Parsing configuration for classify jobs.
+   */
+  export interface ParsingConfiguration {
+    /**
+     * ISO 639-1 language code for the document
+     */
+    lang?: string;
+
+    /**
+     * Maximum number of pages to process. Omit for no limit.
+     */
+    max_pages?: number | null;
+
+    /**
+     * Comma-separated page numbers or ranges to process (1-based). Omit to process all
+     * pages.
+     */
+    target_pages?: string | null;
+  }
+}
+
+/**
+ * Request to create a classify job.
+ */
+export interface ClassifyCreateRequest {
+  /**
+   * Configuration for a classify job.
+   */
+  configuration?: ClassifyConfiguration | null;
+
+  /**
+   * Product configuration ID for reusable presets
+   */
+  configuration_id?: string | null;
+
+  /**
+   * File ID to classify
+   */
+  file_id?: string | null;
+
+  /**
+   * Parse job ID to classify
+   */
+  parse_job_id?: string | null;
+
+  /**
+   * Idempotency key scoped to the project
+   */
+  transaction_id?: string | null;
+}
+
+/**
+ * Result of classifying a document.
+ */
+export interface ClassifyResult {
+  /**
+   * Confidence score between 0.0 and 1.0
+   */
+  confidence: number;
+
+  /**
+   * Why the document matched (or didn't match) the returned rule
+   */
+  reasoning: string;
+
+  /**
+   * Matched rule type, or null if no rule matched
+   */
+  type: string | null;
+}
+
+/**
+ * Response for a classify job.
+ */
+export interface ClassifyCreateResponse {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Classify configuration used for this job
+   */
+  configuration: ClassifyConfiguration;
+
+  /**
+   * Whether the input was a file or parse job (FILE or PARSE_JOB)
+   */
+  document_input_type: 'url' | 'file_id' | 'parse_job_id';
+
+  /**
+   * ID of the input file or parse job
+   */
+  document_input_value: string;
+
+  /**
+   * Project this job belongs to
+   */
+  project_id: string;
+
+  /**
+   * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
+   */
+  status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+
+  /**
+   * User who created this job
+   */
+  user_id: string;
+
+  /**
+   * Product configuration ID
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Error message if job failed
+   */
+  error_message?: string | null;
+
+  /**
+   * Associated parse job ID
+   */
+  parse_job_id?: string | null;
+
+  /**
+   * Result of classifying a document.
+   */
+  result?: ClassifyResult | null;
+
+  /**
+   * Idempotency key
+   */
+  transaction_id?: string | null;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+/**
+ * Response for a classify job.
+ */
+export interface ClassifyListResponse {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Classify configuration used for this job
+   */
+  configuration: ClassifyConfiguration;
+
+  /**
+   * Whether the input was a file or parse job (FILE or PARSE_JOB)
+   */
+  document_input_type: 'url' | 'file_id' | 'parse_job_id';
+
+  /**
+   * ID of the input file or parse job
+   */
+  document_input_value: string;
+
+  /**
+   * Project this job belongs to
+   */
+  project_id: string;
+
+  /**
+   * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
+   */
+  status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+
+  /**
+   * User who created this job
+   */
+  user_id: string;
+
+  /**
+   * Product configuration ID
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Error message if job failed
+   */
+  error_message?: string | null;
+
+  /**
+   * Associated parse job ID
+   */
+  parse_job_id?: string | null;
+
+  /**
+   * Result of classifying a document.
+   */
+  result?: ClassifyResult | null;
+
+  /**
+   * Idempotency key
+   */
+  transaction_id?: string | null;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+/**
+ * Response for a classify job.
+ */
+export interface ClassifyGetResponse {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Classify configuration used for this job
+   */
+  configuration: ClassifyConfiguration;
+
+  /**
+   * Whether the input was a file or parse job (FILE or PARSE_JOB)
+   */
+  document_input_type: 'url' | 'file_id' | 'parse_job_id';
+
+  /**
+   * ID of the input file or parse job
+   */
+  document_input_value: string;
+
+  /**
+   * Project this job belongs to
+   */
+  project_id: string;
+
+  /**
+   * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
+   */
+  status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+
+  /**
+   * User who created this job
+   */
+  user_id: string;
+
+  /**
+   * Product configuration ID
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Error message if job failed
+   */
+  error_message?: string | null;
+
+  /**
+   * Associated parse job ID
+   */
+  parse_job_id?: string | null;
+
+  /**
+   * Result of classifying a document.
+   */
+  result?: ClassifyResult | null;
+
+  /**
+   * Idempotency key
+   */
+  transaction_id?: string | null;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+export interface ClassifyCreateParams {
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+
+  /**
+   * Body param: Configuration for a classify job.
+   */
+  configuration?: ClassifyConfiguration | null;
+
+  /**
+   * Body param: Product configuration ID for reusable presets
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Body param: File ID to classify
+   */
+  file_id?: string | null;
+
+  /**
+   * Body param: Parse job ID to classify
+   */
+  parse_job_id?: string | null;
+
+  /**
+   * Body param: Idempotency key scoped to the project
+   */
+  transaction_id?: string | null;
+}
+
+export interface ClassifyListParams extends PaginatedCursorParams {
+  /**
+   * Filter by configuration ID
+   */
+  configuration_id?: string | null;
+
+  /**
+   * Include jobs created at or after this timestamp (inclusive)
+   */
+  created_at_on_or_after?: string | null;
+
+  /**
+   * Include jobs created at or before this timestamp (inclusive)
+   */
+  created_at_on_or_before?: string | null;
+
+  /**
+   * Filter by specific job IDs
+   */
+  job_ids?: Array<string> | null;
+
+  organization_id?: string | null;
+
+  project_id?: string | null;
+
+  /**
+   * Filter by job status
+   */
+  status?: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | null;
+}
+
+export interface ClassifyGetParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export declare namespace Classify {
+  export {
+    type ClassifyConfiguration as ClassifyConfiguration,
+    type ClassifyCreateRequest as ClassifyCreateRequest,
+    type ClassifyResult as ClassifyResult,
+    type ClassifyCreateResponse as ClassifyCreateResponse,
+    type ClassifyListResponse as ClassifyListResponse,
+    type ClassifyGetResponse as ClassifyGetResponse,
+    type ClassifyListResponsesPaginatedCursor as ClassifyListResponsesPaginatedCursor,
+    type ClassifyCreateParams as ClassifyCreateParams,
+    type ClassifyListParams as ClassifyListParams,
+    type ClassifyGetParams as ClassifyGetParams,
+  };
+}