pulse-ts-sdk 1.0.7 → 1.0.9

package/dist/esm/api/types/PipelineSteps.d.mts

@@ -0,0 +1,14 @@
+import type * as Pulse from "../index.mjs";
+/**
+ * Ordered step definitions. Key order determines execution order. Use `extract` for single-file or `batch_extract` for multi-file pipelines — they are mutually exclusive. Each step accepts the same configuration as its standalone endpoint.
+ */
+export interface PipelineSteps {
+    /** Single-document extraction step. Same options as `POST /extract`. */
+    extract?: Pulse.ExtractOptions;
+    /** Multi-document parallel extraction step. Provide `file_urls` at the top level and optional `workers` here. */
+    batch_extract?: Pulse.PipelineStepBatchExtractConfig;
+    /** Structured data extraction step. Same config as `schema_config` in `POST /schema`. Requires `extract` or `batch_extract` before it. */
+    schema?: Pulse.SchemaConfig;
+    /** Topic splitting step. Same config as `split_config` in `POST /split`. Requires `extract` or `batch_extract` before it. */
+    split?: Pulse.SplitConfig;
+}

package/dist/esm/api/types/PipelineSteps.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/SingleSchemaResponse.d.mts

@@ -13,4 +13,6 @@ export interface SingleSchemaResponse {
     extraction_ids?: string[];
     /** API path to download the filled Excel template (e.g. `/schema/{schema_id}/excel`). Requires the same API key authentication. Only present when `excel_template` was provided in the request. */
     excel_output_url?: string;
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
 }

package/dist/esm/api/types/SplitResponse.d.mts

@@ -2,9 +2,4 @@ import type * as Pulse from "../index.mjs";
 /**
  * Result of document splitting with page assignments.
  */
-export interface SplitResponse {
-    /** Unique identifier for this split result. Use this ID with the `/schema` endpoint (split mode) to apply schemas to specific page groups. */
-    split_id: string;
-    /** Page assignments per topic. */
-    split_output: Pulse.SplitOutput;
-}
+export type SplitResponse = Pulse.SplitResultCore;

package/dist/esm/api/types/SplitResultCore.d.mts

@@ -0,0 +1,12 @@
+import type * as Pulse from "../index.mjs";
+/**
+ * Core split result fields shared by the synchronous `/split` endpoint and the pipeline split step.
+ */
+export interface SplitResultCore {
+    /** Unique identifier for this split result. Use this ID with the `/schema` endpoint (split mode) to apply schemas to specific page groups. */
+    split_id?: string;
+    /** Page assignments per topic. */
+    split_output?: Pulse.SplitOutput;
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
+}

package/dist/esm/api/types/SplitResultCore.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/SplitSchemaResponse.d.mts

@@ -13,4 +13,6 @@ export interface SplitSchemaResponse {
     input_schemas?: Record<string, Record<string, unknown>>;
     /** Per-topic errors if any topics failed to process. Keys are topic names, values are error messages. */
     errors?: Record<string, string>;
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
 }

package/dist/esm/api/types/TablesConfig.d.mts

