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
|
@@ -32,7 +32,13 @@ export declare class EditRunsClient {
|
|
|
32
32
|
* @example
|
|
33
33
|
* await client.editRuns.create({
|
|
34
34
|
* file: {
|
|
35
|
-
* url: "
|
|
35
|
+
* url: "https://example.com/form.pdf"
|
|
36
|
+
* },
|
|
37
|
+
* config: {
|
|
38
|
+
* instructions: "Fill out the form with the provided data",
|
|
39
|
+
* advancedOptions: {
|
|
40
|
+
* flattenPdf: true
|
|
41
|
+
* }
|
|
36
42
|
* }
|
|
37
43
|
* })
|
|
38
44
|
*/
|
|
@@ -77,7 +77,13 @@ class EditRunsClient {
|
|
|
77
77
|
* @example
|
|
78
78
|
* await client.editRuns.create({
|
|
79
79
|
* file: {
|
|
80
|
-
* url: "
|
|
80
|
+
* url: "https://example.com/form.pdf"
|
|
81
|
+
* },
|
|
82
|
+
* config: {
|
|
83
|
+
* instructions: "Fill out the form with the provided data",
|
|
84
|
+
* advancedOptions: {
|
|
85
|
+
* flattenPdf: true
|
|
86
|
+
* }
|
|
81
87
|
* }
|
|
82
88
|
* })
|
|
83
89
|
*/
|
|
@@ -3,7 +3,13 @@ import type * as Extend from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* file: {
|
|
6
|
-
* url: "
|
|
6
|
+
* url: "https://example.com/form.pdf"
|
|
7
|
+
* },
|
|
8
|
+
* config: {
|
|
9
|
+
* instructions: "Fill out the form with the provided data",
|
|
10
|
+
* advancedOptions: {
|
|
11
|
+
* flattenPdf: true
|
|
12
|
+
* }
|
|
7
13
|
* }
|
|
8
14
|
* }
|
|
9
15
|
*/
|
|
@@ -42,7 +42,7 @@ export declare class EvaluationSetItemsClient {
|
|
|
42
42
|
*
|
|
43
43
|
* **Limit:** You can create up to 100 items at a time.
|
|
44
44
|
*
|
|
45
|
-
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/product/evaluation/overview) product page.
|
|
45
|
+
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/product/evaluation/overview) product page.
|
|
46
46
|
*
|
|
47
47
|
* @param {string} evaluationSetId - The ID of the evaluation set.
|
|
48
48
|
*
|
|
@@ -62,8 +62,14 @@ export declare class EvaluationSetItemsClient {
|
|
|
62
62
|
* @example
|
|
63
63
|
* await client.evaluationSetItems.create("evaluation_set_id_here", {
|
|
64
64
|
* items: [{
|
|
65
|
-
* fileId: "
|
|
66
|
-
* expectedOutput: {
|
|
65
|
+
* fileId: "file_xK9mLPqRtN3vS8wF5hB2cQ",
|
|
66
|
+
* expectedOutput: {
|
|
67
|
+
* value: {
|
|
68
|
+
* "vendor_name": "Acme Corp",
|
|
69
|
+
* "invoice_number": "INV-001",
|
|
70
|
+
* "total_amount": 1500
|
|
71
|
+
* }
|
|
72
|
+
* }
|
|
67
73
|
* }]
|
|
68
74
|
* })
|
|
69
75
|
*/
|
|
@@ -117,7 +123,13 @@ export declare class EvaluationSetItemsClient {
|
|
|
117
123
|
*
|
|
118
124
|
* @example
|
|
119
125
|
* await client.evaluationSetItems.update("evaluation_set_id_here", "evaluation_set_item_id_here", {
|
|
120
|
-
* expectedOutput: {
|
|
126
|
+
* expectedOutput: {
|
|
127
|
+
* value: {
|
|
128
|
+
* "vendor_name": "Acme Corp",
|
|
129
|
+
* "invoice_number": "INV-001",
|
|
130
|
+
* "total_amount": 1750
|
|
131
|
+
* }
|
|
132
|
+
* }
|
|
121
133
|
* })
|
|
122
134
|
*/
|
|
123
135
|
update(evaluationSetId: string, itemId: string, request: Extend.EvaluationSetItemsUpdateRequest, requestOptions?: EvaluationSetItemsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSetItem>;
|
|
@@ -146,7 +146,7 @@ class EvaluationSetItemsClient {
|
|
|
146
146
|
*
|
|
147
147
|
* **Limit:** You can create up to 100 items at a time.
|
|
148
148
|
*
|
|
149
|
-
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/product/evaluation/overview) product page.
|
|
149
|
+
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/product/evaluation/overview) product page.
|
|
150
150
|
*
|
|
151
151
|
* @param {string} evaluationSetId - The ID of the evaluation set.
|
|
152
152
|
*
|
|
@@ -166,8 +166,14 @@ class EvaluationSetItemsClient {
|
|
|
166
166
|
* @example
|
|
167
167
|
* await client.evaluationSetItems.create("evaluation_set_id_here", {
|
|
168
168
|
* items: [{
|
|
169
|
-
* fileId: "
|
|
170
|
-
* expectedOutput: {
|
|
169
|
+
* fileId: "file_xK9mLPqRtN3vS8wF5hB2cQ",
|
|
170
|
+
* expectedOutput: {
|
|
171
|
+
* value: {
|
|
172
|
+
* "vendor_name": "Acme Corp",
|
|
173
|
+
* "invoice_number": "INV-001",
|
|
174
|
+
* "total_amount": 1500
|
|
175
|
+
* }
|
|
176
|
+
* }
|
|
171
177
|
* }]
|
|
172
178
|
* })
|
|
173
179
|
*/
|
|
@@ -325,7 +331,13 @@ class EvaluationSetItemsClient {
|
|
|
325
331
|
*
|
|
326
332
|
* @example
|
|
327
333
|
* await client.evaluationSetItems.update("evaluation_set_id_here", "evaluation_set_item_id_here", {
|
|
328
|
-
* expectedOutput: {
|
|
334
|
+
* expectedOutput: {
|
|
335
|
+
* value: {
|
|
336
|
+
* "vendor_name": "Acme Corp",
|
|
337
|
+
* "invoice_number": "INV-001",
|
|
338
|
+
* "total_amount": 1750
|
|
339
|
+
* }
|
|
340
|
+
* }
|
|
329
341
|
* })
|
|
330
342
|
*/
|
|
331
343
|
update(evaluationSetId, itemId, request, requestOptions) {
|
package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts
CHANGED
|
@@ -3,8 +3,14 @@ import type * as Extend from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* items: [{
|
|
6
|
-
* fileId: "
|
|
7
|
-
* expectedOutput: {
|
|
6
|
+
* fileId: "file_xK9mLPqRtN3vS8wF5hB2cQ",
|
|
7
|
+
* expectedOutput: {
|
|
8
|
+
* value: {
|
|
9
|
+
* "vendor_name": "Acme Corp",
|
|
10
|
+
* "invoice_number": "INV-001",
|
|
11
|
+
* "total_amount": 1500
|
|
12
|
+
* }
|
|
13
|
+
* }
|
|
8
14
|
* }]
|
|
9
15
|
* }
|
|
10
16
|
*/
|
package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts
CHANGED
|
@@ -2,7 +2,13 @@ import type * as Extend from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* expectedOutput: {
|
|
5
|
+
* expectedOutput: {
|
|
6
|
+
* value: {
|
|
7
|
+
* "vendor_name": "Acme Corp",
|
|
8
|
+
* "invoice_number": "INV-001",
|
|
9
|
+
* "total_amount": 1750
|
|
10
|
+
* }
|
|
11
|
+
* }
|
|
6
12
|
* }
|
|
7
13
|
*/
|
|
8
14
|
export interface EvaluationSetItemsUpdateRequest {
|
|
@@ -36,7 +36,7 @@ export declare class EvaluationSetsClient {
|
|
|
36
36
|
/**
|
|
37
37
|
* Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given extractor, classifier, or splitter. This endpoint will create a new evaluation set, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/create-evaluation-set-item) endpoint.
|
|
38
38
|
*
|
|
39
|
-
* Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/product/evaluation/overview) product page.
|
|
39
|
+
* Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/2026-02-09/product/evaluation/overview) product page.
|
|
40
40
|
*
|
|
41
41
|
* @param {Extend.EvaluationSetsCreateRequest} request
|
|
42
42
|
* @param {EvaluationSetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -52,8 +52,9 @@ export declare class EvaluationSetsClient {
|
|
|
52
52
|
*
|
|
53
53
|
* @example
|
|
54
54
|
* await client.evaluationSets.create({
|
|
55
|
-
* name: "
|
|
56
|
-
*
|
|
55
|
+
* name: "Invoice Processing Test Set",
|
|
56
|
+
* description: "Q4 vendor invoices for accuracy testing",
|
|
57
|
+
* entityId: "ex_1234567890"
|
|
57
58
|
* })
|
|
58
59
|
*/
|
|
59
60
|
create(request: Extend.EvaluationSetsCreateRequest, requestOptions?: EvaluationSetsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSet>;
|
|
@@ -138,7 +138,7 @@ class EvaluationSetsClient {
|
|
|
138
138
|
/**
|
|
139
139
|
* Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given extractor, classifier, or splitter. This endpoint will create a new evaluation set, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/create-evaluation-set-item) endpoint.
|
|
140
140
|
*
|
|
141
|
-
* Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/product/evaluation/overview) product page.
|
|
141
|
+
* Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/2026-02-09/product/evaluation/overview) product page.
|
|
142
142
|
*
|
|
143
143
|
* @param {Extend.EvaluationSetsCreateRequest} request
|
|
144
144
|
* @param {EvaluationSetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -154,8 +154,9 @@ class EvaluationSetsClient {
|
|
|
154
154
|
*
|
|
155
155
|
* @example
|
|
156
156
|
* await client.evaluationSets.create({
|
|
157
|
-
* name: "
|
|
158
|
-
*
|
|
157
|
+
* name: "Invoice Processing Test Set",
|
|
158
|
+
* description: "Q4 vendor invoices for accuracy testing",
|
|
159
|
+
* entityId: "ex_1234567890"
|
|
159
160
|
* })
|
|
160
161
|
*/
|
|
161
162
|
create(request, requestOptions) {
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
|
-
* name: "
|
|
5
|
-
*
|
|
4
|
+
* name: "Invoice Processing Test Set",
|
|
5
|
+
* description: "Q4 vendor invoices for accuracy testing",
|
|
6
|
+
* entityId: "ex_1234567890"
|
|
6
7
|
* }
|
|
7
8
|
*/
|
|
8
9
|
export interface EvaluationSetsCreateRequest {
|
|
@@ -59,7 +59,8 @@ export declare class ExtractorVersionsClient {
|
|
|
59
59
|
*
|
|
60
60
|
* @example
|
|
61
61
|
* await client.extractorVersions.create("extractor_id_here", {
|
|
62
|
-
* releaseType: "
|
|
62
|
+
* releaseType: "minor",
|
|
63
|
+
* description: "Updated extraction rules for better accuracy"
|
|
63
64
|
* })
|
|
64
65
|
*/
|
|
65
66
|
create(extractorId: string, request: Extend.ExtractorVersionsCreateRequest, requestOptions?: ExtractorVersionsClient.RequestOptions): core.HttpResponsePromise<Extend.ExtractorVersion>;
|
|
@@ -159,7 +159,8 @@ class ExtractorVersionsClient {
|
|
|
159
159
|
*
|
|
160
160
|
* @example
|
|
161
161
|
* await client.extractorVersions.create("extractor_id_here", {
|
|
162
|
-
* releaseType: "
|
|
162
|
+
* releaseType: "minor",
|
|
163
|
+
* description: "Updated extraction rules for better accuracy"
|
|
163
164
|
* })
|
|
164
165
|
*/
|
|
165
166
|
create(extractorId, request, requestOptions) {
|
|
@@ -51,7 +51,26 @@ export declare class ExtractorsClient {
|
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
53
|
* await client.extractors.create({
|
|
54
|
-
* name: "
|
|
54
|
+
* name: "Invoice Extractor",
|
|
55
|
+
* config: {
|
|
56
|
+
* schema: {
|
|
57
|
+
* "type": "object",
|
|
58
|
+
* "properties": {
|
|
59
|
+
* "vendor_name": {
|
|
60
|
+
* "type": "string",
|
|
61
|
+
* "description": "The name of the vendor"
|
|
62
|
+
* },
|
|
63
|
+
* "invoice_number": {
|
|
64
|
+
* "type": "string",
|
|
65
|
+
* "description": "The invoice number"
|
|
66
|
+
* },
|
|
67
|
+
* "total_amount": {
|
|
68
|
+
* "type": "number",
|
|
69
|
+
* "description": "The total amount due"
|
|
70
|
+
* }
|
|
71
|
+
* }
|
|
72
|
+
* }
|
|
73
|
+
* }
|
|
55
74
|
* })
|
|
56
75
|
*/
|
|
57
76
|
create(request: Extend.ExtractorsCreateRequest, requestOptions?: ExtractorsClient.RequestOptions): core.HttpResponsePromise<Extend.Extractor>;
|
|
@@ -97,7 +116,9 @@ export declare class ExtractorsClient {
|
|
|
97
116
|
* @throws {@link Extend.InternalServerError}
|
|
98
117
|
*
|
|
99
118
|
* @example
|
|
100
|
-
* await client.extractors.update("extractor_id_here"
|
|
119
|
+
* await client.extractors.update("extractor_id_here", {
|
|
120
|
+
* name: "Invoice Extractor v2"
|
|
121
|
+
* })
|
|
101
122
|
*/
|
|
102
123
|
update(id: string, request?: Extend.ExtractorsUpdateRequest, requestOptions?: ExtractorsClient.RequestOptions): core.HttpResponsePromise<Extend.Extractor>;
|
|
103
124
|
private __update;
|
|
@@ -152,7 +152,26 @@ class ExtractorsClient {
|
|
|
152
152
|
*
|
|
153
153
|
* @example
|
|
154
154
|
* await client.extractors.create({
|
|
155
|
-
* name: "
|
|
155
|
+
* name: "Invoice Extractor",
|
|
156
|
+
* config: {
|
|
157
|
+
* schema: {
|
|
158
|
+
* "type": "object",
|
|
159
|
+
* "properties": {
|
|
160
|
+
* "vendor_name": {
|
|
161
|
+
* "type": "string",
|
|
162
|
+
* "description": "The name of the vendor"
|
|
163
|
+
* },
|
|
164
|
+
* "invoice_number": {
|
|
165
|
+
* "type": "string",
|
|
166
|
+
* "description": "The invoice number"
|
|
167
|
+
* },
|
|
168
|
+
* "total_amount": {
|
|
169
|
+
* "type": "number",
|
|
170
|
+
* "description": "The total amount due"
|
|
171
|
+
* }
|
|
172
|
+
* }
|
|
173
|
+
* }
|
|
174
|
+
* }
|
|
156
175
|
* })
|
|
157
176
|
*/
|
|
158
177
|
create(request, requestOptions) {
|
|
@@ -299,7 +318,9 @@ class ExtractorsClient {
|
|
|
299
318
|
* @throws {@link Extend.InternalServerError}
|
|
300
319
|
*
|
|
301
320
|
* @example
|
|
302
|
-
* await client.extractors.update("extractor_id_here"
|
|
321
|
+
* await client.extractors.update("extractor_id_here", {
|
|
322
|
+
* name: "Invoice Extractor v2"
|
|
323
|
+
* })
|
|
303
324
|
*/
|
|
304
325
|
update(id, request = {}, requestOptions) {
|
|
305
326
|
return core.HttpResponsePromise.fromPromise(this.__update(id, request, requestOptions));
|
|
@@ -2,7 +2,26 @@ import type * as Extend from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* name: "
|
|
5
|
+
* name: "Invoice Extractor",
|
|
6
|
+
* config: {
|
|
7
|
+
* schema: {
|
|
8
|
+
* "type": "object",
|
|
9
|
+
* "properties": {
|
|
10
|
+
* "vendor_name": {
|
|
11
|
+
* "type": "string",
|
|
12
|
+
* "description": "The name of the vendor"
|
|
13
|
+
* },
|
|
14
|
+
* "invoice_number": {
|
|
15
|
+
* "type": "string",
|
|
16
|
+
* "description": "The invoice number"
|
|
17
|
+
* },
|
|
18
|
+
* "total_amount": {
|
|
19
|
+
* "type": "number",
|
|
20
|
+
* "description": "The total amount due"
|
|
21
|
+
* }
|
|
22
|
+
* }
|
|
23
|
+
* }
|
|
24
|
+
* }
|
|
6
25
|
* }
|
|
7
26
|
*/
|
|
8
27
|
export interface ExtractorsCreateRequest {
|
|
@@ -84,7 +84,7 @@ export declare class FilesClient {
|
|
|
84
84
|
/**
|
|
85
85
|
* Upload and create a new file in Extend.
|
|
86
86
|
*
|
|
87
|
-
* This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/
|
|
87
|
+
* This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/create-workflow-run), [creating evaluation set items](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/create-evaluation-set-item), [parsing](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/parse/parse-file), etc.
|
|
88
88
|
*
|
|
89
89
|
* If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
|
|
90
90
|
*
|
|
@@ -287,7 +287,7 @@ class FilesClient {
|
|
|
287
287
|
/**
|
|
288
288
|
* Upload and create a new file in Extend.
|
|
289
289
|
*
|
|
290
|
-
* This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/
|
|
290
|
+
* This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/create-workflow-run), [creating evaluation set items](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/create-evaluation-set-item), [parsing](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/parse/parse-file), etc.
|
|
291
291
|
*
|
|
292
292
|
* If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
|
|
293
293
|
*
|
package/api/resources/index.d.ts
CHANGED
|
@@ -52,6 +52,12 @@ export * from "./splitters/types";
|
|
|
52
52
|
export * as splitterVersions from "./splitterVersions";
|
|
53
53
|
export * from "./splitterVersions/client/requests";
|
|
54
54
|
export * from "./splitterVersions/types";
|
|
55
|
+
export * as webhookEndpoints from "./webhookEndpoints";
|
|
56
|
+
export * from "./webhookEndpoints/client/requests";
|
|
57
|
+
export * from "./webhookEndpoints/types";
|
|
58
|
+
export * as webhookSubscriptions from "./webhookSubscriptions";
|
|
59
|
+
export * from "./webhookSubscriptions/client/requests";
|
|
60
|
+
export * from "./webhookSubscriptions/types";
|
|
55
61
|
export * as workflowRuns from "./workflowRuns";
|
|
56
62
|
export * from "./workflowRuns/client/requests";
|
|
57
63
|
export * from "./workflowRuns/types";
|
package/api/resources/index.js
CHANGED
|
@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.workflows = exports.workflowRuns = exports.splitterVersions = exports.splitters = exports.splitRuns = exports.processorVersion = exports.processorRun = exports.processor = exports.parseRuns = exports.files = exports.extractRuns = exports.extractorVersions = exports.extractors = exports.evaluationSets = exports.evaluationSetRuns = exports.evaluationSetItems = exports.editRuns = exports.classifyRuns = exports.classifierVersions = exports.classifiers = exports.batchProcessorRun = void 0;
|
|
39
|
+
exports.workflows = exports.workflowRuns = exports.webhookSubscriptions = exports.webhookEndpoints = exports.splitterVersions = exports.splitters = exports.splitRuns = exports.processorVersion = exports.processorRun = exports.processor = exports.parseRuns = exports.files = exports.extractRuns = exports.extractorVersions = exports.extractors = exports.evaluationSets = exports.evaluationSetRuns = exports.evaluationSetItems = exports.editRuns = exports.classifyRuns = exports.classifierVersions = exports.classifiers = exports.batchProcessorRun = void 0;
|
|
40
40
|
exports.batchProcessorRun = __importStar(require("./batchProcessorRun"));
|
|
41
41
|
__exportStar(require("./batchProcessorRun/types"), exports);
|
|
42
42
|
exports.classifiers = __importStar(require("./classifiers"));
|
|
@@ -91,6 +91,12 @@ __exportStar(require("./splitters/types"), exports);
|
|
|
91
91
|
exports.splitterVersions = __importStar(require("./splitterVersions"));
|
|
92
92
|
__exportStar(require("./splitterVersions/client/requests"), exports);
|
|
93
93
|
__exportStar(require("./splitterVersions/types"), exports);
|
|
94
|
+
exports.webhookEndpoints = __importStar(require("./webhookEndpoints"));
|
|
95
|
+
__exportStar(require("./webhookEndpoints/client/requests"), exports);
|
|
96
|
+
__exportStar(require("./webhookEndpoints/types"), exports);
|
|
97
|
+
exports.webhookSubscriptions = __importStar(require("./webhookSubscriptions"));
|
|
98
|
+
__exportStar(require("./webhookSubscriptions/client/requests"), exports);
|
|
99
|
+
__exportStar(require("./webhookSubscriptions/types"), exports);
|
|
94
100
|
exports.workflowRuns = __importStar(require("./workflowRuns"));
|
|
95
101
|
__exportStar(require("./workflowRuns/client/requests"), exports);
|
|
96
102
|
__exportStar(require("./workflowRuns/types"), exports);
|
|
@@ -34,8 +34,8 @@ export declare class ProcessorRunClient {
|
|
|
34
34
|
* - **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
|
|
35
35
|
*
|
|
36
36
|
* **For asynchronous processing:**
|
|
37
|
-
* - You can [configure webhooks](https://docs.extend.ai/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
38
|
-
* - Or you can [poll the get endpoint](https://docs.extend.ai/
|
|
37
|
+
* - You can [configure webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
38
|
+
* - Or you can [poll the get endpoint](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/get-processor-run) for updates on the status of the processor run.
|
|
39
39
|
*
|
|
40
40
|
* @param {Extend.ProcessorRunCreateRequest} request
|
|
41
41
|
* @param {ProcessorRunClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -55,7 +55,7 @@ export declare class ProcessorRunClient {
|
|
|
55
55
|
/**
|
|
56
56
|
* Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
|
|
57
57
|
*
|
|
58
|
-
* A common use case for this endpoint is to poll for the status and final output of an async processor run when using the [Run Processor](https://docs.extend.ai/
|
|
58
|
+
* A common use case for this endpoint is to poll for the status and final output of an async processor run when using the [Run Processor](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/create-processor-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
59
59
|
*
|
|
60
60
|
* @param {string} id - The unique identifier for this processor run.
|
|
61
61
|
*
|
|
@@ -129,8 +129,8 @@ class ProcessorRunClient {
|
|
|
129
129
|
* - **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
|
|
130
130
|
*
|
|
131
131
|
* **For asynchronous processing:**
|
|
132
|
-
* - You can [configure webhooks](https://docs.extend.ai/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
133
|
-
* - Or you can [poll the get endpoint](https://docs.extend.ai/
|
|
132
|
+
* - You can [configure webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
133
|
+
* - Or you can [poll the get endpoint](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/get-processor-run) for updates on the status of the processor run.
|
|
134
134
|
*
|
|
135
135
|
* @param {Extend.ProcessorRunCreateRequest} request
|
|
136
136
|
* @param {ProcessorRunClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -194,7 +194,7 @@ class ProcessorRunClient {
|
|
|
194
194
|
/**
|
|
195
195
|
* Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
|
|
196
196
|
*
|
|
197
|
-
* A common use case for this endpoint is to poll for the status and final output of an async processor run when using the [Run Processor](https://docs.extend.ai/
|
|
197
|
+
* A common use case for this endpoint is to poll for the status and final output of an async processor run when using the [Run Processor](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/create-processor-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
198
198
|
*
|
|
199
199
|
* @param {string} id - The unique identifier for this processor run.
|
|
200
200
|
*
|
|
@@ -14,7 +14,7 @@ export interface ProcessorRunCreateRequest {
|
|
|
14
14
|
* - Specific version numbers corresponding to versions your team has published, e.g. `"1.0"`, `"2.2"`, etc.
|
|
15
15
|
*/
|
|
16
16
|
version?: string;
|
|
17
|
-
/** The file to be processed. One of `file` or `rawText` must be provided. Supported file types can be found [here](/product/general/supported-file-types). */
|
|
17
|
+
/** The file to be processed. One of `file` or `rawText` must be provided. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types). */
|
|
18
18
|
file?: Extend.LegacyProcessorRunFileInput;
|
|
19
19
|
/** A raw string to be processed. Can be used in place of file when passing raw text data streams. One of `file` or `rawText` must be provided. */
|
|
20
20
|
rawText?: string;
|
|
@@ -159,8 +159,11 @@ class SplitRunsClient {
|
|
|
159
159
|
*
|
|
160
160
|
* @example
|
|
161
161
|
* await client.splitRuns.create({
|
|
162
|
+
* splitter: {
|
|
163
|
+
* id: "spl_1234567890"
|
|
164
|
+
* },
|
|
162
165
|
* file: {
|
|
163
|
-
* url: "
|
|
166
|
+
* url: "https://example.com/multi-document.pdf"
|
|
164
167
|
* }
|
|
165
168
|
* })
|
|
166
169
|
*/
|
|
@@ -59,7 +59,8 @@ export declare class SplitterVersionsClient {
|
|
|
59
59
|
*
|
|
60
60
|
* @example
|
|
61
61
|
* await client.splitterVersions.create("splitter_id_here", {
|
|
62
|
-
* releaseType: "
|
|
62
|
+
* releaseType: "minor",
|
|
63
|
+
* description: "Improved split boundary detection"
|
|
63
64
|
* })
|
|
64
65
|
*/
|
|
65
66
|
create(splitterId: string, request: Extend.SplitterVersionsCreateRequest, requestOptions?: SplitterVersionsClient.RequestOptions): core.HttpResponsePromise<Extend.SplitterVersion>;
|
|
@@ -159,7 +159,8 @@ class SplitterVersionsClient {
|
|
|
159
159
|
*
|
|
160
160
|
* @example
|
|
161
161
|
* await client.splitterVersions.create("splitter_id_here", {
|
|
162
|
-
* releaseType: "
|
|
162
|
+
* releaseType: "minor",
|
|
163
|
+
* description: "Improved split boundary detection"
|
|
163
164
|
* })
|
|
164
165
|
*/
|
|
165
166
|
create(splitterId, request, requestOptions) {
|