pulse-ts-sdk 0.0.53 → 0.0.55

package/README.md

@@ -12,6 +12,7 @@ The Pulse TypeScript library provides convenient access to the Pulse APIs from T
 - [Usage](#usage)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
+- [File Uploads](#file-uploads)
 - [Advanced](#advanced)
   - [Additional Headers](#additional-headers)
   - [Additional Query String Parameters](#additional-query-string-parameters)
@@ -38,12 +39,11 @@ A full reference for this library is available [here](https://github.com/Pulse-S
 Instantiate and use the client with the following:
 
 ```typescript
+import { createReadStream } from "fs";
 import { PulseClient } from "pulse-ts-sdk";
 
 const client = new PulseClient({ apiKey: "YOUR_API_KEY" });
-await client.extract({
-    fileUrl: "fileUrl"
-});
+await client.extract({});
 ```
 
 ## Request and Response Types
@@ -79,6 +79,47 @@ try {
 }
 ```
 
+## File Uploads
+
+You can upload files using the client:
+
+```typescript
+import { createReadStream } from "fs";
+import { PulseClient } from "pulse-ts-sdk";
+
+const client = new PulseClient({ apiKey: "YOUR_API_KEY" });
+await client.extract({});
+```
+The client accepts a variety of types for file upload parameters:
+* Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
+* Buffered types: `Buffer`, `Blob`, `File`, `ArrayBuffer`, `ArrayBufferView`, and `Uint8Array`
+
+### Metadata
+
+You can configure metadata when uploading a file:
+```typescript
+const file: Uploadable.WithMetadata = {
+    data: createReadStream("path/to/file"),
+    filename: "my-file",       // optional
+    contentType: "audio/mpeg", // optional
+    contentLength: 1949,       // optional
+};
+```
+
+Alternatively, you can upload a file directly from a file path:
+```typescript
+const file : Uploadable.FromPath = {
+    path: "path/to/file",
+    filename: "my-file",        // optional
+    contentType: "audio/mpeg",  // optional
+    contentLength: 1949,        // optional
+};
+```
+
+The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-Disposition` headers. If not provided, the client will attempt to determine them automatically.
+For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
+
+
 ## Advanced
 
 ### Additional Headers

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "pulse-ts-sdk",
-        "X-Fern-SDK-Version": "0.0.53",
-        "User-Agent": "pulse-ts-sdk/0.0.53",
+        "X-Fern-SDK-Version": "0.0.55",
+        "User-Agent": "pulse-ts-sdk/0.0.55",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/Client.d.ts

@@ -21,7 +21,7 @@ export declare class PulseClient {
      * file URLs and returns rich markdown content with optional structured data
      * extraction based on user-provided schemas and extraction options.
      *
-     * @param {Pulse.ExtractJsonInput} request
+     * @param {Pulse.ExtractRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -29,18 +29,17 @@ export declare class PulseClient {
      * @throws {@link Pulse.TooManyRequestsError}
      *
      * @example
-     *     await client.extract({
-     *         fileUrl: "fileUrl"
-     *     })
+     *     import { createReadStream } from "fs";
+     *     await client.extract({})
      */
-    extract(request: Pulse.ExtractJsonInput, requestOptions?: PulseClient.RequestOptions): core.HttpResponsePromise<Pulse.ExtractResponse>;
+    extract(request: Pulse.ExtractRequest, requestOptions?: PulseClient.RequestOptions): core.HttpResponsePromise<Pulse.ExtractResponse>;
     private __extract;
     /**
      * Starts an asynchronous extraction job. The request mirrors the
      * synchronous options but returns immediately with a job identifier that
      * clients can poll for completion status.
      *
-     * @param {Pulse.ExtractJsonInput} request
+     * @param {Pulse.ExtractAsyncRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -48,10 +47,9 @@ export declare class PulseClient {
      * @throws {@link Pulse.TooManyRequestsError}
      *
      * @example
-     *     await client.extractAsync({
-     *         fileUrl: "fileUrl"
-     *     })
+     *     import { createReadStream } from "fs";
+     *     await client.extractAsync({})
      */
-    extractAsync(request: Pulse.ExtractJsonInput, requestOptions?: PulseClient.RequestOptions): core.HttpResponsePromise<Pulse.ExtractAsyncResponse>;
+    extractAsync(request: Pulse.ExtractAsyncRequest, requestOptions?: PulseClient.RequestOptions): core.HttpResponsePromise<Pulse.ExtractAsyncResponse>;
     private __extractAsync;
 }

package/dist/cjs/Client.js

@@ -50,6 +50,7 @@ const Client_js_2 = require("./api/resources/webhooks/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
+const json_js_1 = require("./core/json.js");
 const environments = __importStar(require("./environments.js"));
 const handleNonStatusCodeError_js_1 = require("./errors/handleNonStatusCodeError.js");
 const errors = __importStar(require("./errors/index.js"));
@@ -70,7 +71,7 @@ class PulseClient {
      * file URLs and returns rich markdown content with optional structured data
      * extraction based on user-provided schemas and extraction options.
      *
-     * @param {Pulse.ExtractJsonInput} request
+     * @param {Pulse.ExtractRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -78,9 +79,8 @@ class PulseClient {
      * @throws {@link Pulse.TooManyRequestsError}
      *
      * @example
-     *     await client.extract({
-     *         fileUrl: "fileUrl"
-     *     })
+     *     import { createReadStream } from "fs";
+     *     await client.extract({})
      */
     extract(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__extract(request, requestOptions));
@@ -88,15 +88,64 @@ class PulseClient {
     __extract(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _request = yield core.newFormData();
+            if (request.file != null) {
+                yield _request.appendFile("file", request.file);
+            }
+            if (request.fileUrl != null) {
+                _request.append("fileUrl", request.fileUrl);
+            }
+            if (request.structuredOutput != null) {
+                _request.append("structuredOutput", (0, json_js_1.toJson)(request.structuredOutput));
+            }
+            if (request.schema != null) {
+                _request.append("schema", typeof request.schema === "string" ? request.schema : (0, json_js_1.toJson)(request.schema));
+            }
+            if (request.experimentalSchema != null) {
+                _request.append("experimentalSchema", typeof request.experimentalSchema === "string"
+                    ? request.experimentalSchema
+                    : (0, json_js_1.toJson)(request.experimentalSchema));
+            }
+            if (request.schemaPrompt != null) {
+                _request.append("schemaPrompt", request.schemaPrompt);
+            }
+            if (request.customPrompt != null) {
+                _request.append("customPrompt", request.customPrompt);
+            }
+            if (request.chunking != null) {
+                _request.append("chunking", request.chunking);
+            }
+            if (request.chunkSize != null) {
+                _request.append("chunkSize", request.chunkSize.toString());
+            }
+            if (request.pages != null) {
+                _request.append("pages", request.pages);
+            }
+            if (request.extractFigure != null) {
+                _request.append("extractFigure", request.extractFigure.toString());
+            }
+            if (request.figureDescription != null) {
+                _request.append("figureDescription", request.figureDescription.toString());
+            }
+            if (request.returnHtml != null) {
+                _request.append("returnHtml", request.returnHtml.toString());
+            }
+            if (request.thinking != null) {
+                _request.append("thinking", request.thinking.toString());
+            }
+            if (request.storage != null) {
+                _request.append("storage", (0, json_js_1.toJson)(request.storage));
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PulseEnvironment.Default, "extract"),
                 method: "POST",
                 headers: _headers,
-                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -130,7 +179,7 @@ class PulseClient {
      * synchronous options but returns immediately with a job identifier that
      * clients can poll for completion status.
      *
-     * @param {Pulse.ExtractJsonInput} request
+     * @param {Pulse.ExtractAsyncRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pulse.BadRequestError}
@@ -138,9 +187,8 @@ class PulseClient {
      * @throws {@link Pulse.TooManyRequestsError}
      *
      * @example
-     *     await client.extractAsync({
-     *         fileUrl: "fileUrl"
-     *     })
+     *     import { createReadStream } from "fs";
+     *     await client.extractAsync({})
      */
     extractAsync(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__extractAsync(request, requestOptions));
@@ -148,15 +196,64 @@ class PulseClient {
     __extractAsync(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _request = yield core.newFormData();
+            if (request.file != null) {
+                yield _request.appendFile("file", request.file);
+            }
+            if (request.fileUrl != null) {
+                _request.append("fileUrl", request.fileUrl);
+            }
+            if (request.structuredOutput != null) {
+                _request.append("structuredOutput", (0, json_js_1.toJson)(request.structuredOutput));
+            }
+            if (request.schema != null) {
+                _request.append("schema", typeof request.schema === "string" ? request.schema : (0, json_js_1.toJson)(request.schema));
+            }
+            if (request.experimentalSchema != null) {
+                _request.append("experimentalSchema", typeof request.experimentalSchema === "string"
+                    ? request.experimentalSchema
+                    : (0, json_js_1.toJson)(request.experimentalSchema));
+            }
+            if (request.schemaPrompt != null) {
+                _request.append("schemaPrompt", request.schemaPrompt);
+            }
+            if (request.customPrompt != null) {
+                _request.append("customPrompt", request.customPrompt);
+            }
+            if (request.chunking != null) {
+                _request.append("chunking", request.chunking);
+            }
+            if (request.chunkSize != null) {
+                _request.append("chunkSize", request.chunkSize.toString());
+            }
+            if (request.pages != null) {
+                _request.append("pages", request.pages);
+            }
+            if (request.extractFigure != null) {
+                _request.append("extractFigure", request.extractFigure.toString());
+            }
+            if (request.figureDescription != null) {
+                _request.append("figureDescription", request.figureDescription.toString());
+            }
+            if (request.returnHtml != null) {
+                _request.append("returnHtml", request.returnHtml.toString());
+            }
+            if (request.thinking != null) {
+                _request.append("thinking", request.thinking.toString());
+            }
+            if (request.storage != null) {
+                _request.append("storage", (0, json_js_1.toJson)(request.storage));
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PulseEnvironment.Default, "extract_async"),
                 method: "POST",
                 headers: _headers,
-                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                requestType: "json",
-                body: request,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/cjs/api/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/dist/cjs/api/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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 });
+__exportStar(require("./requests/index.js"), exports);

package/dist/{esm/api/types/ExtractJsonInput.d.mts → cjs/api/client/requests/ExtractAsyncRequest.d.ts}

@@ -1,15 +1,19 @@
+import type * as core from "../../../core/index.js";
 /**
- * Input schema for JSON requests (fileUrl only).
+ * @example
+ *     {}
  */
-export interface ExtractJsonInput {
-    /** Public or pre-signed URL that Pulse will download and extract. */
-    fileUrl: string;
+export interface ExtractAsyncRequest {
+    /** Document to upload directly. Required unless fileUrl is provided. */
+    file?: core.file.Uploadable | undefined;
+    /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
+    fileUrl?: string;
     /** Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object. */
-    structuredOutput?: ExtractJsonInput.StructuredOutput;
+    structuredOutput?: ExtractAsyncRequest.StructuredOutput;
     /** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
-    schema?: ExtractJsonInput.Schema;
+    schema?: ExtractAsyncRequest.Schema;
     /** (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation. */
-    experimentalSchema?: ExtractJsonInput.ExperimentalSchema;
+    experimentalSchema?: ExtractAsyncRequest.ExperimentalSchema;
     /** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
     schemaPrompt?: string;
     /** (Deprecated) Custom instructions that augment the default extraction behaviour. */
@@ -29,9 +33,9 @@ export interface ExtractJsonInput {
     /** (Deprecated) Enables expanded rationale output for debugging. */
     thinking?: boolean;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
-    storage?: ExtractJsonInput.Storage;
+    storage?: ExtractAsyncRequest.Storage;
 }
-export declare namespace ExtractJsonInput {
+export declare namespace ExtractAsyncRequest {
     /**
      * Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
      */

package/dist/cjs/api/{types/ExtractMultipartInput.d.ts → client/requests/ExtractRequest.d.ts}

@@ -1,17 +1,19 @@
+import type * as core from "../../../core/index.js";
 /**
- * Input schema for multipart/form-data requests (file upload or fileUrl).
+ * @example
+ *     {}
  */
-export interface ExtractMultipartInput {
+export interface ExtractRequest {
     /** Document to upload directly. Required unless fileUrl is provided. */
-    file?: string;
+    file?: core.file.Uploadable | undefined;
     /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
     fileUrl?: string;
     /** Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object. */
-    structuredOutput?: ExtractMultipartInput.StructuredOutput;
+    structuredOutput?: ExtractRequest.StructuredOutput;
     /** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
-    schema?: ExtractMultipartInput.Schema;
+    schema?: ExtractRequest.Schema;
     /** (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation. */
-    experimentalSchema?: ExtractMultipartInput.ExperimentalSchema;
+    experimentalSchema?: ExtractRequest.ExperimentalSchema;
     /** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
     schemaPrompt?: string;
     /** (Deprecated) Custom instructions that augment the default extraction behaviour. */
@@ -31,9 +33,9 @@ export interface ExtractMultipartInput {
     /** (Deprecated) Enables expanded rationale output for debugging. */
     thinking?: boolean;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
-    storage?: ExtractMultipartInput.Storage;
+    storage?: ExtractRequest.Storage;
 }
-export declare namespace ExtractMultipartInput {
+export declare namespace ExtractRequest {
     /**
      * Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
      */

package/dist/cjs/api/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export type { ExtractAsyncRequest } from "./ExtractAsyncRequest.js";
+export type { ExtractRequest } from "./ExtractRequest.js";

package/dist/cjs/api/{types/JsonSource.js → client/requests/index.js}

@@ -1,3 +1,2 @@
 "use strict";
-// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./client/index.js";
 export * from "./errors/index.js";
 export * from "./resources/index.js";
 export * from "./types/index.js";

package/dist/cjs/api/index.js

@@ -14,6 +14,7 @@ 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 });
+__exportStar(require("./client/index.js"), exports);
 __exportStar(require("./errors/index.js"), exports);
 __exportStar(require("./resources/index.js"), exports);
 __exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/types/ExtractInput.d.ts

@@ -1 +1,63 @@
-export type ExtractInput = unknown;
+/**
+ * Input schema for extraction requests. Provide either file (direct upload) or fileUrl (remote URL).
+ */
+export interface ExtractInput {
+    /** Document to upload directly. Required unless fileUrl is provided. */
+    file?: string;
+    /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
+    fileUrl?: string;
+    /** Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object. */
+    structuredOutput?: ExtractInput.StructuredOutput;
+    /** (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation. */
+    schema?: ExtractInput.Schema;
+    /** (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation. */
+    experimentalSchema?: ExtractInput.ExperimentalSchema;
+    /** (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead. */
+    schemaPrompt?: string;
+    /** (Deprecated) Custom instructions that augment the default extraction behaviour. */
+    customPrompt?: string;
+    /** Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`). */
+    chunking?: string;
+    /** Override for maximum characters per chunk when chunking is enabled. */
+    chunkSize?: number;
+    /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
+    pages?: string;
+    /** Toggle to enable figure extraction in results. */
+    extractFigure?: boolean;
+    /** Toggle to generate descriptive captions for extracted figures. */
+    figureDescription?: boolean;
+    /** Whether to include HTML representation alongside markdown in the response. */
+    returnHtml?: boolean;
+    /** (Deprecated) Enables expanded rationale output for debugging. */
+    thinking?: boolean;
+    /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
+    storage?: ExtractInput.Storage;
+}
+export declare namespace ExtractInput {
+    /**
+     * Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+     */
+    interface StructuredOutput {
+        /** JSON schema describing the structured data to extract. */
+        schema?: Record<string, unknown>;
+        /** Natural language prompt with additional extraction instructions. */
+        schemaPrompt?: string;
+    }
+    /**
+     * (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type Schema = Record<string, unknown> | string;
+    /**
+     * (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+     */
+    type ExperimentalSchema = Record<string, unknown> | string;
+    /**
+     * Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+     */
+    interface Storage {
+        /** Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record. */
+        enabled?: boolean;
+        /** Target folder name to save the extraction to. Creates the folder if it doesn't exist. */
+        folderName?: string;
+    }
+}

package/dist/cjs/api/types/{MultipartSource.d.ts → ExtractSource.d.ts}

@@ -1,7 +1,7 @@
 /**
  * Document source definition for multipart/form-data requests. Provide exactly one of `file` (direct upload) or `fileUrl` (remote URL).
  */
-export interface MultipartSource {
+export interface ExtractSource {
     /** Document to upload directly. Required unless fileUrl is provided. */
     file?: string;
     /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */

package/dist/cjs/api/types/index.d.ts

@@ -1,12 +1,8 @@
-export * from "./ExtractAsyncInput.js";
 export * from "./ExtractAsyncResponse.js";
 export * from "./ExtractInput.js";
-export * from "./ExtractJsonInput.js";
-export * from "./ExtractMultipartInput.js";
 export * from "./ExtractOptions.js";
 export * from "./ExtractResponse.js";
+export * from "./ExtractSource.js";
 export * from "./JobCancellationResponse.js";
 export * from "./JobStatus.js";
 export * from "./JobStatusResponse.js";
-export * from "./JsonSource.js";
-export * from "./MultipartSource.js";

package/dist/cjs/api/types/index.js

@@ -14,15 +14,11 @@ 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 });
-__exportStar(require("./ExtractAsyncInput.js"), exports);
 __exportStar(require("./ExtractAsyncResponse.js"), exports);
 __exportStar(require("./ExtractInput.js"), exports);
-__exportStar(require("./ExtractJsonInput.js"), exports);
-__exportStar(require("./ExtractMultipartInput.js"), exports);
 __exportStar(require("./ExtractOptions.js"), exports);
 __exportStar(require("./ExtractResponse.js"), exports);
+__exportStar(require("./ExtractSource.js"), exports);
 __exportStar(require("./JobCancellationResponse.js"), exports);
 __exportStar(require("./JobStatus.js"), exports);
 __exportStar(require("./JobStatusResponse.js"), exports);
-__exportStar(require("./JsonSource.js"), exports);
-__exportStar(require("./MultipartSource.js"), exports);

package/dist/cjs/core/exports.d.ts

@@ -1 +1,2 @@
+export * from "./file/exports.js";
 export * from "./logging/exports.js";

package/dist/cjs/core/exports.js

@@ -14,4 +14,5 @@ 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 });
+__exportStar(require("./file/exports.js"), exports);
 __exportStar(require("./logging/exports.js"), exports);

package/dist/cjs/core/file/exports.d.ts

@@ -0,0 +1 @@
+export type { Uploadable } from "./types.js";

package/dist/cjs/core/file/exports.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/core/file/file.d.ts

@@ -0,0 +1,10 @@
+import type { Uploadable } from "./types.js";
+export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
+    body: Uploadable.FileLike;
+    headers?: Record<string, string>;
+}>;
+export declare function toMultipartDataPart(file: Uploadable): Promise<{
+    data: Uploadable.FileLike;
+    filename?: string;
+    contentType?: string;
+}>;