@@ -6,6 +6,8 @@ export interface TablesConfig {
     merge?: boolean;
     /** Output format for table content. Currently only `html` is supported. */
     table_format?: TablesConfig.TableFormat;
+    /** Convert figures and charts into tables using LLM processing. Resulting tables have `from_chart: true` in the response. */
+    charts_to_tables?: boolean;
 }
 export declare namespace TablesConfig {
     /** Output format for table content. Currently only `html` is supported. */

package/dist/esm/api/types/TablesResponse.d.mts

@@ -6,6 +6,8 @@ export interface TablesResponse {
     tables_id: string;
     /** The extracted tables data. */
     tables_output: TablesResponse.TablesOutput;
+    /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
+    credits_used?: number | null;
 }
 export declare namespace TablesResponse {
     /**

package/dist/esm/api/types/index.d.mts

@@ -1,6 +1,7 @@
 export * from "./AsyncSubmissionResponse.mjs";
 export * from "./BatchExtractionIds.mjs";
 export * from "./BatchExtractResponse.mjs";
+export * from "./BatchFileUpload.mjs";
 export * from "./BatchInputSource.mjs";
 export * from "./BatchOutputDestination.mjs";
 export * from "./BatchSchemaResponse.mjs";
@@ -8,18 +9,31 @@ export * from "./BatchSplitResponse.mjs";
 export * from "./BatchTablesResponse.mjs";
 export * from "./ExtractAsyncSubmissionResponse.mjs";
 export * from "./ExtractInput.mjs";
+export * from "./ExtractLargeResultResponse.mjs";
 export * from "./ExtractOptions.mjs";
 export * from "./ExtractResponse.mjs";
+export * from "./ExtractResultCore.mjs";
 export * from "./ExtractSource.mjs";
+export * from "./GoneErrorBody.mjs";
 export * from "./JobCancellationResponse.mjs";
 export * from "./JobStatus.mjs";
 export * from "./JobStatusResponse.mjs";
+export * from "./PipelineBatchExtractResult.mjs";
+export * from "./PipelineExecuteMultipartInput.mjs";
+export * from "./PipelineExecuteResponse.mjs";
+export * from "./PipelineExtractResult.mjs";
+export * from "./PipelineResults.mjs";
+export * from "./PipelineSchemaResult.mjs";
+export * from "./PipelineSplitResult.mjs";
+export * from "./PipelineStepBatchExtractConfig.mjs";
+export * from "./PipelineSteps.mjs";
 export * from "./SchemaConfig.mjs";
 export * from "./SchemaResponse.mjs";
 export * from "./SingleSchemaResponse.mjs";
 export * from "./SplitConfig.mjs";
 export * from "./SplitOutput.mjs";
 export * from "./SplitResponse.mjs";
+export * from "./SplitResultCore.mjs";
 export * from "./SplitSchemaResponse.mjs";
 export * from "./StructuredOutputConfig.mjs";
 export * from "./StructuredOutputResult.mjs";

package/dist/esm/api/types/index.mjs

@@ -1,6 +1,7 @@
 export * from "./AsyncSubmissionResponse.mjs";
 export * from "./BatchExtractionIds.mjs";
 export * from "./BatchExtractResponse.mjs";
+export * from "./BatchFileUpload.mjs";
 export * from "./BatchInputSource.mjs";
 export * from "./BatchOutputDestination.mjs";
 export * from "./BatchSchemaResponse.mjs";
@@ -8,18 +9,31 @@ export * from "./BatchSplitResponse.mjs";
 export * from "./BatchTablesResponse.mjs";
 export * from "./ExtractAsyncSubmissionResponse.mjs";
 export * from "./ExtractInput.mjs";
+export * from "./ExtractLargeResultResponse.mjs";
 export * from "./ExtractOptions.mjs";
 export * from "./ExtractResponse.mjs";
+export * from "./ExtractResultCore.mjs";
 export * from "./ExtractSource.mjs";
+export * from "./GoneErrorBody.mjs";
 export * from "./JobCancellationResponse.mjs";
 export * from "./JobStatus.mjs";
 export * from "./JobStatusResponse.mjs";
+export * from "./PipelineBatchExtractResult.mjs";
+export * from "./PipelineExecuteMultipartInput.mjs";
+export * from "./PipelineExecuteResponse.mjs";
+export * from "./PipelineExtractResult.mjs";
+export * from "./PipelineResults.mjs";
+export * from "./PipelineSchemaResult.mjs";
+export * from "./PipelineSplitResult.mjs";
+export * from "./PipelineStepBatchExtractConfig.mjs";
+export * from "./PipelineSteps.mjs";
 export * from "./SchemaConfig.mjs";
 export * from "./SchemaResponse.mjs";
 export * from "./SingleSchemaResponse.mjs";
 export * from "./SplitConfig.mjs";
 export * from "./SplitOutput.mjs";
 export * from "./SplitResponse.mjs";
+export * from "./SplitResultCore.mjs";
 export * from "./SplitSchemaResponse.mjs";
 export * from "./StructuredOutputConfig.mjs";
 export * from "./StructuredOutputResult.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.7";
+export declare const SDK_VERSION = "1.0.9";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.7";
+export const SDK_VERSION = "1.0.9";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pulse-ts-sdk",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -759,6 +759,96 @@ await client.batch.split({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Pipeline
+<details><summary><code>client.pipeline.<a href="/src/api/resources/pipeline/client/Client.ts">execute</a>({ ...params }) -> Pulse.PipelineExecuteResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Chain multiple processing steps (extract, schema, split) into a single
+request with inline configurations. No saved pipeline required.
+
+The `steps` object defines what to run and in what order. Outputs flow
+forward automatically — you never need to pass extraction IDs between
+steps.
+
+**Supported step combinations:**
+- `extract` — extract a single document
+- `extract` → `schema` — extract then apply structured schema
+- `extract` → `split` — extract then split into topics
+- `batch_extract` → `schema` — extract multiple files, combine into one schema output
+
+**Document input:**
+- Single file: provide `fileUrl` in JSON or `file` via multipart
+- Multiple files (batch_extract): provide `fileUrls` in JSON or multiple `file` fields via multipart
+
+Set `async: true` to return immediately with a `job_id` for polling via
+`GET /job/{jobId}`.
+
+Set `autoDelete: true` for zero-retention mode — all stored artifacts
+are deleted immediately after you receive the results. Requires
+`save_extractions` to be disabled for your organization.
+
+Requires the `enable_adhoc_pipeline` feature flag.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.pipeline.execute({
+    steps: {}
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pulse.PipelineExecuteInput` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PipelineClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -892,6 +982,77 @@ await client.jobs.cancelJob({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## LargeResults
+<details><summary><code>client.largeResults.<a href="/src/api/resources/largeResults/client/Client.ts">getLargeResult</a>({ ...params }) -> Pulse.ExtractResultCore</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Download the full result for a large extraction (70+ pages).
+
+When `/extract` or `GET /job/{jobId}` returns `is_url: true`, fetch
+the complete result from the URL provided.  The URL is single-use:
+after a successful download the resource is deleted and subsequent
+requests return 410 Gone.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.largeResults.getLargeResult({
+    jobId: "jobId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pulse.GetLargeResultLargeResultsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `LargeResultsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>