@llamaindex/llama-cloud 1.7.0 → 2.0.0

package/resources/classify.d.mts

@@ -0,0 +1,373 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PagePromise, PaginatedCursor, type PaginatedCursorParams } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+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 declare namespace ClassifyConfiguration {
+    /**
+     * A rule for classifying documents.
+     */
+    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.
+     */
+    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, };
+}
+//# sourceMappingURL=classify.d.mts.map

package/resources/classify.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classify.d.mts","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IASlG;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,oBAAoB,CAAC;IAO1E;;;;;OAKG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED,MAAM,MAAM,oCAAoC,GAAG,eAAe,CAAC,oBAAoB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,mBAAmB,EAAE,KAAK,GAAG,SAAS,GAAG,cAAc,CAAC;IAExD;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB;IAC/D;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}