@mixedbread/sdk 0.1.0-alpha.10

package/resources/files.js

@@ -0,0 +1,99 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileObjectsLimitOffset = exports.Files = void 0;
+const resource_1 = require("../resource.js");
+const core_1 = require("../core.js");
+const Core = __importStar(require("../core.js"));
+const pagination_1 = require("../pagination.js");
+class Files extends resource_1.APIResource {
+    /**
+     * Upload a new file.
+     *
+     * Args: file: The file to upload.
+     *
+     * Returns: FileResponse: The response containing the details of the uploaded file.
+     */
+    create(body, options) {
+        return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Retrieve details of a specific file by its ID.
+     *
+     * Args: file_id: The ID of the file to retrieve.
+     *
+     * Returns: FileResponse: The response containing the file details.
+     */
+    retrieve(fileId, options) {
+        return this._client.get(`/v1/files/${fileId}`, options);
+    }
+    /**
+     * Update the details of a specific file.
+     *
+     * Args: file_id: The ID of the file to update. file: The new details for the file.
+     *
+     * Returns: FileObject: The updated file details.
+     */
+    update(fileId, body, options) {
+        return this._client.post(`/v1/files/${fileId}`, Core.multipartFormRequestOptions({ body, ...options }));
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/v1/files', FileObjectsLimitOffset, { query, ...options });
+    }
+    /**
+     * Delete a specific file by its ID.
+     *
+     * Args: file_id: The ID of the file to delete.
+     *
+     * Returns: FileDeleted: The response containing the details of the deleted file.
+     */
+    delete(fileId, options) {
+        return this._client.delete(`/v1/files/${fileId}`, options);
+    }
+    /**
+     * Download a specific file by its ID.
+     *
+     * Args: file_id: The ID of the file to download.
+     *
+     * Returns: FileStreamResponse: The response containing the file to be downloaded.
+     */
+    content(fileId, options) {
+        return this._client.get(`/v1/files/${fileId}/content`, {
+            ...options,
+            headers: { Accept: 'application/octet-stream', ...options?.headers },
+            __binaryResponse: true,
+        });
+    }
+}
+exports.Files = Files;
+class FileObjectsLimitOffset extends pagination_1.LimitOffset {
+}
+exports.FileObjectsLimitOffset = FileObjectsLimitOffset;
+Files.FileObjectsLimitOffset = FileObjectsLimitOffset;
+//# sourceMappingURL=files.js.map

package/resources/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAC3C,iDAAgC;AAChC,iDAAoE;AAGpE,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;OAMG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,MAAc,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,MAAM,EAAE,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC;IAcD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,UAAU,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;YACpE,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAjFD,sBAiFC;AAED,MAAa,sBAAuB,SAAQ,wBAAuB;CAAG;AAAtE,wDAAsE;AA8EtE,KAAK,CAAC,sBAAsB,GAAG,sBAAsB,CAAC"}

package/resources/files.mjs

@@ -0,0 +1,71 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+import { isRequestOptions } from "../core.mjs";
+import * as Core from "../core.mjs";
+import { LimitOffset } from "../pagination.mjs";
+export class Files extends APIResource {
+    /**
+     * Upload a new file.
+     *
+     * Args: file: The file to upload.
+     *
+     * Returns: FileResponse: The response containing the details of the uploaded file.
+     */
+    create(body, options) {
+        return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Retrieve details of a specific file by its ID.
+     *
+     * Args: file_id: The ID of the file to retrieve.
+     *
+     * Returns: FileResponse: The response containing the file details.
+     */
+    retrieve(fileId, options) {
+        return this._client.get(`/v1/files/${fileId}`, options);
+    }
+    /**
+     * Update the details of a specific file.
+     *
+     * Args: file_id: The ID of the file to update. file: The new details for the file.
+     *
+     * Returns: FileObject: The updated file details.
+     */
+    update(fileId, body, options) {
+        return this._client.post(`/v1/files/${fileId}`, Core.multipartFormRequestOptions({ body, ...options }));
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this._client.getAPIList('/v1/files', FileObjectsLimitOffset, { query, ...options });
+    }
+    /**
+     * Delete a specific file by its ID.
+     *
+     * Args: file_id: The ID of the file to delete.
+     *
+     * Returns: FileDeleted: The response containing the details of the deleted file.
+     */
+    delete(fileId, options) {
+        return this._client.delete(`/v1/files/${fileId}`, options);
+    }
+    /**
+     * Download a specific file by its ID.
+     *
+     * Args: file_id: The ID of the file to download.
+     *
+     * Returns: FileStreamResponse: The response containing the file to be downloaded.
+     */
+    content(fileId, options) {
+        return this._client.get(`/v1/files/${fileId}/content`, {
+            ...options,
+            headers: { Accept: 'application/octet-stream', ...options?.headers },
+            __binaryResponse: true,
+        });
+    }
+}
+export class FileObjectsLimitOffset extends LimitOffset {
+}
+Files.FileObjectsLimitOffset = FileObjectsLimitOffset;
+//# sourceMappingURL=files.mjs.map

package/resources/files.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OACpB,KAAK,IAAI;OACT,EAAE,WAAW,EAA0B;AAG9C,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;OAMG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,MAAc,EAAE,OAA6B;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,IAAsB,EAAE,OAA6B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,MAAM,EAAE,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC;IAcD,IAAI,CACF,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,OAA6B;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,MAAc,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,UAAU,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;YACpE,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,WAAuB;CAAG;AA8EtE,KAAK,CAAC,sBAAsB,GAAG,sBAAsB,CAAC"}

package/resources/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./shared.js";
+export { Embeddings, type Embedding, type EmbeddingCreateResponse, type EmbeddingCreateParams, } from "./embeddings.js";
+export { Extractions } from "./extractions/extractions.js";
+export { FileObjectsLimitOffset, Files, type FileObject, type FileDeleteResponse, type FileCreateParams, type FileUpdateParams, type FileListParams, } from "./files.js";
+export { Parsing } from "./parsing/parsing.js";
+export { VectorStoresLimitOffset, VectorStores, type ExpiresAfter, type FileCounts, type ScoredVectorStoreChunk, type VectorStore, type VectorStoreChunkSearchOptions, type VectorStoreFileSearchOptions, type VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse, type VectorStoreCreateParams, type VectorStoreUpdateParams, type VectorStoreListParams, type VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams, } from "./vector-stores/vector-stores.js";
+export { type InfoResponse, type RerankResponse, type EmbedParams, type RerankParams } from "./top-level.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,GAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,sBAAsB,EACtB,KAAK,EACL,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EACL,uBAAuB,EACvB,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,6BAA6B,EAClC,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,kCAAkC,EACvC,KAAK,uBAAuB,GAC7B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/resources/index.js

@@ -0,0 +1,32 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorStores = exports.VectorStoresLimitOffset = exports.Parsing = exports.Files = exports.FileObjectsLimitOffset = exports.Extractions = exports.Embeddings = void 0;
+__exportStar(require("./shared.js"), exports);
+var embeddings_1 = require("./embeddings.js");
+Object.defineProperty(exports, "Embeddings", { enumerable: true, get: function () { return embeddings_1.Embeddings; } });
+var extractions_1 = require("./extractions/extractions.js");
+Object.defineProperty(exports, "Extractions", { enumerable: true, get: function () { return extractions_1.Extractions; } });
+var files_1 = require("./files.js");
+Object.defineProperty(exports, "FileObjectsLimitOffset", { enumerable: true, get: function () { return files_1.FileObjectsLimitOffset; } });
+Object.defineProperty(exports, "Files", { enumerable: true, get: function () { return files_1.Files; } });
+var parsing_1 = require("./parsing/parsing.js");
+Object.defineProperty(exports, "Parsing", { enumerable: true, get: function () { return parsing_1.Parsing; } });
+var vector_stores_1 = require("./vector-stores/vector-stores.js");
+Object.defineProperty(exports, "VectorStoresLimitOffset", { enumerable: true, get: function () { return vector_stores_1.VectorStoresLimitOffset; } });
+Object.defineProperty(exports, "VectorStores", { enumerable: true, get: function () { return vector_stores_1.VectorStores; } });
+//# sourceMappingURL=index.js.map

package/resources/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,8CAAyB;AACzB,8CAKsB;AAJpB,wGAAA,UAAU,OAAA;AAKZ,4DAAwD;AAA/C,0GAAA,WAAW,OAAA;AACpB,oCAQiB;AAPf,+GAAA,sBAAsB,OAAA;AACtB,8FAAA,KAAK,OAAA;AAOP,gDAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,kEAiBuC;AAhBrC,wHAAA,uBAAuB,OAAA;AACvB,6GAAA,YAAY,OAAA"}

package/resources/index.mjs

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./shared.mjs";
+export { Embeddings, } from "./embeddings.mjs";
+export { Extractions } from "./extractions/extractions.mjs";
+export { FileObjectsLimitOffset, Files, } from "./files.mjs";
+export { Parsing } from "./parsing/parsing.mjs";
+export { VectorStoresLimitOffset, VectorStores, } from "./vector-stores/vector-stores.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,UAAU,GAIX;OACM,EAAE,WAAW,EAAE;OACf,EACL,sBAAsB,EACtB,KAAK,GAMN;OACM,EAAE,OAAO,EAAE;OACX,EACL,uBAAuB,EACvB,YAAY,GAeb"}

package/resources/parsing/index.d.ts

@@ -0,0 +1,3 @@
+export { JobListResponsesLimitOffset, Jobs, type ParsingJob, type JobListResponse, type JobDeleteResponse, type JobCreateParams, type JobListParams, } from "./jobs.js";
+export { Parsing } from "./parsing.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/parsing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/parsing/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,2BAA2B,EAC3B,IAAI,EACJ,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}

package/resources/parsing/index.js

@@ -0,0 +1,10 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parsing = exports.Jobs = exports.JobListResponsesLimitOffset = void 0;
+var jobs_1 = require("./jobs.js");
+Object.defineProperty(exports, "JobListResponsesLimitOffset", { enumerable: true, get: function () { return jobs_1.JobListResponsesLimitOffset; } });
+Object.defineProperty(exports, "Jobs", { enumerable: true, get: function () { return jobs_1.Jobs; } });
+var parsing_1 = require("./parsing.js");
+Object.defineProperty(exports, "Parsing", { enumerable: true, get: function () { return parsing_1.Parsing; } });
+//# sourceMappingURL=index.js.map

package/resources/parsing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/parsing/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kCAQgB;AAPd,mHAAA,2BAA2B,OAAA;AAC3B,4FAAA,IAAI,OAAA;AAON,wCAAoC;AAA3B,kGAAA,OAAO,OAAA"}

package/resources/parsing/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { JobListResponsesLimitOffset, Jobs, } from "./jobs.mjs";
+export { Parsing } from "./parsing.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/parsing/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/parsing/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,2BAA2B,EAC3B,IAAI,GAML;OACM,EAAE,OAAO,EAAE"}

