@llamaindex/llama-cloud 0.14.1

package/resources/beta/split.d.ts

@@ -0,0 +1,354 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { PagePromise, PaginatedClassifyJobs, type PaginatedClassifyJobsParams } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+import { PollingOptions } from "../../core/polling.js";
+export declare class Split extends APIResource {
+    /**
+     * Create a document split job. Experimental: This endpoint is not yet ready for
+     * production use and is subject to change at any time.
+     */
+    create(params: SplitCreateParams, options?: RequestOptions): APIPromise<SplitCreateResponse>;
+    /**
+     * List document split jobs. Experimental: This endpoint is not yet ready for
+     * production use and is subject to change at any time.
+     */
+    list(query?: SplitListParams | null | undefined, options?: RequestOptions): PagePromise<SplitListResponsesPaginatedClassifyJobs, SplitListResponse>;
+    /**
+     * Get a document split job.
+     *
+     * Experimental: This endpoint is not yet ready for production use and is subject
+     * to change at any time.
+     */
+    get(splitJobID: string, query?: SplitGetParams | null | undefined, options?: RequestOptions): APIPromise<SplitGetResponse>;
+    /**
+     * Wait for a document split 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.
+     *
+     * Experimental: This endpoint is not yet ready for production use and is subject
+     * to change at any time.
+     *
+     * @param splitJobID - The ID of the split job to wait for
+     * @param params - Query parameters and polling configuration
+     * @param options - Additional request options
+     * @returns The completed SplitGetResponse with result populated
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails
+     *
+     * @example
+     * ```typescript
+     * import LlamaCloud from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Create a split job
+     * const job = await client.beta.split.create({
+     *   categories: [
+     *     { name: 'essay', description: 'Essay documents' },
+     *     { name: 'research_paper', description: 'Research paper documents' }
+     *   ],
+     *   document_input: { type: 'file_id', value: 'file_id' }
+     * });
+     *
+     * // Wait for it to complete
+     * const completedJob = await client.beta.split.waitForCompletion(
+     *   job.id,
+     *   { verbose: true }
+     * );
+     *
+     * // Access the results
+     * console.log(completedJob.result?.segments);
+     * ```
+     */
+    waitForCompletion(splitJobID: string, params?: SplitWaitForCompletionParams | null | undefined, options?: RequestOptions): Promise<SplitGetResponse>;
+    /**
+     * Create a document split job and wait for it to complete, returning the result.
+     *
+     * This is a convenience method that combines create() and waitForCompletion()
+     * into a single call for the most common end-to-end workflow.
+     *
+     * Experimental: This endpoint is not yet ready for production use and is subject
+     * to change at any time.
+     *
+     * @param params - Split job creation parameters including categories and document input
+     * @param options - Request options
+     * @returns The completed SplitGetResponse with result containing segments
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails
+     *
+     * @example
+     * ```typescript
+     * import LlamaCloud from 'llama-cloud';
+     * import fs from 'fs';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Upload a file first
+     * const fileObj = await client.files.upload({
+     *   upload_file: fs.createReadStream('combined_document.pdf')
+     * });
+     *
+     * // One-shot: create split job, wait for completion, and get result
+     * const result = await client.beta.split.split({
+     *   categories: [
+     *     { name: 'essay', description: 'A philosophical or reflective piece of writing' },
+     *     { name: 'research_paper', description: 'A formal academic paper with citations' }
+     *   ],
+     *   document_input: { type: 'file_id', value: fileObj.id },
+     *   verbose: true
+     * });
+     *
+     * // Access the segments
+     * for (const segment of result.result?.segments || []) {
+     *   console.log(`Category: ${segment.category}, Pages: ${segment.pages}`);
+     * }
+     * ```
+     */
+    split(params: SplitSplitParams, options?: RequestOptions): Promise<SplitGetResponse>;
+}
+export type SplitListResponsesPaginatedClassifyJobs = PaginatedClassifyJobs<SplitListResponse>;
+/**
+ * Category definition for document splitting.
+ */
+export interface SplitCategory {
+    /**
+     * Name of the category.
+     */
+    name: string;
+    /**
+     * Optional description of what content belongs in this category.
+     */
+    description?: string | null;
+}
+/**
+ * Document input specification.
+ */
+export interface SplitDocumentInput {
+    /**
+     * Type of document input. Valid values are: file_id
+     */
+    type: string;
+    /**
+     * Document identifier.
+     */
+    value: string;
+}
+/**
+ * Result of a completed split job.
+ */
+export interface SplitResultResponse {
+    /**
+     * List of document segments.
+     */
+    segments: Array<SplitSegmentResponse>;
+}
+/**
+ * A segment of the split document.
+ */
+export interface SplitSegmentResponse {
+    /**
+     * Category name this split belongs to.
+     */
+    category: string;
+    /**
+     * Categorical confidence level. Valid values are: high, medium, low.
+     */
+    confidence_category: string;
+    /**
+     * 1-indexed page numbers in this split.
+     */
+    pages: Array<number>;
+}
+/**
+ * A document split job.
+ */
+export interface SplitCreateResponse {
+    /**
+     * Unique identifier for the split job.
+     */
+    id: string;
+    /**
+     * Categories used for splitting.
+     */
+    categories: Array<SplitCategory>;
+    /**
+     * Document that was split.
+     */
+    document_input: SplitDocumentInput;
+    /**
+     * Project ID this job belongs to.
+     */
+    project_id: string;
+    /**
+     * Current status of the job. Valid values are: pending, processing, completed,
+     * failed.
+     */
+    status: string;
+    /**
+     * User ID who created this job.
+     */
+    user_id: string;
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+    /**
+     * Error message if the job failed.
+     */
+    error_message?: string | null;
+    /**
+     * Result of a completed split job.
+     */
+    result?: SplitResultResponse | null;
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+}
+/**
+ * A document split job.
+ */
+export interface SplitListResponse {
+    /**
+     * Unique identifier for the split job.
+     */
+    id: string;
+    /**
+     * Categories used for splitting.
+     */
+    categories: Array<SplitCategory>;
+    /**
+     * Document that was split.
+     */
+    document_input: SplitDocumentInput;
+    /**
+     * Project ID this job belongs to.
+     */
+    project_id: string;
+    /**
+     * Current status of the job. Valid values are: pending, processing, completed,
+     * failed.
+     */
+    status: string;
+    /**
+     * User ID who created this job.
+     */
+    user_id: string;
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+    /**
+     * Error message if the job failed.
+     */
+    error_message?: string | null;
+    /**
+     * Result of a completed split job.
+     */
+    result?: SplitResultResponse | null;
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+}
+/**
+ * A document split job.
+ */
+export interface SplitGetResponse {
+    /**
+     * Unique identifier for the split job.
+     */
+    id: string;
+    /**
+     * Categories used for splitting.
+     */
+    categories: Array<SplitCategory>;
+    /**
+     * Document that was split.
+     */
+    document_input: SplitDocumentInput;
+    /**
+     * Project ID this job belongs to.
+     */
+    project_id: string;
+    /**
+     * Current status of the job. Valid values are: pending, processing, completed,
+     * failed.
+     */
+    status: string;
+    /**
+     * User ID who created this job.
+     */
+    user_id: string;
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+    /**
+     * Error message if the job failed.
+     */
+    error_message?: string | null;
+    /**
+     * Result of a completed split job.
+     */
+    result?: SplitResultResponse | null;
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+}
+export interface SplitCreateParams {
+    /**
+     * Body param: Categories to split the document into.
+     */
+    categories: Array<SplitCategory>;
+    /**
+     * Body param: Document to be split.
+     */
+    document_input: SplitDocumentInput;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: Strategy for splitting the document.
+     */
+    splitting_strategy?: SplitCreateParams.SplittingStrategy;
+}
+export declare namespace SplitCreateParams {
+    /**
+     * Strategy for splitting the document.
+     */
+    interface SplittingStrategy {
+        /**
+         * Whether to allow pages that don't match any category to be grouped as
+         * 'uncategorized'. If False, all pages must be assigned to a defined category.
+         */
+        allow_uncategorized?: boolean;
+    }
+}
+export interface SplitListParams extends PaginatedClassifyJobsParams {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface SplitGetParams {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface SplitSplitParams extends SplitCreateParams, PollingOptions {
+}
+export interface SplitWaitForCompletionParams extends PollingOptions {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export declare namespace Split {
+    export { type SplitCategory as SplitCategory, type SplitDocumentInput as SplitDocumentInput, type SplitResultResponse as SplitResultResponse, type SplitSegmentResponse as SplitSegmentResponse, type SplitCreateResponse as SplitCreateResponse, type SplitListResponse as SplitListResponse, type SplitGetResponse as SplitGetResponse, type SplitListResponsesPaginatedClassifyJobs as SplitListResponsesPaginatedClassifyJobs, type SplitCreateParams as SplitCreateParams, type SplitListParams as SplitListParams, type SplitGetParams as SplitGetParams, type SplitSplitParams as SplitSplitParams, type SplitWaitForCompletionParams as SplitWaitForCompletionParams, };
+}
+//# sourceMappingURL=split.d.ts.map

package/resources/beta/split.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"split.d.ts","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE;OACxE,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAE;AAE5C,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAS5F;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,iBAAiB,CAAC;IAO1E;;;;;OAKG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAuB3F;AAED,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,iBAAiB,CAAC,iBAAiB,CAAC;CAC1D;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;;WAGG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,2BAA2B;IAClE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/beta/split.js

@@ -0,0 +1,173 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Split = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+const polling_1 = require("../../core/polling.js");
+class Split extends resource_1.APIResource {
+    /**
+     * Create a document split job. Experimental: This endpoint is not yet ready for
+     * production use and is subject to change at any time.
+     */
+    create(params, options) {
+        const { organization_id, project_id, ...body } = params;
+        return this._client.post('/api/v1/beta/split/jobs', {
+            query: { organization_id, project_id },
+            body,
+            ...options,
+        });
+    }
+    /**
+     * List document split jobs. Experimental: This endpoint is not yet ready for
+     * production use and is subject to change at any time.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/api/v1/beta/split/jobs', (pagination_1.PaginatedClassifyJobs), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Get a document split job.
+     *
+     * Experimental: This endpoint is not yet ready for production use and is subject
+     * to change at any time.
+     */
+    get(splitJobID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/api/v1/beta/split/jobs/${splitJobID}`, { query, ...options });
+    }
+    /**
+     * Wait for a document split 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.
+     *
+     * Experimental: This endpoint is not yet ready for production use and is subject
+     * to change at any time.
+     *
+     * @param splitJobID - The ID of the split job to wait for
+     * @param params - Query parameters and polling configuration
+     * @param options - Additional request options
+     * @returns The completed SplitGetResponse with result populated
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails
+     *
+     * @example
+     * ```typescript
+     * import LlamaCloud from 'llama-cloud';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Create a split job
+     * const job = await client.beta.split.create({
+     *   categories: [
+     *     { name: 'essay', description: 'Essay documents' },
+     *     { name: 'research_paper', description: 'Research paper documents' }
+     *   ],
+     *   document_input: { type: 'file_id', value: 'file_id' }
+     * });
+     *
+     * // Wait for it to complete
+     * const completedJob = await client.beta.split.waitForCompletion(
+     *   job.id,
+     *   { verbose: true }
+     * );
+     *
+     * // Access the results
+     * console.log(completedJob.result?.segments);
+     * ```
+     */
+    async waitForCompletion(splitJobID, params = {}, options) {
+        const { pollingInterval, maxInterval, timeout, backoff, verbose, ...queryParams } = params ?? {};
+        const pollingOptions = {
+            pollingInterval: pollingInterval ?? 1.0,
+            maxInterval: maxInterval ?? 5.0,
+            timeout: timeout ?? 2000.0,
+            backoff: backoff ?? 'linear',
+            verbose: verbose ?? false,
+        };
+        return (0, polling_1.pollUntilComplete)(async () => {
+            return this.get(splitJobID, queryParams, options);
+        }, (job) => job.status === 'completed', (job) => job.status === 'failed', (job) => {
+            const errorParts = [`Split job ${splitJobID} failed with status: ${job.status}`];
+            if (job.error_message) {
+                errorParts.push(`Error: ${job.error_message}`);
+            }
+            return errorParts.join(' | ');
+        }, pollingOptions);
+    }
+    /**
+     * Create a document split job and wait for it to complete, returning the result.
+     *
+     * This is a convenience method that combines create() and waitForCompletion()
+     * into a single call for the most common end-to-end workflow.
+     *
+     * Experimental: This endpoint is not yet ready for production use and is subject
+     * to change at any time.
+     *
+     * @param params - Split job creation parameters including categories and document input
+     * @param options - Request options
+     * @returns The completed SplitGetResponse with result containing segments
+     * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+     * @throws {PollingError} If the job fails
+     *
+     * @example
+     * ```typescript
+     * import LlamaCloud from 'llama-cloud';
+     * import fs from 'fs';
+     *
+     * const client = new LlamaCloud({ apiKey: '...' });
+     *
+     * // Upload a file first
+     * const fileObj = await client.files.upload({
+     *   upload_file: fs.createReadStream('combined_document.pdf')
+     * });
+     *
+     * // One-shot: create split job, wait for completion, and get result
+     * const result = await client.beta.split.split({
+     *   categories: [
+     *     { name: 'essay', description: 'A philosophical or reflective piece of writing' },
+     *     { name: 'research_paper', description: 'A formal academic paper with citations' }
+     *   ],
+     *   document_input: { type: 'file_id', value: fileObj.id },
+     *   verbose: true
+     * });
+     *
+     * // Access the segments
+     * for (const segment of result.result?.segments || []) {
+     *   console.log(`Category: ${segment.category}, Pages: ${segment.pages}`);
+     * }
+     * ```
+     */
+    async split(params, options) {
+        const { pollingInterval, maxInterval, timeout, backoff, verbose, ...createParams } = params;
+        // Create the split job
+        const job = await this.create(createParams, options);
+        // Wait for completion
+        const pollingOptions = {};
+        if (pollingInterval !== undefined)
+            pollingOptions.pollingInterval = pollingInterval;
+        if (maxInterval !== undefined)
+            pollingOptions.maxInterval = maxInterval;
+        if (timeout !== undefined)
+            pollingOptions.timeout = timeout;
+        if (backoff !== undefined)
+            pollingOptions.backoff = backoff;
+        if (verbose !== undefined)
+            pollingOptions.verbose = verbose;
+        // Only pass query params that are valid for waitForCompletion
+        const waitParams = {
+            ...pollingOptions,
+        };
+        if (createParams.organization_id !== undefined)
+            waitParams.organization_id = createParams.organization_id;
+        if (createParams.project_id !== undefined)
+            waitParams.project_id = createParams.project_id;
+        return this.waitForCompletion(job.id, waitParams, options);
+    }
+}
+exports.Split = Split;
+//# sourceMappingURL=split.js.map

package/resources/beta/split.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"split.js","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA6G;AAE7G,uDAAiD;AACjD,mDAAuE;AAEvE,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,kCAAwC,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CACD,UAAkB,EAClB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,iBAAiB,CACrB,UAAkB,EAClB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,MAAM;YAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,IAAA,2BAAiB,EACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,WAAW,EACnC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,EAChC,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,aAAa,UAAU,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,uBAAuB;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAmB,EAAE,CAAC;QAC1C,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAtLD,sBAsLC"}