pulse-ts-sdk 1.0.4 → 1.0.6

package/README.md

@@ -54,7 +54,7 @@ following namespace:
 ```typescript
 import { Pulse } from "pulse-ts-sdk";
 
-const request: Pulse.GetJobRequest = {
+const request: Pulse.BatchExtractInput = {
     ...
 };
 ```

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": "1.0.4",
-        "User-Agent": "pulse-ts-sdk/1.0.4",
+        "X-Fern-SDK-Version": "1.0.6",
+        "User-Agent": "pulse-ts-sdk/1.0.6",
         "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

@@ -1,4 +1,5 @@
 import * as Pulse from "./api/index.js";
+import { BatchClient } from "./api/resources/batch/client/Client.js";
 import { JobsClient } from "./api/resources/jobs/client/Client.js";
 import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
@@ -11,9 +12,11 @@ export declare namespace PulseClient {
 }
 export declare class PulseClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PulseClient.Options>;
+    protected _batch: BatchClient | undefined;
     protected _jobs: JobsClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
     constructor(options?: PulseClient.Options);
+    get batch(): BatchClient;
     get jobs(): JobsClient;
     get webhooks(): WebhooksClient;
     /**
@@ -24,6 +27,9 @@ export declare class PulseClient {
      * Set `async: true` to return immediately with a job_id for polling via
      * GET /job/{jobId}. Otherwise processes synchronously.
      *
+     * To process many files at once, see [Batch Extract](api:POST/batch/extract)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.ExtractRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -68,6 +74,9 @@ export declare class PulseClient {
      *
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To split many extractions at once, see [Batch Split](api:POST/batch/split)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SplitInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -98,6 +107,10 @@ export declare class PulseClient {
      * Creates a versioned schema record that can be retrieved later.
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To apply schemas across many extractions or splits at once, see
+     * [Batch Schema](api:POST/batch/schema) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SchemaInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -122,6 +135,10 @@ export declare class PulseClient {
      * Set `async: true` to return immediately with a `tables_id` for
      * polling via `GET /job/{tables_id}`.
      *
+     * To extract tables from many extractions at once, see
+     * [Batch Tables](api:POST/batch/tables) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.TablesInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/Client.js

@@ -45,8 +45,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PulseClient = void 0;
 const Pulse = __importStar(require("./api/index.js"));
-const Client_js_1 = require("./api/resources/jobs/client/Client.js");
-const Client_js_2 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_1 = require("./api/resources/batch/client/Client.js");
+const Client_js_2 = require("./api/resources/jobs/client/Client.js");
+const Client_js_3 = 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"));
@@ -58,13 +59,17 @@ class PulseClient {
     constructor(options = {}) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
+    get batch() {
+        var _a;
+        return ((_a = this._batch) !== null && _a !== void 0 ? _a : (this._batch = new Client_js_1.BatchClient(this._options)));
+    }
     get jobs() {
         var _a;
-        return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_1.JobsClient(this._options)));
+        return ((_a = this._jobs) !== null && _a !== void 0 ? _a : (this._jobs = new Client_js_2.JobsClient(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_2.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_3.WebhooksClient(this._options)));
     }
     /**
      * The primary endpoint for the Pulse API. Parses uploaded documents or remote
@@ -74,6 +79,9 @@ class PulseClient {
      * Set `async: true` to return immediately with a job_id for polling via
      * GET /job/{jobId}. Otherwise processes synchronously.
      *
+     * To process many files at once, see [Batch Extract](api:POST/batch/extract)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.ExtractRequest} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -98,6 +106,9 @@ class PulseClient {
             if (request.fileUrl != null) {
                 _request.append("fileUrl", request.fileUrl);
             }
+            if (request.model != null) {
+                _request.append("model", request.model);
+            }
             if (request.pages != null) {
                 _request.append("pages", request.pages);
             }
@@ -216,6 +227,9 @@ class PulseClient {
             if (request.fileUrl != null) {
                 _request.append("fileUrl", request.fileUrl);
             }
+            if (request.model != null) {
+                _request.append("model", request.model);
+            }
             if (request.pages != null) {
                 _request.append("pages", request.pages);
             }
@@ -314,6 +328,9 @@ class PulseClient {
      *
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To split many extractions at once, see [Batch Split](api:POST/batch/split)
+     * or the [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SplitInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -390,6 +407,10 @@ class PulseClient {
      * Creates a versioned schema record that can be retrieved later.
      * Set `async: true` to return immediately with a job_id for polling.
      *
+     * To apply schemas across many extractions or splits at once, see
+     * [Batch Schema](api:POST/batch/schema) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.SchemaInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -460,6 +481,10 @@ class PulseClient {
      * Set `async: true` to return immediately with a `tables_id` for
      * polling via `GET /job/{tables_id}`.
      *
+     * To extract tables from many extractions at once, see
+     * [Batch Tables](api:POST/batch/tables) or the
+     * [Batch Processing guide](/batch).
+     *
      * @param {Pulse.TablesInput} request
      * @param {PulseClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -8,6 +8,8 @@ export interface ExtractAsyncRequest {
     file?: core.file.Uploadable | undefined;
     /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
     fileUrl?: string;
+    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    model?: ExtractAsyncRequest.Model;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
@@ -42,6 +44,11 @@ export interface ExtractAsyncRequest {
     thinking?: boolean;
 }
 export declare namespace ExtractAsyncRequest {
+    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    const Model: {
+        readonly EnterprisePreview: "enterprise-preview";
+    };
+    type Model = (typeof Model)[keyof typeof Model];
     /**
      * Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response.
      */

