extend-ai 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BaseClient.js +2 -2
- package/Client.d.ts +70 -8
- package/Client.js +78 -12
- package/api/client/requests/ClassifyRequest.d.ts +16 -1
- package/api/client/requests/EditRequest.d.ts +7 -1
- package/api/client/requests/ExtractRequest.d.ts +20 -1
- package/api/client/requests/ParseRequest.d.ts +2 -1
- package/api/client/requests/SplitRequest.d.ts +16 -1
- package/api/resources/batchProcessorRun/client/Client.d.ts +1 -1
- package/api/resources/batchProcessorRun/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/Client.d.ts +2 -1
- package/api/resources/classifierVersions/client/Client.js +2 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +2 -1
- package/api/resources/classifiers/client/Client.d.ts +19 -2
- package/api/resources/classifiers/client/Client.js +19 -2
- package/api/resources/classifiers/client/requests/ClassifiersCreateRequest.d.ts +16 -1
- package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +3 -1
- package/api/resources/classifyRuns/client/Client.d.ts +4 -1
- package/api/resources/classifyRuns/client/Client.js +4 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCreateRequest.d.ts +4 -1
- package/api/resources/editRuns/client/Client.d.ts +7 -1
- package/api/resources/editRuns/client/Client.js +7 -1
- package/api/resources/editRuns/client/requests/EditRunsCreateRequest.d.ts +7 -1
- package/api/resources/evaluationSetItems/client/Client.d.ts +16 -4
- package/api/resources/evaluationSetItems/client/Client.js +16 -4
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +8 -2
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +7 -1
- package/api/resources/evaluationSets/client/Client.d.ts +4 -3
- package/api/resources/evaluationSets/client/Client.js +4 -3
- package/api/resources/evaluationSets/client/requests/EvaluationSetsCreateRequest.d.ts +3 -2
- package/api/resources/extractRuns/client/Client.d.ts +4 -1
- package/api/resources/extractRuns/client/Client.js +4 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +4 -1
- package/api/resources/extractorVersions/client/Client.d.ts +2 -1
- package/api/resources/extractorVersions/client/Client.js +2 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +2 -1
- package/api/resources/extractors/client/Client.d.ts +23 -2
- package/api/resources/extractors/client/Client.js +23 -2
- package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +20 -1
- package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +3 -1
- package/api/resources/files/client/Client.d.ts +1 -1
- package/api/resources/files/client/Client.js +1 -1
- package/api/resources/index.d.ts +6 -0
- package/api/resources/index.js +7 -1
- package/api/resources/parseRuns/client/Client.d.ts +2 -1
- package/api/resources/parseRuns/client/Client.js +2 -1
- package/api/resources/parseRuns/client/requests/ParseRunsCreateRequest.d.ts +2 -1
- package/api/resources/processorRun/client/Client.d.ts +3 -3
- package/api/resources/processorRun/client/Client.js +3 -3
- package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/Client.d.ts +4 -1
- package/api/resources/splitRuns/client/Client.js +4 -1
- package/api/resources/splitRuns/client/requests/SplitRunsCreateRequest.d.ts +4 -1
- package/api/resources/splitterVersions/client/Client.d.ts +2 -1
- package/api/resources/splitterVersions/client/Client.js +2 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +2 -1
- package/api/resources/splitters/client/Client.d.ts +19 -2
- package/api/resources/splitters/client/Client.js +19 -2
- package/api/resources/splitters/client/requests/SplittersCreateRequest.d.ts +16 -1
- package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +3 -1
- package/api/resources/webhookEndpoints/client/Client.d.ts +133 -0
- package/api/resources/webhookEndpoints/client/Client.js +440 -0
- package/api/resources/webhookEndpoints/client/index.d.ts +1 -0
- package/api/resources/webhookEndpoints/client/index.js +17 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.d.ts +21 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +14 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +15 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/index.d.ts +3 -0
- package/api/resources/webhookEndpoints/client/requests/index.js +2 -0
- package/api/resources/webhookEndpoints/index.d.ts +2 -0
- package/api/resources/webhookEndpoints/index.js +18 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.d.ts +4 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.js +3 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.d.ts +6 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.js +3 -0
- package/api/resources/webhookEndpoints/types/index.d.ts +2 -0
- package/api/resources/webhookEndpoints/types/index.js +18 -0
- package/api/resources/webhookSubscriptions/client/Client.d.ts +133 -0
- package/api/resources/webhookSubscriptions/client/Client.js +444 -0
- package/api/resources/webhookSubscriptions/client/index.d.ts +1 -0
- package/api/resources/webhookSubscriptions/client/index.js +17 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.d.ts +19 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +16 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +11 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/index.d.ts +3 -0
- package/api/resources/webhookSubscriptions/client/requests/index.js +2 -0
- package/api/resources/webhookSubscriptions/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/index.js +18 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.d.ts +4 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.js +3 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.d.ts +6 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.js +3 -0
- package/api/resources/webhookSubscriptions/types/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/types/index.js +18 -0
- package/api/resources/workflowRuns/client/Client.d.ts +22 -6
- package/api/resources/workflowRuns/client/Client.js +22 -6
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +12 -2
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +3 -3
- package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +7 -1
- package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
- package/api/types/ExtractAdvancedOptions.d.ts +1 -1
- package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/ExtractConfigJson.d.ts +1 -1
- package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
- package/api/types/ExtractOverrideConfigJson.d.ts +1 -1
- package/api/types/ExtractRun.d.ts +10 -2
- package/api/types/ExtractorVersion.d.ts +6 -1
- package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
- package/api/types/LegacyClassificationConfig.d.ts +2 -2
- package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
- package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/LegacyExtractionConfig.d.ts +3 -3
- package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
- package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
- package/api/types/LegacySplitterAdvancedOptions.d.ts +1 -1
- package/api/types/LegacySplitterConfig.d.ts +2 -2
- package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
- package/api/types/ParseConfig.d.ts +1 -1
- package/api/types/ParseConfigTarget.d.ts +1 -1
- package/api/types/ParseConfigTarget.js +1 -1
- package/api/types/WebhookAdvancedOptions.d.ts +9 -0
- package/api/types/WebhookAdvancedOptions.js +3 -0
- package/api/types/WebhookEndpoint.d.ts +18 -0
- package/api/types/WebhookEndpoint.js +3 -0
- package/api/types/WebhookEndpointCreate.d.ts +27 -0
- package/api/types/WebhookEndpointCreate.js +3 -0
- package/api/types/WebhookEndpointEventType.d.ts +32 -0
- package/api/types/WebhookEndpointEventType.js +35 -0
- package/api/types/WebhookEndpointStatus.d.ts +6 -0
- package/api/types/WebhookEndpointStatus.js +9 -0
- package/api/types/WebhookPayloadFormat.d.ts +11 -0
- package/api/types/WebhookPayloadFormat.js +14 -0
- package/api/types/WebhookPayloadOptions.d.ts +9 -0
- package/api/types/WebhookPayloadOptions.js +3 -0
- package/api/types/WebhookSubscription.d.ts +15 -0
- package/api/types/WebhookSubscription.js +3 -0
- package/api/types/WebhookSubscriptionEventType.d.ts +23 -0
- package/api/types/WebhookSubscriptionEventType.js +26 -0
- package/api/types/WebhookSubscriptionResourceType.d.ts +8 -0
- package/api/types/WebhookSubscriptionResourceType.js +11 -0
- package/api/types/index.d.ts +10 -0
- package/api/types/index.js +10 -0
- package/package.json +1 -1
- package/reference.md +897 -40
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Extend from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* enabledEvents: ["extract_run.processed"]
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface WebhookSubscriptionsUpdateRequest {
|
|
9
|
+
/** The event types to subscribe to. Must be valid for the subscription's resource type. */
|
|
10
|
+
enabledEvents: Extend.WebhookSubscriptionEventType[];
|
|
11
|
+
}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export type { WebhookSubscriptionsCreateRequest } from "./WebhookSubscriptionsCreateRequest";
|
|
2
|
+
export type { WebhookSubscriptionsListRequest } from "./WebhookSubscriptionsListRequest";
|
|
3
|
+
export type { WebhookSubscriptionsUpdateRequest } from "./WebhookSubscriptionsUpdateRequest";
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./client"), exports);
|
|
18
|
+
__exportStar(require("./types"), exports);
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./WebhookSubscriptionsDeleteResponse"), exports);
|
|
18
|
+
__exportStar(require("./WebhookSubscriptionsListResponse"), exports);
|
|
@@ -52,10 +52,10 @@ export declare class WorkflowRunsClient {
|
|
|
52
52
|
* @example
|
|
53
53
|
* await client.workflowRuns.create({
|
|
54
54
|
* workflow: {
|
|
55
|
-
* id: "
|
|
55
|
+
* id: "wf_1234567890"
|
|
56
56
|
* },
|
|
57
57
|
* file: {
|
|
58
|
-
* url: "
|
|
58
|
+
* url: "https://example.com/invoice.pdf"
|
|
59
59
|
* }
|
|
60
60
|
* })
|
|
61
61
|
*/
|
|
@@ -102,7 +102,13 @@ export declare class WorkflowRunsClient {
|
|
|
102
102
|
* @throws {@link Extend.InternalServerError}
|
|
103
103
|
*
|
|
104
104
|
* @example
|
|
105
|
-
* await client.workflowRuns.update("workflow_run_id_here"
|
|
105
|
+
* await client.workflowRuns.update("workflow_run_id_here", {
|
|
106
|
+
* name: "Invoice #12345",
|
|
107
|
+
* metadata: {
|
|
108
|
+
* "customerId": "cust_abc123",
|
|
109
|
+
* "source": "email-inbox"
|
|
110
|
+
* }
|
|
111
|
+
* })
|
|
106
112
|
*/
|
|
107
113
|
update(id: string, request?: Extend.WorkflowRunsUpdateRequest, requestOptions?: WorkflowRunsClient.RequestOptions): core.HttpResponsePromise<Extend.WorkflowRun>;
|
|
108
114
|
private __update;
|
|
@@ -157,7 +163,7 @@ export declare class WorkflowRunsClient {
|
|
|
157
163
|
/**
|
|
158
164
|
* This endpoint allows you to efficiently initiate large batches of workflow runs in a single request (up to 1,000 in a single request, but you can queue up multiple batches in rapid succession). It accepts an array of inputs, each containing a file and metadata pair. The primary use case for this endpoint is for doing large bulk runs of >1000 files at a time that can process over the course of a few hours without needing to manage rate limits that would likely occur using the primary run endpoint.
|
|
159
165
|
*
|
|
160
|
-
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/
|
|
166
|
+
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/create-workflow-run) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
|
|
161
167
|
*
|
|
162
168
|
* Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration) for consuming results, using the `metadata` and `batchId` to match up results to the original inputs in your downstream systems. However, you can integrate in a polling mechanism by using a combination of the [List Workflow Runs](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/get-workflow-run) to fetch the full outputs each run.
|
|
163
169
|
*
|
|
@@ -184,11 +190,21 @@ export declare class WorkflowRunsClient {
|
|
|
184
190
|
* @example
|
|
185
191
|
* await client.workflowRuns.createBatch({
|
|
186
192
|
* workflow: {
|
|
187
|
-
* id: "
|
|
193
|
+
* id: "wf_1234567890"
|
|
188
194
|
* },
|
|
189
195
|
* inputs: [{
|
|
190
196
|
* file: {
|
|
191
|
-
* url: "
|
|
197
|
+
* url: "https://example.com/invoice1.pdf"
|
|
198
|
+
* },
|
|
199
|
+
* metadata: {
|
|
200
|
+
* "customerId": "cust_abc123"
|
|
201
|
+
* }
|
|
202
|
+
* }, {
|
|
203
|
+
* file: {
|
|
204
|
+
* url: "https://example.com/invoice2.pdf"
|
|
205
|
+
* },
|
|
206
|
+
* metadata: {
|
|
207
|
+
* "customerId": "cust_def456"
|
|
192
208
|
* }
|
|
193
209
|
* }]
|
|
194
210
|
* })
|
|
@@ -157,10 +157,10 @@ class WorkflowRunsClient {
|
|
|
157
157
|
* @example
|
|
158
158
|
* await client.workflowRuns.create({
|
|
159
159
|
* workflow: {
|
|
160
|
-
* id: "
|
|
160
|
+
* id: "wf_1234567890"
|
|
161
161
|
* },
|
|
162
162
|
* file: {
|
|
163
|
-
* url: "
|
|
163
|
+
* url: "https://example.com/invoice.pdf"
|
|
164
164
|
* }
|
|
165
165
|
* })
|
|
166
166
|
*/
|
|
@@ -308,7 +308,13 @@ class WorkflowRunsClient {
|
|
|
308
308
|
* @throws {@link Extend.InternalServerError}
|
|
309
309
|
*
|
|
310
310
|
* @example
|
|
311
|
-
* await client.workflowRuns.update("workflow_run_id_here"
|
|
311
|
+
* await client.workflowRuns.update("workflow_run_id_here", {
|
|
312
|
+
* name: "Invoice #12345",
|
|
313
|
+
* metadata: {
|
|
314
|
+
* "customerId": "cust_abc123",
|
|
315
|
+
* "source": "email-inbox"
|
|
316
|
+
* }
|
|
317
|
+
* })
|
|
312
318
|
*/
|
|
313
319
|
update(id, request = {}, requestOptions) {
|
|
314
320
|
return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
|
|
@@ -513,7 +519,7 @@ class WorkflowRunsClient {
|
|
|
513
519
|
/**
|
|
514
520
|
* This endpoint allows you to efficiently initiate large batches of workflow runs in a single request (up to 1,000 in a single request, but you can queue up multiple batches in rapid succession). It accepts an array of inputs, each containing a file and metadata pair. The primary use case for this endpoint is for doing large bulk runs of >1000 files at a time that can process over the course of a few hours without needing to manage rate limits that would likely occur using the primary run endpoint.
|
|
515
521
|
*
|
|
516
|
-
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/
|
|
522
|
+
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/create-workflow-run) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
|
|
517
523
|
*
|
|
518
524
|
* Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration) for consuming results, using the `metadata` and `batchId` to match up results to the original inputs in your downstream systems. However, you can integrate in a polling mechanism by using a combination of the [List Workflow Runs](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/get-workflow-run) to fetch the full outputs each run.
|
|
519
525
|
*
|
|
@@ -540,11 +546,21 @@ class WorkflowRunsClient {
|
|
|
540
546
|
* @example
|
|
541
547
|
* await client.workflowRuns.createBatch({
|
|
542
548
|
* workflow: {
|
|
543
|
-
* id: "
|
|
549
|
+
* id: "wf_1234567890"
|
|
544
550
|
* },
|
|
545
551
|
* inputs: [{
|
|
546
552
|
* file: {
|
|
547
|
-
* url: "
|
|
553
|
+
* url: "https://example.com/invoice1.pdf"
|
|
554
|
+
* },
|
|
555
|
+
* metadata: {
|
|
556
|
+
* "customerId": "cust_abc123"
|
|
557
|
+
* }
|
|
558
|
+
* }, {
|
|
559
|
+
* file: {
|
|
560
|
+
* url: "https://example.com/invoice2.pdf"
|
|
561
|
+
* },
|
|
562
|
+
* metadata: {
|
|
563
|
+
* "customerId": "cust_def456"
|
|
548
564
|
* }
|
|
549
565
|
* }]
|
|
550
566
|
* })
|
|
@@ -3,11 +3,21 @@ import type * as Extend from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* workflow: {
|
|
6
|
-
* id: "
|
|
6
|
+
* id: "wf_1234567890"
|
|
7
7
|
* },
|
|
8
8
|
* inputs: [{
|
|
9
9
|
* file: {
|
|
10
|
-
* url: "
|
|
10
|
+
* url: "https://example.com/invoice1.pdf"
|
|
11
|
+
* },
|
|
12
|
+
* metadata: {
|
|
13
|
+
* "customerId": "cust_abc123"
|
|
14
|
+
* }
|
|
15
|
+
* }, {
|
|
16
|
+
* file: {
|
|
17
|
+
* url: "https://example.com/invoice2.pdf"
|
|
18
|
+
* },
|
|
19
|
+
* metadata: {
|
|
20
|
+
* "customerId": "cust_def456"
|
|
11
21
|
* }
|
|
12
22
|
* }]
|
|
13
23
|
* }
|
|
@@ -3,16 +3,16 @@ import type * as Extend from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* workflow: {
|
|
6
|
-
* id: "
|
|
6
|
+
* id: "wf_1234567890"
|
|
7
7
|
* },
|
|
8
8
|
* file: {
|
|
9
|
-
* url: "
|
|
9
|
+
* url: "https://example.com/invoice.pdf"
|
|
10
10
|
* }
|
|
11
11
|
* }
|
|
12
12
|
*/
|
|
13
13
|
export interface WorkflowRunsCreateRequest {
|
|
14
14
|
workflow: Extend.WorkflowReference;
|
|
15
|
-
/** The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types). Files can be provided as a URL, an Extend file ID, or raw text. If you wish to process more at a time, consider using the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/batch-
|
|
15
|
+
/** The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types). Files can be provided as a URL, an Extend file ID, or raw text. If you wish to process more at a time, consider using the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/batch-create-workflow-runs) endpoint. */
|
|
16
16
|
file: Extend.WorkflowRunsCreateRequestFile;
|
|
17
17
|
/** Predetermined outputs to be used for the workflow run. Generally not recommended for most use cases, however, can be useful in cases of overriding a classification in a workflow, or a subset of extraction fields when data is known. */
|
|
18
18
|
outputs?: Extend.WorkflowRunsCreateRequestOutputsItem[];
|
|
@@ -14,7 +14,7 @@ export interface WorkflowRunsListRequest {
|
|
|
14
14
|
*/
|
|
15
15
|
workflowId?: string;
|
|
16
16
|
/**
|
|
17
|
-
* Filters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/batch-
|
|
17
|
+
* Filters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/batch-create-workflow-runs) endpoint.
|
|
18
18
|
*
|
|
19
19
|
* Example: `"batch_7Ws31-F5"`
|
|
20
20
|
*/
|
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @example
|
|
3
|
-
* {
|
|
3
|
+
* {
|
|
4
|
+
* name: "Invoice #12345",
|
|
5
|
+
* metadata: {
|
|
6
|
+
* "customerId": "cust_abc123",
|
|
7
|
+
* "source": "email-inbox"
|
|
8
|
+
* }
|
|
9
|
+
* }
|
|
4
10
|
*/
|
|
5
11
|
export interface WorkflowRunsUpdateRequest {
|
|
6
12
|
/** An optional name that can be assigned to a specific WorkflowRun */
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Extend from "../../../index";
|
|
2
2
|
/**
|
|
3
|
-
* The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types). Files can be provided as a URL, an Extend file ID, or raw text. If you wish to process more at a time, consider using the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/batch-
|
|
3
|
+
* The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types). Files can be provided as a URL, an Extend file ID, or raw text. If you wish to process more at a time, consider using the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/batch-create-workflow-runs) endpoint.
|
|
4
4
|
*/
|
|
5
5
|
export type WorkflowRunsCreateRequestFile = Extend.FileFromUrl | Extend.FileFromId | Extend.FileFromText;
|
|
@@ -22,7 +22,7 @@ export interface ExtractAdvancedOptions {
|
|
|
22
22
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
23
23
|
* fields that may need manual review.
|
|
24
24
|
*
|
|
25
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/product/extraction/review-agent)
|
|
25
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
|
|
26
26
|
*/
|
|
27
27
|
reviewAgent?: Extend.ExtractAdvancedOptionsReviewAgent;
|
|
28
28
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
5
5
|
* fields that may need manual review.
|
|
6
6
|
*
|
|
7
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/product/extraction/review-agent)
|
|
7
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
|
|
8
8
|
*/
|
|
9
9
|
export interface ExtractAdvancedOptionsReviewAgent {
|
|
10
10
|
/** Whether to enable the review agent. */
|
|
@@ -8,7 +8,7 @@ export interface ExtractConfigJson {
|
|
|
8
8
|
/**
|
|
9
9
|
* JSON Schema definition of the data to extract.
|
|
10
10
|
*
|
|
11
|
-
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema
|
|
11
|
+
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema) for details and examples of schema configuration.
|
|
12
12
|
*/
|
|
13
13
|
schema: Extend.JsonObject;
|
|
14
14
|
/** Advanced configuration options. */
|
|
@@ -14,7 +14,7 @@ export interface ExtractOutputMetadataValue {
|
|
|
14
14
|
*
|
|
15
15
|
* These scores will be present when the `reviewAgent.enabled` flag is set to `true` in the processor config.
|
|
16
16
|
* If the review agent is enabled but a score is not returned for a field, this value will be `null`.
|
|
17
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/product/extraction/review-agent)
|
|
17
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
|
|
18
18
|
*/
|
|
19
19
|
reviewAgentScore?: number | null;
|
|
20
20
|
citations?: Extend.Citation[];
|
|
@@ -12,7 +12,7 @@ export interface ExtractOverrideConfigJson {
|
|
|
12
12
|
/**
|
|
13
13
|
* JSON Schema definition of the data to extract.
|
|
14
14
|
*
|
|
15
|
-
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema
|
|
15
|
+
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema) for details and examples of schema configuration.
|
|
16
16
|
*/
|
|
17
17
|
schema?: Extend.JsonObject;
|
|
18
18
|
/** Advanced configuration options. */
|
|
@@ -25,7 +25,10 @@ export interface ExtractRun {
|
|
|
25
25
|
extractorVersion: Extend.ExtractorVersionSummary | null;
|
|
26
26
|
status: Extend.ProcessorRunStatus;
|
|
27
27
|
/**
|
|
28
|
-
* The final output, either reviewed or initial.
|
|
28
|
+
* The final output, either reviewed or initial. This is a union of two possible shapes:
|
|
29
|
+
*
|
|
30
|
+
* - **[JSON Schema output](https://docs.extend.ai/2026-02-09/product/extraction/output-types):** The current output format, returned for runs created with a JSON Schema config.
|
|
31
|
+
* - **[Legacy output](https://docs.extend.ai/2025-04-21/product/legacy/output-type-legacy):** A legacy output format from a previous API version. This shape is only returned for runs that were originally created with a legacy config.
|
|
29
32
|
*
|
|
30
33
|
* **Availability:** Present when `status` is `"PROCESSED"`.
|
|
31
34
|
*/
|
|
@@ -83,7 +86,12 @@ export interface ExtractRun {
|
|
|
83
86
|
* **Availability:** Present when `edited` is `true`.
|
|
84
87
|
*/
|
|
85
88
|
edits: Record<string, Extend.ExtractOutputEdits | null> | null;
|
|
86
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* The configuration used for this extract run. This is a union of two possible shapes:
|
|
91
|
+
*
|
|
92
|
+
* - **[JSON Schema config](https://docs.extend.ai/2026-02-09/product/extraction/schema):** The current config format. All runs created through this API version use this shape.
|
|
93
|
+
* - **[Legacy config](https://docs.extend.ai/2025-04-21/product/legacy/legacy-schema):** A fields-array config from a previous API version. This shape is only returned when retrieving runs that were originally created with the legacy format. This API version does not support creating runs with legacy configs.
|
|
94
|
+
*/
|
|
87
95
|
config: Extend.ExtractConfig;
|
|
88
96
|
/** The file that was processed. */
|
|
89
97
|
file: Extend.FileSummary;
|
|
@@ -20,7 +20,12 @@ export interface ExtractorVersion {
|
|
|
20
20
|
* Examples: `"1.0"`, `"2.1"`, `"draft"`
|
|
21
21
|
*/
|
|
22
22
|
version: string;
|
|
23
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* The configuration settings for this version of the extractor. This is a union of two possible shapes:
|
|
25
|
+
*
|
|
26
|
+
* - **[JSON Schema config](https://docs.extend.ai/2026-02-09/product/extraction/schema):** The current config format. All extractors created through this API version use this shape.
|
|
27
|
+
* - **[Legacy config](https://docs.extend.ai/2025-04-21/product/legacy/legacy-schema):** A fields-array config from a previous API version. This shape is only returned for extractors that were originally configured with the legacy format. This API version does not support creating extractors with legacy configs.
|
|
28
|
+
*/
|
|
24
29
|
config: Extend.ExtractConfig;
|
|
25
30
|
/**
|
|
26
31
|
* The ID of the extractor that this version belongs to.
|
|
@@ -4,7 +4,7 @@ export interface LegacyClassificationAdvancedOptions {
|
|
|
4
4
|
context?: Extend.LegacyClassificationAdvancedOptionsContext;
|
|
5
5
|
/** Enable advanced multimodal processing for better handling of visual elements during classification. */
|
|
6
6
|
advancedMultimodalEnabled?: boolean;
|
|
7
|
-
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](/product/page-ranges). */
|
|
7
|
+
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges). */
|
|
8
8
|
fixedPageLimit?: number;
|
|
9
9
|
pageRanges?: Extend.PageRanges;
|
|
10
10
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface LegacyClassificationConfig {
|
|
3
|
-
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](/changelog/classification/classification-performance) for more details. */
|
|
3
|
+
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
|
|
4
4
|
baseProcessor?: Extend.LegacyClassificationConfigBaseProcessor;
|
|
5
|
-
/** The version of the `"classification_performance"` or `"classification_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Classification Changelog](/changelog/classification/classification-performance) for more details. */
|
|
5
|
+
/** The version of the `"classification_performance"` or `"classification_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
|
|
6
6
|
baseVersion?: string;
|
|
7
7
|
/** Array of possible classifications for the document. */
|
|
8
8
|
classifications: Extend.LegacyClassification[];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](/changelog/classification/classification-performance) for more details. */
|
|
1
|
+
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
|
|
2
2
|
export declare const LegacyClassificationConfigBaseProcessor: {
|
|
3
3
|
readonly ClassificationPerformance: "classification_performance";
|
|
4
4
|
readonly ClassificationLight: "classification_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.LegacyClassificationConfigBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](/changelog/classification/classification-performance) for more details. */
|
|
5
|
+
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
|
|
6
6
|
exports.LegacyClassificationConfigBaseProcessor = {
|
|
7
7
|
ClassificationPerformance: "classification_performance",
|
|
8
8
|
ClassificationLight: "classification_light",
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* These are usage credits for document processing (extraction, classification, or splitting). File parsing credits are tracked separately and can be retrieved from the [Get File](/developers/api-reference/
|
|
2
|
+
* These are usage credits for document processing (extraction, classification, or splitting). File parsing credits are tracked separately and can be retrieved from the [Get File](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/file/get-file) endpoint.
|
|
3
3
|
*
|
|
4
4
|
* This field will not be returned for processor runs created before October 7, 2025, or for customers on legacy billing systems.
|
|
5
5
|
*
|
|
6
|
-
* For more details on how credits work, see our [Credits Guide](/product/general/how-credits-work).
|
|
6
|
+
* For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/product/general/how-credits-work).
|
|
7
7
|
*/
|
|
8
8
|
export interface LegacyDocumentProcessorRunCredits {
|
|
9
9
|
/** The number of credits consumed specifically for document processing in this processor run. This does not include file parsing credits. */
|
|
@@ -20,7 +20,7 @@ export interface LegacyExtractionAdvancedOptions {
|
|
|
20
20
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
21
21
|
* fields that may need manual review.
|
|
22
22
|
*
|
|
23
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/product/extraction/review-agent)
|
|
23
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
|
|
24
24
|
*/
|
|
25
25
|
reviewAgent?: Extend.LegacyExtractionAdvancedOptionsReviewAgent;
|
|
26
26
|
/** Strategy for handling large arrays in documents. */
|
|
@@ -30,7 +30,7 @@ export interface LegacyExtractionAdvancedOptions {
|
|
|
30
30
|
excelSheetRanges?: Extend.ExcelSheetRange[];
|
|
31
31
|
/** Strategy for selecting sheets from Excel documents. */
|
|
32
32
|
excelSheetSelectionStrategy?: Extend.LegacyExtractionAdvancedOptionsExcelSheetSelectionStrategy;
|
|
33
|
-
/** DEPRECATED - See [Page Ranges](/product/page-ranges). */
|
|
33
|
+
/** DEPRECATED - See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges). */
|
|
34
34
|
fixedPageLimit?: number;
|
|
35
35
|
pageRanges?: Extend.PageRanges;
|
|
36
36
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
5
5
|
* fields that may need manual review.
|
|
6
6
|
*
|
|
7
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/product/extraction/review-agent)
|
|
7
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
|
|
8
8
|
*/
|
|
9
9
|
export interface LegacyExtractionAdvancedOptionsReviewAgent {
|
|
10
10
|
/** Whether to enable the review agent for the extraction output. */
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface LegacyExtractionConfig {
|
|
3
|
-
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](/changelog/extraction/extraction-performance) for more details. */
|
|
3
|
+
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
|
|
4
4
|
baseProcessor?: Extend.LegacyExtractionConfigBaseProcessor;
|
|
5
|
-
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Extraction Changelog](/changelog/extraction/extraction-performance) for more details. */
|
|
5
|
+
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
|
|
6
6
|
baseVersion?: string;
|
|
7
7
|
/** Custom rules to guide the extraction process in natural language. */
|
|
8
8
|
extractionRules?: string;
|
|
9
9
|
/**
|
|
10
10
|
* JSON Schema definition of the data to extract. Either `fields` or `schema` must be provided.
|
|
11
11
|
*
|
|
12
|
-
* See the [JSON Schema guide](/product/extraction/schema
|
|
12
|
+
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema) for details and examples of schema configuration.
|
|
13
13
|
*/
|
|
14
14
|
schema?: Extend.JsonObject;
|
|
15
15
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](/changelog/extraction/extraction-performance) for more details. */
|
|
1
|
+
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
|
|
2
2
|
export declare const LegacyExtractionConfigBaseProcessor: {
|
|
3
3
|
readonly ExtractionPerformance: "extraction_performance";
|
|
4
4
|
readonly ExtractionLight: "extraction_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.LegacyExtractionConfigBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](/changelog/extraction/extraction-performance) for more details. */
|
|
5
|
+
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
|
|
6
6
|
exports.LegacyExtractionConfigBaseProcessor = {
|
|
7
7
|
ExtractionPerformance: "extraction_performance",
|
|
8
8
|
ExtractionLight: "extraction_light",
|
|
@@ -14,7 +14,7 @@ export interface LegacyJsonOutputMetadataValue {
|
|
|
14
14
|
*
|
|
15
15
|
* These scores will be present when the `reviewAgent.enabled` flag is set to `true` in the processor config.
|
|
16
16
|
* If the review agent is enabled but a score is not returned for a field, this value will be `null`.
|
|
17
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/product/extraction/review-agent)
|
|
17
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
|
|
18
18
|
*/
|
|
19
19
|
reviewAgentScore?: number | null;
|
|
20
20
|
citations?: Extend.LegacyJsonOutputMetadataValueCitationsItem[];
|
|
@@ -6,7 +6,7 @@ export interface LegacySplitterAdvancedOptions {
|
|
|
6
6
|
splitMethod?: Extend.LegacySplitterAdvancedOptionsSplitMethod;
|
|
7
7
|
/** For Excel documents, split by worksheet. */
|
|
8
8
|
splitExcelDocumentsBySheetEnabled?: boolean;
|
|
9
|
-
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](/product/page-ranges). */
|
|
9
|
+
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges). */
|
|
10
10
|
fixedPageLimit?: number;
|
|
11
11
|
pageRanges?: Extend.PageRanges;
|
|
12
12
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface LegacySplitterConfig {
|
|
3
|
-
/** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](/changelog/splitting/splitting-performance) for more details. */
|
|
3
|
+
/** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
|
|
4
4
|
baseProcessor?: Extend.LegacySplitterConfigBaseProcessor;
|
|
5
|
-
/** The version of the `"splitting_performance"` or `"splitting_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Splitting Changelog](/changelog/splitting/splitting-performance) for more details. */
|
|
5
|
+
/** The version of the `"splitting_performance"` or `"splitting_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
|
|
6
6
|
baseVersion?: string;
|
|
7
7
|
/** Array of classifications that define the possible types of document sections. */
|
|
8
8
|
splitClassifications: Extend.LegacyClassification[];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](/changelog/splitting/splitting-performance) for more details. */
|
|
1
|
+
/** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
|
|
2
2
|
export declare const LegacySplitterConfigBaseProcessor: {
|
|
3
3
|
readonly SplittingPerformance: "splitting_performance";
|
|
4
4
|
readonly SplittingLight: "splitting_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.LegacySplitterConfigBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](/changelog/splitting/splitting-performance) for more details. */
|
|
5
|
+
/** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
|
|
6
6
|
exports.LegacySplitterConfigBaseProcessor = {
|
|
7
7
|
SplittingPerformance: "splitting_performance",
|
|
8
8
|
SplittingLight: "splitting_light",
|
|
@@ -16,7 +16,7 @@ export interface ParseConfig {
|
|
|
16
16
|
* * Prefer `markdown` for most documents, multi-column reading order, and retrieval use cases
|
|
17
17
|
* * Prefer `spatial` for messy/scanned/handwritten or skewed documents, when you need near 1:1 layout fidelity, or for BOL-like logistics docs
|
|
18
18
|
*
|
|
19
|
-
* See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/
|
|
19
|
+
* See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/product/parsing/configuration-options#target-format) for details.
|
|
20
20
|
*/
|
|
21
21
|
target?: Extend.ParseConfigTarget;
|
|
22
22
|
/** Strategy for dividing the document into chunks. */
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* * Prefer `markdown` for most documents, multi-column reading order, and retrieval use cases
|
|
12
12
|
* * Prefer `spatial` for messy/scanned/handwritten or skewed documents, when you need near 1:1 layout fidelity, or for BOL-like logistics docs
|
|
13
13
|
*
|
|
14
|
-
* See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/
|
|
14
|
+
* See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/product/parsing/configuration-options#target-format) for details.
|
|
15
15
|
*/
|
|
16
16
|
export declare const ParseConfigTarget: {
|
|
17
17
|
readonly Markdown: "markdown";
|
|
@@ -15,7 +15,7 @@ exports.ParseConfigTarget = void 0;
|
|
|
15
15
|
* * Prefer `markdown` for most documents, multi-column reading order, and retrieval use cases
|
|
16
16
|
* * Prefer `spatial` for messy/scanned/handwritten or skewed documents, when you need near 1:1 layout fidelity, or for BOL-like logistics docs
|
|
17
17
|
*
|
|
18
|
-
* See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/
|
|
18
|
+
* See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/product/parsing/configuration-options#target-format) for details.
|
|
19
19
|
*/
|
|
20
20
|
exports.ParseConfigTarget = {
|
|
21
21
|
Markdown: "markdown",
|