@llamaindex/llama-cloud 1.8.0 → 2.1.0

package/resources/classify.mjs

@@ -5,6 +5,17 @@ import { path } from "../internal/utils/path.mjs";
 export 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, options) {
         const { organization_id, project_id, ...body } = params;
@@ -15,7 +26,10 @@ export class Classify extends 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', (PaginatedCursor), {
@@ -24,7 +38,10 @@ export class Classify extends 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(path `/api/v2/classify/${jobID}`, { query, ...options });

package/resources/classify.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"classify.mjs","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;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,eAAqC,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,IAAI,CAAA,oBAAoB,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}
+{"version":3,"file":"classify.mjs","sourceRoot":"","sources":["../src/resources/classify.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;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,eAAqC,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,IAAI,CAAA,oBAAoB,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}