package/dist/cjs/api/client/requests/ExtractAsyncRequest.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractAsyncRequest = void 0;
 var ExtractAsyncRequest;
 (function (ExtractAsyncRequest) {
+    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    ExtractAsyncRequest.Model = {
+        EnterprisePreview: "enterprise-preview",
+    };
     let Extensions;
     (function (Extensions) {
         let Chunking;

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

@@ -8,6 +8,8 @@ export interface ExtractRequest {
     file?: core.file.Uploadable | undefined;
     /** Public or pre-signed URL that Pulse will download and extract. Required unless file is provided. */
     fileUrl?: string;
+    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    model?: ExtractRequest.Model;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
     /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
@@ -42,6 +44,11 @@ export interface ExtractRequest {
     thinking?: boolean;
 }
 export declare namespace ExtractRequest {
+    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    const Model: {
+        readonly EnterprisePreview: "enterprise-preview";
+    };
+    type Model = (typeof Model)[keyof typeof Model];
     /**
      * Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response.
      */

package/dist/cjs/api/client/requests/ExtractRequest.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtractRequest = void 0;
 var ExtractRequest;
 (function (ExtractRequest) {
+    /** Extraction model to use. When set to `enterprise-preview`, routes the request through Pulse's self-hosted VPC extraction model instead of the default cloud-based service. If omitted or set to any other value, the default model is used. */
+    ExtractRequest.Model = {
+        EnterprisePreview: "enterprise-preview",
+    };
     let Extensions;
     (function (Extensions) {
         let Chunking;

package/dist/cjs/api/resources/batch/client/Client.d.ts

@@ -0,0 +1,141 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pulse from "../../../index.js";
+export declare namespace BatchClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class BatchClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<BatchClient.Options>;
+    constructor(options?: BatchClient.Options);
+    /**
+     * Process multiple files in parallel. Enumerates files from an input
+     * source (S3 prefix, local directory, or URL list), calls
+     * [Extract](api:POST/extract) for each file, and saves results to an
+     * output destination.
+     *
+     * Always asynchronous — returns a batch job ID immediately.
+     * Poll [GET /job/{jobId}](api:GET/job/{jobId}) for real-time progress
+     * including per-file completion status.
+     *
+     * See the [Extract](api:POST/extract) endpoint for details on
+     * `extract_options` and the [Batch Processing guide](/batch) for
+     * an overview of the batch pipeline.
+     *
+     * @param {Pulse.BatchExtractInput} request
+     * @param {BatchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     *
+     * @example
+     *     await client.batch.extract({
+     *         input: {},
+     *         output: {}
+     *     })
+     */
+    extract(request: Pulse.BatchExtractInput, requestOptions?: BatchClient.RequestOptions): core.HttpResponsePromise<Pulse.BatchExtractResponse>;
+    private __extract;
+    /**
+     * Apply schema extraction to multiple items in parallel.
+     * Mode is inferred from the input:
+     *
+     * **Single mode** — Provide `extraction_ids` or `batch_extract_id`
+     * with `schema_config` to apply one schema to each extraction.
+     *
+     * **Split mode** — Provide `split_ids` or `batch_split_id`
+     * with `split_schema_config` to apply per-topic schemas to each split.
+     *
+     * Each child call goes through the full [Schema](api:POST/schema) code
+     * path. Poll [GET /job/{jobId}](api:GET/job/{jobId}) for real-time
+     * progress.
+     *
+     * See the [Schema](api:POST/schema) endpoint for details on
+     * `schema_config` and `split_schema_config`, and the
+     * [Batch Processing guide](/batch) for an overview of the batch
+     * pipeline.
+     *
+     * @param {Pulse.BatchSchemaInput} request
+     * @param {BatchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     *
+     * @example
+     *     await client.batch.schema({
+     *         output: {}
+     *     })
+     */
+    schema(request: Pulse.BatchSchemaInput, requestOptions?: BatchClient.RequestOptions): core.HttpResponsePromise<Pulse.BatchSchemaResponse>;
+    private __schema;
+    /**
+     * Extract tables from multiple existing extractions in parallel.
+     * Each child call goes through the full [Tables](api:POST/tables) code
+     * path.
+     *
+     * Extractions are identified by either a `batch_extract_id` (from a
+     * prior [Batch Extract](api:POST/batch/extract) run) or an explicit
+     * list of `extraction_ids`.
+     *
+     * Poll [GET /job/{jobId}](api:GET/job/{jobId}) for real-time progress.
+     *
+     * See the [Tables](api:POST/tables) endpoint for details on
+     * `tables_config` and the [Batch Processing guide](/batch) for an
+     * overview of the batch pipeline.
+     *
+     * @param {Pulse.BatchTablesInput} request
+     * @param {BatchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     *
+     * @example
+     *     await client.batch.tables({
+     *         output: {}
+     *     })
+     */
+    tables(request: Pulse.BatchTablesInput, requestOptions?: BatchClient.RequestOptions): core.HttpResponsePromise<Pulse.BatchTablesResponse>;
+    private __tables;
+    /**
+     * Split multiple existing extractions by topics in parallel.
+     * Each child call goes through the full [Split](api:POST/split) code
+     * path.
+     *
+     * Extractions are identified by either a `batch_extract_id` (from a
+     * prior [Batch Extract](api:POST/batch/extract) run) or an explicit
+     * list of `extraction_ids`.
+     *
+     * Poll [GET /job/{jobId}](api:GET/job/{jobId}) for real-time progress.
+     *
+     * See the [Split](api:POST/split) endpoint for details on
+     * `split_config` and the [Batch Processing guide](/batch) for an
+     * overview of the batch pipeline.
+     *
+     * @param {Pulse.BatchSplitInput} request
+     * @param {BatchClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.TooManyRequestsError}
+     *
+     * @example
+     *     await client.batch.split({
+     *         output: {},
+     *         split_config: {
+     *             split_input: [{
+     *                     name: "name"
+     *                 }]
+     *         }
+     *     })
+     */
+    split(request: Pulse.BatchSplitInput, requestOptions?: BatchClient.RequestOptions): core.HttpResponsePromise<Pulse.BatchSplitResponse>;
+    private __split;
+}