package/resources/parsing/jobs.d.ts

@@ -0,0 +1,290 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import { LimitOffset, type LimitOffsetParams } from "../../pagination.js";
+import { Uploadable } from "../../uploads.js";
+export declare class Jobs extends APIResource {
+    /**
+     * Start a parse job for the provided file.
+     *
+     * Args: params: The parameters for creating a parse job.
+     *
+     * Returns: The created parsing job.
+     */
+    create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<ParsingJob>;
+    /**
+     * Get detailed information about a specific parse job.
+     *
+     * Args: job_id: The ID of the parse job.
+     *
+     * Returns: Detailed information about the parse job.
+     */
+    retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ParsingJob>;
+    /**
+     * List parsing jobs with pagination.
+     *
+     * Args: limit: The number of items to return. offset: The number of items to skip.
+     *
+     * Returns: List of parsing jobs with pagination.
+     */
+    list(query?: JobListParams, options?: Core.RequestOptions): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse>;
+    list(options?: Core.RequestOptions): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse>;
+    /**
+     * Delete a specific parse job.
+     *
+     * Args: job_id: The ID of the parse job to delete.
+     *
+     * Returns: The deleted parsing job.
+     */
+    delete(jobId: string, options?: Core.RequestOptions): Core.APIPromise<JobDeleteResponse>;
+    /**
+     * Cancel a specific parse job.
+     *
+     * Args: job_id: The ID of the parse job to cancel.
+     *
+     * Returns: The cancelled parsing job.
+     */
+    cancel(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ParsingJob>;
+    /**
+     * Poll for a job's status until it reaches a terminal state.
+     *
+     * @param jobId - The ID of the job to poll
+     * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
+     * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
+     * @param options - Additional request options
+     * @returns The job object once it reaches a terminal state
+     */
+    poll(jobId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?: Core.RequestOptions): Promise<ParsingJob>;
+    /**
+     * Create a parsing job and wait for it to complete.
+     *
+     * @param body - Parameters for creating a parse job
+     * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
+     * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
+     * @param options - Additional request options
+     * @returns The job object once it reaches a terminal state
+     */
+    createAndPoll(body: JobCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?: Core.RequestOptions): Promise<ParsingJob>;
+    /**
+     * Upload a file to the files API and then create a parsing job for it.
+     * Note the job will be asynchronously processed.
+     *
+     * @param file - The file to upload
+     * @param body - Additional parameters for creating a parse job
+     * @param options - Additional request options
+     * @returns The created parsing job
+     */
+    upload(file: Uploadable, body?: Omit<JobCreateParams, 'file_id'>, options?: Core.RequestOptions): Promise<ParsingJob>;
+    /**
+     * Upload a file and create a parsing job, then poll until processing is complete.
+     *
+     * @param file - The file to upload
+     * @param body - Additional parameters for creating a parse job
+     * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
+     * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
+     * @param options - Additional request options
+     * @returns The job object once it reaches a terminal state
+     */
+    uploadAndPoll(file: Uploadable, body?: Omit<JobCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?: Core.RequestOptions): Promise<ParsingJob>;
+}
+export declare class JobListResponsesLimitOffset extends LimitOffset<JobListResponse> {
+}
+/**
+ * A job for parsing documents with its current state and result.
+ */
+export interface ParsingJob {
+    /**
+     * The ID of the job
+     */
+    id: string;
+    /**
+     * The ID of the file to parse
+     */
+    file_id: string;
+    /**
+     * The status of the job
+     */
+    status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+    /**
+     * The error of the job
+     */
+    error?: unknown;
+    /**
+     * Result of document parsing operation.
+     */
+    result?: ParsingJob.Result | null;
+    /**
+     * The started time of the job
+     */
+    started_at?: string | null;
+    /**
+     * The finished time of the job
+     */
+    finished_at?: string | null;
+    /**
+     * The creation time of the job
+     */
+    created_at?: string;
+    /**
+     * The updated time of the job
+     */
+    updated_at?: string | null;
+    /**
+     * The type of the object
+     */
+    object?: 'parsing_job';
+}
+export declare namespace ParsingJob {
+    /**
+     * Result of document parsing operation.
+     */
+    interface Result {
+        /**
+         * The strategy used for chunking the document
+         */
+        chunking_strategy: 'page';
+        /**
+         * The format of the returned content
+         */
+        return_format: 'html' | 'markdown' | 'plain';
+        /**
+         * The types of elements extracted
+         */
+        element_types: Array<'caption' | 'footnote' | 'formula' | 'list-item' | 'page-footer' | 'page-header' | 'picture' | 'section-header' | 'table' | 'text' | 'title'>;
+        /**
+         * List of extracted chunks from the document
+         */
+        chunks: Array<Result.Chunk>;
+        /**
+         * List of (width, height) tuples for each page
+         */
+        page_sizes?: Array<Array<unknown>>;
+    }
+    namespace Result {
+        /**
+         * A chunk of text extracted from a document page.
+         */
+        interface Chunk {
+            /**
+             * The full content of the chunk
+             */
+            content: string;
+            /**
+             * The content to be used for embedding
+             */
+            content_to_embed: string;
+            /**
+             * List of elements contained in this chunk
+             */
+            elements: Array<Chunk.Element>;
+        }
+        namespace Chunk {
+            /**
+             * Represents an extracted element from a document with its content and metadata.
+             */
+            interface Element {
+                /**
+                 * The type of the extracted element
+                 */
+                type: 'caption' | 'footnote' | 'formula' | 'list-item' | 'page-footer' | 'page-header' | 'picture' | 'section-header' | 'table' | 'text' | 'title';
+                /**
+                 * The confidence score of the extraction
+                 */
+                confidence: number;
+                /**
+                 * The bounding box coordinates [x1, y1, x2, y2]
+                 */
+                bbox: Array<unknown>;
+                /**
+                 * The page number where the element was found
+                 */
+                page: number;
+                /**
+                 * The full content of the extracted element
+                 */
+                content: string;
+                /**
+                 * A brief summary of the element's content
+                 */
+                summary?: string | null;
+            }
+        }
+    }
+}
+/**
+ * A parsing job item for list responses, omitting result and error fields.
+ */
+export interface JobListResponse {
+    /**
+     * The ID of the job
+     */
+    id: string;
+    /**
+     * The ID of the file to parse
+     */
+    file_id: string;
+    /**
+     * The status of the job
+     */
+    status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+    /**
+     * The started time of the job
+     */
+    started_at?: string | null;
+    /**
+     * The finished time of the job
+     */
+    finished_at?: string | null;
+    /**
+     * The creation time of the job
+     */
+    created_at?: string;
+    /**
+     * The updated time of the job
+     */
+    updated_at?: string | null;
+    /**
+     * The type of the object
+     */
+    object?: 'parsing_job';
+}
+/**
+ * A deleted parsing job.
+ */
+export interface JobDeleteResponse {
+    /**
+     * The ID of the deleted job
+     */
+    id: string;
+    /**
+     * Whether the job was deleted
+     */
+    deleted?: boolean;
+    /**
+     * The type of the object
+     */
+    object?: 'parsing_job';
+}
+export interface JobCreateParams {
+    /**
+     * The ID of the file to parse
+     */
+    file_id: string;
+    /**
+     * The elements to extract from the document
+     */
+    element_types?: Array<'caption' | 'footnote' | 'formula' | 'list-item' | 'page-footer' | 'page-header' | 'picture' | 'section-header' | 'table' | 'text' | 'title'> | null;
+    /**
+     * The strategy to use for chunking the content
+     */
+    chunking_strategy?: 'page';
+    /**
+     * The format of the returned content
+     */
+    return_format?: 'html' | 'markdown' | 'plain';
+}
+export interface JobListParams extends LimitOffsetParams {
+}
+export declare namespace Jobs {
+    export { type ParsingJob as ParsingJob, type JobListResponse as JobListResponse, type JobDeleteResponse as JobDeleteResponse, JobListResponsesLimitOffset as JobListResponsesLimitOffset, type JobCreateParams as JobCreateParams, type JobListParams as JobListParams, };
+}
+//# sourceMappingURL=jobs.d.ts.map

package/resources/parsing/jobs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../src/resources/parsing/jobs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAEvE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAIzF;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAInF;;;;;;OAMG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,eAAe,CAAC;IACjE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,eAAe,CAAC;IAWnG;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAIxF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;IAIjF;;;;;;;;OAQG;IACG,IAAI,CACR,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;IAatB;;;;;;;;OAQG;IACG,aAAa,CACjB,IAAI,EAAE,eAAe,EACrB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;IAKtB;;;;;;;;OAQG;IACG,MAAM,CACV,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,EACvC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;IAYtB;;;;;;;;;OASG;IACG,aAAa,CACjB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,EACvC,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,UAAU,CAAC;CAIvB;AAED,qBAAa,2BAA4B,SAAQ,WAAW,CAAC,eAAe,CAAC;CAAG;AAEhF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;QAE7C;;WAEG;QACH,aAAa,EAAE,KAAK,CAChB,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,aAAa,GACb,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,OAAO,CACV,CAAC;QAEF;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;KACpC;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAChC;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,IAAI,EACA,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,aAAa,GACb,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,OAAO,CAAC;gBAEZ;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;gBAErB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,OAAO,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACzB;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEzE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CACjB,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,aAAa,GACb,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,OAAO,CACV,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;CAC/C;AAED,MAAM,WAAW,aAAc,SAAQ,iBAAiB;CAAG;AAI3D,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}