@llamaindex/llama-cloud 1.8.0 → 2.1.0

package/resources/classify.d.mts

@@ -5,30 +5,51 @@ 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. Set `file_input` to a file ID
+     * (`dfl-...`) or parse job ID (`pjb-...`), and provide 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.
+     * 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>;
     /**
-     * Retrieve classify job by ID.
+     * 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 classification.
+ * Configuration for a classify job.
  */
 export interface ClassifyConfiguration {
     /**
-     * Classification rules to apply (at least one required)
+     * Classify rules to evaluate against the document (at least one required)
      */
     rules: Array<ClassifyConfiguration.Rule>;
     /**
-     * Classification execution mode
+     * Classify execution mode
      */
     mode?: 'FAST';
+    /**
+     * Parsing configuration for classify jobs.
+     */
+    parsing_configuration?: ClassifyConfiguration.ParsingConfiguration | null;
 }
 export declare namespace ClassifyConfiguration {
     /**
@@ -36,7 +57,7 @@ export declare namespace ClassifyConfiguration {
      */
     interface Rule {
         /**
-         * Natural language description of what to classify
+         * Natural language criteria for matching this rule
          */
         description: string;
         /**
@@ -44,25 +65,47 @@ export declare namespace ClassifyConfiguration {
          */
         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 classification.
+     * Configuration for a classify job.
      */
     configuration?: ClassifyConfiguration | null;
     /**
-     * Product configuration ID for reusable presets
+     * Saved configuration ID
      */
     configuration_id?: string | null;
     /**
-     * File ID to classify
+     * @deprecated Deprecated: use file_input instead
      */
     file_id?: string | null;
     /**
-     * Parse job ID to classify
+     * File ID or parse job ID to classify
+     */
+    file_input?: string | null;
+    /**
+     * @deprecated Deprecated: use file_input instead
      */
     parse_job_id?: string | null;
     /**
@@ -75,15 +118,15 @@ export interface ClassifyCreateRequest {
  */
 export interface ClassifyResult {
     /**
-     * Confidence score (0.0-1.0)
+     * Confidence score between 0.0 and 1.0
      */
     confidence: number;
     /**
-     * Explanation of classification decision
+     * Why the document matched (or didn't match) the returned rule
      */
     reasoning: string;
     /**
-     * Document type that matches, or None
+     * Matched rule type, or null if no rule matched
      */
     type: string | null;
 }
@@ -96,27 +139,27 @@ export interface ClassifyCreateResponse {
      */
     id: string;
     /**
-     * Classification configuration
+     * Classify configuration used for this job
      */
     configuration: ClassifyConfiguration;
     /**
-     * Type of document input
+     * Whether the input was a file or parse job (FILE or PARSE_JOB)
      */
     document_input_type: 'url' | 'file_id' | 'parse_job_id';
     /**
-     * Document identifier
+     * ID of the input file or parse job
      */
-    document_input_value: string;
+    file_input: string;
     /**
-     * Project ID
+     * Project this job belongs to
      */
     project_id: string;
     /**
-     * Job status
+     * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
      */
     status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
     /**
-     * User ID
+     * User who created this job
      */
     user_id: string;
     /**
@@ -157,27 +200,27 @@ export interface ClassifyListResponse {
      */
     id: string;
     /**
-     * Classification configuration
+     * Classify configuration used for this job
      */
     configuration: ClassifyConfiguration;
     /**
-     * Type of document input
+     * Whether the input was a file or parse job (FILE or PARSE_JOB)
      */
     document_input_type: 'url' | 'file_id' | 'parse_job_id';
     /**
-     * Document identifier
+     * ID of the input file or parse job
      */
-    document_input_value: string;
+    file_input: string;
     /**
-     * Project ID
+     * Project this job belongs to
      */
     project_id: string;
     /**
-     * Job status
+     * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
      */
     status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
     /**
-     * User ID
+     * User who created this job
      */
     user_id: string;
     /**
@@ -218,27 +261,27 @@ export interface ClassifyGetResponse {
      */
     id: string;
     /**
-     * Classification configuration
+     * Classify configuration used for this job
      */
     configuration: ClassifyConfiguration;
     /**
-     * Type of document input
+     * Whether the input was a file or parse job (FILE or PARSE_JOB)
      */
     document_input_type: 'url' | 'file_id' | 'parse_job_id';
     /**
-     * Document identifier
+     * ID of the input file or parse job
      */
-    document_input_value: string;
+    file_input: string;
     /**
-     * Project ID
+     * Project this job belongs to
      */
     project_id: string;
     /**
-     * Job status
+     * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
      */
     status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
     /**
-     * User ID
+     * User who created this job
      */
     user_id: string;
     /**
@@ -280,19 +323,23 @@ export interface ClassifyCreateParams {
      */
     project_id?: string | null;
     /**
-     * Body param: Configuration for classification.
+     * Body param: Configuration for a classify job.
      */
     configuration?: ClassifyConfiguration | null;
     /**
-     * Body param: Product configuration ID for reusable presets
+     * Body param: Saved configuration ID
      */
     configuration_id?: string | null;
     /**
-     * Body param: File ID to classify
+     * @deprecated Body param: Deprecated: use file_input instead
      */
     file_id?: string | null;
     /**
-     * Body param: Parse job ID to classify
+     * Body param: File ID or parse job ID to classify
+     */
+    file_input?: string | null;
+    /**
+     * @deprecated Body param: Deprecated: use file_input instead
      */
     parse_job_id?: string | null;
     /**
@@ -305,6 +352,14 @@ export interface ClassifyListParams extends PaginatedCursorParams {
      * Filter by configuration ID
      */
     configuration_id?: string | null;
+    /**
+     * Include items created at or after this timestamp (inclusive)
+     */
+    created_at_on_or_after?: string | null;
+    /**
+     * Include items created at or before this timestamp (inclusive)
+     */
+    created_at_on_or_before?: string | null;
     /**
      * Filter by specific job IDs
      */

package/resources/classify.d.mts.map

@@ -1 +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;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IASlG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,oBAAoB,CAAC;IAO1E;;OAEG;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;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;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,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"}
+{"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,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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"}

package/resources/classify.d.ts

@@ -5,30 +5,51 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class Classify extends APIResource {
     /**
      * Create a classify job.
+     *
+     * Classifies a document against a set of rules. Set `file_input` to a file ID
+     * (`dfl-...`) or parse job ID (`pjb-...`), and provide 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.
+     * 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>;
     /**
-     * Retrieve classify job by ID.
+     * 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 classification.
+ * Configuration for a classify job.
  */
 export interface ClassifyConfiguration {
     /**
-     * Classification rules to apply (at least one required)
+     * Classify rules to evaluate against the document (at least one required)
      */
     rules: Array<ClassifyConfiguration.Rule>;
     /**
-     * Classification execution mode
+     * Classify execution mode
      */
     mode?: 'FAST';
+    /**
+     * Parsing configuration for classify jobs.
+     */
+    parsing_configuration?: ClassifyConfiguration.ParsingConfiguration | null;
 }
 export declare namespace ClassifyConfiguration {
     /**
@@ -36,7 +57,7 @@ export declare namespace ClassifyConfiguration {
      */
     interface Rule {
         /**
-         * Natural language description of what to classify
+         * Natural language criteria for matching this rule
          */
         description: string;
         /**
@@ -44,25 +65,47 @@ export declare namespace ClassifyConfiguration {
          */
         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 classification.
+     * Configuration for a classify job.
      */
     configuration?: ClassifyConfiguration | null;
     /**
-     * Product configuration ID for reusable presets
+     * Saved configuration ID
      */
     configuration_id?: string | null;
     /**
-     * File ID to classify
+     * @deprecated Deprecated: use file_input instead
      */
     file_id?: string | null;
     /**
-     * Parse job ID to classify
+     * File ID or parse job ID to classify
+     */
+    file_input?: string | null;
+    /**
+     * @deprecated Deprecated: use file_input instead
      */
     parse_job_id?: string | null;
     /**
@@ -75,15 +118,15 @@ export interface ClassifyCreateRequest {
  */
 export interface ClassifyResult {
     /**
-     * Confidence score (0.0-1.0)
+     * Confidence score between 0.0 and 1.0
      */
     confidence: number;
     /**
-     * Explanation of classification decision
+     * Why the document matched (or didn't match) the returned rule
      */
     reasoning: string;
     /**
-     * Document type that matches, or None
+     * Matched rule type, or null if no rule matched
      */
     type: string | null;
 }
@@ -96,27 +139,27 @@ export interface ClassifyCreateResponse {
      */
     id: string;
     /**
-     * Classification configuration
+     * Classify configuration used for this job
      */
     configuration: ClassifyConfiguration;
     /**
-     * Type of document input
+     * Whether the input was a file or parse job (FILE or PARSE_JOB)
      */
     document_input_type: 'url' | 'file_id' | 'parse_job_id';
     /**
-     * Document identifier
+     * ID of the input file or parse job
      */
-    document_input_value: string;
+    file_input: string;
     /**
-     * Project ID
+     * Project this job belongs to
      */
     project_id: string;
     /**
-     * Job status
+     * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
      */
     status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
     /**
-     * User ID
+     * User who created this job
      */
     user_id: string;
     /**
@@ -157,27 +200,27 @@ export interface ClassifyListResponse {
      */
     id: string;
     /**
-     * Classification configuration
+     * Classify configuration used for this job
      */
     configuration: ClassifyConfiguration;
     /**
-     * Type of document input
+     * Whether the input was a file or parse job (FILE or PARSE_JOB)
      */
     document_input_type: 'url' | 'file_id' | 'parse_job_id';
     /**
-     * Document identifier
+     * ID of the input file or parse job
      */
-    document_input_value: string;
+    file_input: string;
     /**
-     * Project ID
+     * Project this job belongs to
      */
     project_id: string;
     /**
-     * Job status
+     * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
      */
     status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
     /**
-     * User ID
+     * User who created this job
      */
     user_id: string;
     /**
@@ -218,27 +261,27 @@ export interface ClassifyGetResponse {
      */
     id: string;
     /**
-     * Classification configuration
+     * Classify configuration used for this job
      */
     configuration: ClassifyConfiguration;
     /**
-     * Type of document input
+     * Whether the input was a file or parse job (FILE or PARSE_JOB)
      */
     document_input_type: 'url' | 'file_id' | 'parse_job_id';
     /**
-     * Document identifier
+     * ID of the input file or parse job
      */
-    document_input_value: string;
+    file_input: string;
     /**
-     * Project ID
+     * Project this job belongs to
      */
     project_id: string;
     /**
-     * Job status
+     * Current job status: PENDING, RUNNING, COMPLETED, or FAILED
      */
     status: 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED';
     /**
-     * User ID
+     * User who created this job
      */
     user_id: string;
     /**
@@ -280,19 +323,23 @@ export interface ClassifyCreateParams {
      */
     project_id?: string | null;
     /**
-     * Body param: Configuration for classification.
+     * Body param: Configuration for a classify job.
      */
     configuration?: ClassifyConfiguration | null;
     /**
-     * Body param: Product configuration ID for reusable presets
+     * Body param: Saved configuration ID
      */
     configuration_id?: string | null;
     /**
-     * Body param: File ID to classify
+     * @deprecated Body param: Deprecated: use file_input instead
      */
     file_id?: string | null;
     /**
-     * Body param: Parse job ID to classify
+     * Body param: File ID or parse job ID to classify
+     */
+    file_input?: string | null;
+    /**
+     * @deprecated Body param: Deprecated: use file_input instead
      */
     parse_job_id?: string | null;
     /**
@@ -305,6 +352,14 @@ export interface ClassifyListParams extends PaginatedCursorParams {
      * Filter by configuration ID
      */
     configuration_id?: string | null;
+    /**
+     * Include items created at or after this timestamp (inclusive)
+     */
+    created_at_on_or_after?: string | null;
+    /**
+     * Include items created at or before this timestamp (inclusive)
+     */
+    created_at_on_or_before?: string | null;
     /**
      * Filter by specific job IDs
      */

package/resources/classify.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"classify.d.ts","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;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IASlG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,oBAAoB,CAAC;IAO1E;;OAEG;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;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;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,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"}
+{"version":3,"file":"classify.d.ts","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,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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"}

package/resources/classify.js

@@ -8,6 +8,17 @@ const path_1 = require("../internal/utils/path.js");
 class Classify extends resource_1.APIResource {
     /**
      * Create a classify job.
+     *
+     * Classifies a document against a set of rules. Set `file_input` to a file ID
+     * (`dfl-...`) or parse job ID (`pjb-...`), and provide 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, options) {
         const { organization_id, project_id, ...body } = params;
@@ -18,7 +29,10 @@ class Classify extends resource_1.APIResource {
         });
     }
     /**
-     * List classify jobs.
+     * List classify jobs with optional filtering and pagination.
+     *
+     * Filter by `status`, `configuration_id`, specific `job_ids`, or creation date
+     * range.
      */
     list(query = {}, options) {
         return this._client.getAPIList('/api/v2/classify', (pagination_1.PaginatedCursor), {
@@ -27,7 +41,10 @@ class Classify extends resource_1.APIResource {
         });
     }
     /**
-     * Retrieve classify job by ID.
+     * 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, query = {}, options) {
         return this._client.get((0, path_1.path) `/api/v2/classify/${jobID}`, { query, ...options });

package/resources/classify.js.map

@@ -1 +1 @@
-{"version":3,"file":"classify.js","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA8F;AAE9F,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,4BAAqC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,GAAG,CACD,KAAa,EACb,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AApCD,4BAoCC"}
+{"version":3,"file":"classify.js","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA8F;AAE9F,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,4BAAqC,CAAA,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CACD,KAAa,EACb,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AArDD,4BAqDC"}