extend-ai 1.11.0 → 1.14.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 +33 -14
- package/Client.js +33 -14
- package/LICENSE +21 -0
- package/api/client/requests/ExtractRequest.d.ts +23 -4
- package/api/client/requests/ParseRequest.d.ts +1 -1
- package/api/resources/batchProcessorRun/client/Client.d.ts +2 -2
- package/api/resources/batchProcessorRun/client/Client.js +2 -2
- package/api/resources/batchProcessorRun/client/requests/BatchProcessorRunGetRequest.d.ts +1 -1
- package/api/resources/batchRuns/client/Client.d.ts +1 -1
- package/api/resources/batchRuns/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/Client.d.ts +1 -1
- package/api/resources/classifierVersions/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +1 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsListRequest.d.ts +1 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsRetrieveRequest.d.ts +1 -1
- package/api/resources/classifiers/client/Client.d.ts +1 -1
- package/api/resources/classifiers/client/Client.js +1 -1
- package/api/resources/classifiers/client/requests/ClassifiersListRequest.d.ts +1 -1
- package/api/resources/classifiers/client/requests/ClassifiersRetrieveRequest.d.ts +1 -1
- package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/Client.d.ts +3 -3
- package/api/resources/classifyRuns/client/Client.js +3 -3
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsListRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/editRuns/client/Client.d.ts +2 -2
- package/api/resources/editRuns/client/Client.js +2 -2
- package/api/resources/editRuns/client/requests/EditRunsDeleteRequest.d.ts +1 -1
- package/api/resources/editRuns/client/requests/EditRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/editSchemas/client/Client.d.ts +2 -2
- package/api/resources/editSchemas/client/Client.js +2 -2
- package/api/resources/editTemplates/client/Client.d.ts +1 -1
- package/api/resources/editTemplates/client/Client.js +1 -1
- package/api/resources/editTemplates/client/requests/EditTemplatesRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/Client.d.ts +3 -3
- package/api/resources/evaluationSetItems/client/Client.js +3 -3
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsListRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +1 -1
- package/api/resources/evaluationSetRuns/client/Client.d.ts +3 -3
- package/api/resources/evaluationSetRuns/client/Client.js +3 -3
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsCreateRequest.d.ts +1 -1
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSets/client/Client.d.ts +4 -4
- package/api/resources/evaluationSets/client/Client.js +4 -4
- package/api/resources/evaluationSets/client/requests/EvaluationSetsListRequest.d.ts +1 -1
- package/api/resources/evaluationSets/client/requests/EvaluationSetsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/Client.d.ts +3 -3
- package/api/resources/extractRuns/client/Client.js +3 -3
- package/api/resources/extractRuns/client/requests/ExtractRunsCancelRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +2 -2
- package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsListRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractRuns/types/ExtractRunsCreateRequestExtractor.d.ts +1 -1
- package/api/resources/extractorVersions/client/Client.d.ts +1 -1
- package/api/resources/extractorVersions/client/Client.js +1 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +1 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsListRequest.d.ts +1 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractors/client/Client.d.ts +22 -6
- package/api/resources/extractors/client/Client.js +22 -6
- package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +21 -5
- package/api/resources/extractors/client/requests/ExtractorsListRequest.d.ts +1 -1
- package/api/resources/extractors/client/requests/ExtractorsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +1 -1
- package/api/resources/files/client/Client.d.ts +3 -3
- package/api/resources/files/client/Client.js +3 -3
- package/api/resources/files/client/requests/FilesDeleteRequest.d.ts +1 -1
- package/api/resources/files/client/requests/FilesListRequest.d.ts +1 -1
- package/api/resources/files/client/requests/FilesRetrieveRequest.d.ts +1 -1
- package/api/resources/files/client/requests/FilesUploadRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/Client.d.ts +28 -3
- package/api/resources/parseRuns/client/Client.js +81 -3
- package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.d.ts +8 -0
- package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.js +3 -0
- package/api/resources/parseRuns/client/requests/ParseRunsDeleteRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/requests/ParseRunsListRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/requests/ParseRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/requests/index.d.ts +1 -0
- package/api/resources/parseRuns/types/ParseRunsListResponse.d.ts +1 -1
- package/api/resources/processor/client/Client.d.ts +1 -1
- package/api/resources/processor/client/Client.js +1 -1
- package/api/resources/processor/client/requests/ProcessorListRequest.d.ts +1 -1
- package/api/resources/processor/client/requests/ProcessorUpdateRequest.d.ts +1 -1
- package/api/resources/processorRun/client/Client.d.ts +4 -4
- package/api/resources/processorRun/client/Client.js +4 -4
- package/api/resources/processorRun/client/requests/ProcessorRunCancelRequest.d.ts +1 -1
- package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +2 -2
- package/api/resources/processorRun/client/requests/ProcessorRunDeleteRequest.d.ts +1 -1
- package/api/resources/processorRun/client/requests/ProcessorRunGetRequest.d.ts +1 -1
- package/api/resources/processorRun/client/requests/ProcessorRunListRequest.d.ts +1 -1
- package/api/resources/processorVersion/client/Client.d.ts +1 -1
- package/api/resources/processorVersion/client/Client.js +1 -1
- package/api/resources/processorVersion/client/requests/ProcessorVersionCreateRequest.d.ts +1 -1
- package/api/resources/processorVersion/client/requests/ProcessorVersionGetRequest.d.ts +1 -1
- package/api/resources/processorVersion/client/requests/ProcessorVersionListRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/Client.d.ts +3 -3
- package/api/resources/splitRuns/client/Client.js +3 -3
- package/api/resources/splitRuns/client/requests/SplitRunsCancelRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/requests/SplitRunsListRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/requests/SplitRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/splitterVersions/client/Client.d.ts +1 -1
- package/api/resources/splitterVersions/client/Client.js +1 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +1 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsListRequest.d.ts +1 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsRetrieveRequest.d.ts +1 -1
- package/api/resources/splitters/client/Client.d.ts +1 -1
- package/api/resources/splitters/client/Client.js +1 -1
- package/api/resources/splitters/client/requests/SplittersListRequest.d.ts +1 -1
- package/api/resources/splitters/client/requests/SplittersRetrieveRequest.d.ts +1 -1
- package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/Client.d.ts +3 -3
- package/api/resources/webhookEndpoints/client/Client.js +3 -3
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsDeleteRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsRetrieveRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/Client.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/Client.js +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/Client.d.ts +6 -6
- package/api/resources/workflowRuns/client/Client.js +6 -6
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +2 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsDeleteRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +2 -2
- package/api/resources/workflowRuns/client/requests/WorkflowRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +1 -1
- package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
- package/api/resources/workflowVersions/client/Client.d.ts +1 -1
- package/api/resources/workflowVersions/client/Client.js +1 -1
- package/api/resources/workflowVersions/client/requests/WorkflowVersionsCreateRequest.d.ts +1 -1
- package/api/resources/workflows/client/Client.d.ts +1 -1
- package/api/resources/workflows/client/Client.js +1 -1
- package/api/resources/workflows/client/requests/WorkflowsCreateRequest.d.ts +1 -1
- package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.d.ts +1 -1
- package/api/types/ApiError.d.ts +1 -1
- package/api/types/BlockMetadata.d.ts +6 -0
- package/api/types/BlockMetadataSheet.d.ts +9 -0
- package/api/types/BlockMetadataSheet.js +3 -0
- package/api/types/ChunkMetadata.d.ts +4 -0
- package/api/types/ClassificationNextEntry.d.ts +1 -1
- package/api/types/ClassifyBaseProcessor.d.ts +1 -1
- package/api/types/ClassifyBaseProcessor.js +1 -1
- package/api/types/ClassifyConfig.d.ts +1 -1
- package/api/types/ClassifyOverrideConfig.d.ts +1 -1
- package/api/types/ClassifyRun.d.ts +2 -2
- package/api/types/ClassifyRunSummary.d.ts +2 -2
- package/api/types/ClassifyStepDefinition.d.ts +3 -3
- package/api/types/ClassifyStepDefinitionConfig.d.ts +1 -1
- package/api/types/CollectStepDefinition.d.ts +1 -1
- package/api/types/ConditionalExtractStepDefinition.d.ts +1 -1
- package/api/types/ConditionalExtractStepDefinitionConfig.d.ts +1 -1
- package/api/types/ConditionalExtractStepDefinitionConfigRulesItem.d.ts +1 -1
- package/api/types/ConditionalNextEntry.d.ts +1 -1
- package/api/types/ConditionalStepDefinition.d.ts +2 -2
- package/api/types/ConditionalStepDefinitionConfig.d.ts +1 -1
- package/api/types/ConditionalStepDefinitionConfigConditionsItem.d.ts +3 -3
- package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.d.ts +1 -1
- package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.js +1 -1
- package/api/types/EvaluationSetRun.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinition.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfig.d.ts +2 -2
- package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.js +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptions.d.ts +3 -3
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.js +1 -1
- package/api/types/ExtractAdvancedOptions.d.ts +1 -1
- package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/ExtractBaseProcessor.d.ts +1 -1
- package/api/types/ExtractBaseProcessor.js +1 -1
- package/api/types/ExtractConfigJson.d.ts +9 -5
- package/api/types/ExtractConfigLegacy.d.ts +2 -2
- package/api/types/ExtractConfigLegacyBaseProcessor.d.ts +1 -1
- package/api/types/ExtractConfigLegacyBaseProcessor.js +1 -1
- package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
- package/api/types/ExtractOverrideConfigJson.d.ts +2 -2
- package/api/types/ExtractRequestExtractor.d.ts +1 -1
- package/api/types/ExtractRun.d.ts +5 -4
- package/api/types/ExtractRunSummary.d.ts +16 -2
- package/api/types/ExtractStepDefinition.d.ts +1 -1
- package/api/types/ExtractorVersion.d.ts +1 -1
- package/api/types/FileConversionStepDefinition.d.ts +1 -1
- package/api/types/FileConversionStepDefinitionConfig.d.ts +1 -1
- package/api/types/FileConversionStepDefinitionConfigFailureBehavior.d.ts +1 -1
- package/api/types/FileConversionStepDefinitionConfigFailureBehavior.js +1 -1
- package/api/types/FileFromUrl.d.ts +1 -1
- package/api/types/HumanReviewStepDefinition.d.ts +1 -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/MergeExtractStepDefinition.d.ts +1 -1
- package/api/types/MergeExtractStepDefinitionConfig.d.ts +1 -1
- package/api/types/MergeExtractStepDefinitionConfigMergeOrder.d.ts +1 -1
- package/api/types/MergeExtractStepDefinitionConfigMergeOrder.js +1 -1
- package/api/types/PageRanges.d.ts +1 -1
- package/api/types/ParseConfig.d.ts +2 -2
- package/api/types/ParseConfigBlockOptionsFigures.d.ts +2 -0
- package/api/types/ParseConfigEngine.d.ts +1 -1
- package/api/types/ParseConfigEngine.js +1 -1
- package/api/types/ParseConfigTarget.d.ts +1 -1
- package/api/types/ParseConfigTarget.js +1 -1
- package/api/types/ParseRun.d.ts +6 -0
- package/api/types/ParseRunSummary.d.ts +81 -0
- package/api/types/ParseRunSummary.js +3 -0
- package/api/types/ParseRunSummaryMetrics.d.ts +11 -0
- package/api/types/ParseRunSummaryMetrics.js +3 -0
- package/api/types/ParseRunSummaryStatus.d.ts +14 -0
- package/api/types/ParseRunSummaryStatus.js +17 -0
- package/api/types/ParseStepDefinition.d.ts +1 -1
- package/api/types/RuleValidationNextEntry.d.ts +1 -1
- package/api/types/RuleValidationStepDefinition.d.ts +2 -2
- package/api/types/RuleValidationStepDefinitionConfig.d.ts +1 -1
- package/api/types/RuleValidationStepDefinitionConfigRulesItem.d.ts +1 -1
- package/api/types/RunUsage.d.ts +1 -1
- package/api/types/RunUsageBreakdownCharge.d.ts +15 -0
- package/api/types/RunUsageBreakdownCharge.js +3 -0
- package/api/types/RunUsageBreakdownEntry.d.ts +7 -1
- package/api/types/RunUsageSummary.d.ts +1 -1
- package/api/types/SplitBaseProcessor.d.ts +1 -1
- package/api/types/SplitBaseProcessor.js +1 -1
- package/api/types/SplitConfig.d.ts +1 -1
- package/api/types/SplitOverrideConfig.d.ts +1 -1
- package/api/types/SplitRun.d.ts +2 -2
- package/api/types/SplitRunSummary.d.ts +2 -2
- package/api/types/SplitStepDefinition.d.ts +3 -3
- package/api/types/SplitStepDefinitionConfig.d.ts +1 -1
- package/api/types/TriggerStepDefinition.d.ts +1 -1
- package/api/types/WebhookResponseStepDefinition.d.ts +1 -1
- package/api/types/WorkflowStepDefinition.d.ts +1 -1
- package/api/types/index.d.ts +5 -0
- package/api/types/index.js +5 -0
- package/auth/BearerAuthProvider.d.ts +1 -1
- package/auth/BearerAuthProvider.js +6 -3
- package/package.json +2 -1
- package/reference.md +160 -48
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/resources/parseRuns/ParseRunsWrapper.test.js +1 -1
package/reference.md
CHANGED
|
@@ -13,11 +13,11 @@
|
|
|
13
13
|
|
|
14
14
|
Parse a file synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
|
|
15
15
|
|
|
16
|
-
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /parse_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/
|
|
16
|
+
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /parse_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/general/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
|
|
17
17
|
|
|
18
18
|
The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.
|
|
19
19
|
|
|
20
|
-
For more details, see the [Parse File guide](https://docs.extend.ai/2026-02-09/
|
|
20
|
+
For more details, see the [Parse File guide](https://docs.extend.ai/2026-02-09/parsing/overview).
|
|
21
21
|
</dd>
|
|
22
22
|
</dl>
|
|
23
23
|
</dd>
|
|
@@ -87,11 +87,11 @@ await client.parse({
|
|
|
87
87
|
|
|
88
88
|
Edit a file synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
|
|
89
89
|
|
|
90
|
-
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /edit_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/
|
|
90
|
+
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /edit_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/general/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
|
|
91
91
|
|
|
92
92
|
The Edit endpoint allows you to detect and fill form fields in PDF documents.
|
|
93
93
|
|
|
94
|
-
For more details, see the [Edit File guide](https://docs.extend.ai/2026-02-09/
|
|
94
|
+
For more details, see the [Edit File guide](https://docs.extend.ai/2026-02-09/editing/edit).
|
|
95
95
|
</dd>
|
|
96
96
|
</dl>
|
|
97
97
|
</dd>
|
|
@@ -166,11 +166,11 @@ await client.edit({
|
|
|
166
166
|
|
|
167
167
|
Extract structured data from a file synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
|
|
168
168
|
|
|
169
|
-
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /extract_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/
|
|
169
|
+
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /extract_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/general/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
|
|
170
170
|
|
|
171
|
-
The Extract endpoint allows you to extract structured data from files using an existing extractor
|
|
171
|
+
The Extract endpoint allows you to extract structured data from files using an existing extractor, an inline configuration, or no configuration at all. When neither is provided, Extend automatically infers a schema from the document before extraction — no extractor or schema is required.
|
|
172
172
|
|
|
173
|
-
For more details, see the [Extract File guide](https://docs.extend.ai/2026-02-09/
|
|
173
|
+
For more details, see the [Extract File guide](https://docs.extend.ai/2026-02-09/extraction/overview).
|
|
174
174
|
</dd>
|
|
175
175
|
</dl>
|
|
176
176
|
</dd>
|
|
@@ -199,8 +199,27 @@ await client.extract({
|
|
|
199
199
|
"description": "The invoice number"
|
|
200
200
|
},
|
|
201
201
|
"total_amount": {
|
|
202
|
-
"type": "
|
|
203
|
-
"
|
|
202
|
+
"type": "object",
|
|
203
|
+
"extend:type": "currency",
|
|
204
|
+
"description": "The total amount due",
|
|
205
|
+
"properties": {
|
|
206
|
+
"amount": {
|
|
207
|
+
"type": [
|
|
208
|
+
"number",
|
|
209
|
+
"null"
|
|
210
|
+
]
|
|
211
|
+
},
|
|
212
|
+
"iso_4217_currency_code": {
|
|
213
|
+
"type": [
|
|
214
|
+
"string",
|
|
215
|
+
"null"
|
|
216
|
+
]
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
"required": [
|
|
220
|
+
"amount",
|
|
221
|
+
"iso_4217_currency_code"
|
|
222
|
+
]
|
|
204
223
|
}
|
|
205
224
|
}
|
|
206
225
|
}
|
|
@@ -258,11 +277,11 @@ await client.extract({
|
|
|
258
277
|
|
|
259
278
|
Classify a document synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
|
|
260
279
|
|
|
261
|
-
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /classify_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/
|
|
280
|
+
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /classify_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/general/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
|
|
262
281
|
|
|
263
282
|
The Classify endpoint allows you to classify documents using an existing classifier or an inline configuration.
|
|
264
283
|
|
|
265
|
-
For more details, see the [Classify File guide](https://docs.extend.ai/2026-02-09/
|
|
284
|
+
For more details, see the [Classify File guide](https://docs.extend.ai/2026-02-09/classification/configuring-a-classifier).
|
|
266
285
|
</dd>
|
|
267
286
|
</dl>
|
|
268
287
|
</dd>
|
|
@@ -346,11 +365,11 @@ await client.classify({
|
|
|
346
365
|
|
|
347
366
|
Split a document synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
|
|
348
367
|
|
|
349
|
-
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /split_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/
|
|
368
|
+
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /split_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/general/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
|
|
350
369
|
|
|
351
370
|
The Split endpoint allows you to split documents into multiple parts using an existing splitter or an inline configuration.
|
|
352
371
|
|
|
353
|
-
For more details, see the [Split File guide](https://docs.extend.ai/2026-02-09/
|
|
372
|
+
For more details, see the [Split File guide](https://docs.extend.ai/2026-02-09/splitting/configuring-a-splitter).
|
|
354
373
|
</dd>
|
|
355
374
|
</dl>
|
|
356
375
|
</dd>
|
|
@@ -654,11 +673,11 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
654
673
|
|
|
655
674
|
Upload and create a new file in Extend.
|
|
656
675
|
|
|
657
|
-
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/
|
|
676
|
+
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/api-reference/endpoints/workflow/create-workflow-run), [creating evaluation set items](https://docs.extend.ai/2026-02-09/api-reference/endpoints/evaluation/create-evaluation-set-item), [parsing](https://docs.extend.ai/2026-02-09/api-reference/endpoints/parse/parse-file), etc.
|
|
658
677
|
|
|
659
678
|
If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
|
|
660
679
|
|
|
661
|
-
Supported file types can be found [here](https://docs.extend.ai/2026-02-09/
|
|
680
|
+
Supported file types can be found [here](https://docs.extend.ai/2026-02-09/general/supported-file-types).
|
|
662
681
|
|
|
663
682
|
This endpoint requires multipart form encoding. Most HTTP clients will handle this encoding automatically (see the examples).
|
|
664
683
|
</dd>
|
|
@@ -873,7 +892,7 @@ await client.parseRuns.create({
|
|
|
873
892
|
|
|
874
893
|
Retrieve the status and results of a parse run.
|
|
875
894
|
|
|
876
|
-
Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the [Create Parse Run](https://docs.extend.ai/2026-02-09/
|
|
895
|
+
Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the [Create Parse Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/parse/create-parse-run) endpoint.
|
|
877
896
|
</dd>
|
|
878
897
|
</dl>
|
|
879
898
|
</dd>
|
|
@@ -1009,6 +1028,83 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1009
1028
|
</dl>
|
|
1010
1029
|
|
|
1011
1030
|
|
|
1031
|
+
</dd>
|
|
1032
|
+
</dl>
|
|
1033
|
+
</details>
|
|
1034
|
+
|
|
1035
|
+
<details><summary><code>client.parseRuns.<a href="/src/api/resources/parseRuns/client/Client.ts">cancel</a>(id, { ...params }) -> Extend.ParseRun</code></summary>
|
|
1036
|
+
<dl>
|
|
1037
|
+
<dd>
|
|
1038
|
+
|
|
1039
|
+
#### 📝 Description
|
|
1040
|
+
|
|
1041
|
+
<dl>
|
|
1042
|
+
<dd>
|
|
1043
|
+
|
|
1044
|
+
<dl>
|
|
1045
|
+
<dd>
|
|
1046
|
+
|
|
1047
|
+
Cancel an in-progress parse run.
|
|
1048
|
+
|
|
1049
|
+
Note: Only parse runs with a status of `"PROCESSING"` can be cancelled. Parse runs that have already completed, failed, or been cancelled cannot be cancelled again.
|
|
1050
|
+
</dd>
|
|
1051
|
+
</dl>
|
|
1052
|
+
</dd>
|
|
1053
|
+
</dl>
|
|
1054
|
+
|
|
1055
|
+
#### 🔌 Usage
|
|
1056
|
+
|
|
1057
|
+
<dl>
|
|
1058
|
+
<dd>
|
|
1059
|
+
|
|
1060
|
+
<dl>
|
|
1061
|
+
<dd>
|
|
1062
|
+
|
|
1063
|
+
```typescript
|
|
1064
|
+
await client.parseRuns.cancel("parse_run_id_here");
|
|
1065
|
+
|
|
1066
|
+
```
|
|
1067
|
+
</dd>
|
|
1068
|
+
</dl>
|
|
1069
|
+
</dd>
|
|
1070
|
+
</dl>
|
|
1071
|
+
|
|
1072
|
+
#### ⚙️ Parameters
|
|
1073
|
+
|
|
1074
|
+
<dl>
|
|
1075
|
+
<dd>
|
|
1076
|
+
|
|
1077
|
+
<dl>
|
|
1078
|
+
<dd>
|
|
1079
|
+
|
|
1080
|
+
**id:** `string`
|
|
1081
|
+
|
|
1082
|
+
The ID of the parse run to cancel.
|
|
1083
|
+
|
|
1084
|
+
Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
1085
|
+
|
|
1086
|
+
</dd>
|
|
1087
|
+
</dl>
|
|
1088
|
+
|
|
1089
|
+
<dl>
|
|
1090
|
+
<dd>
|
|
1091
|
+
|
|
1092
|
+
**request:** `Extend.ParseRunsCancelRequest`
|
|
1093
|
+
|
|
1094
|
+
</dd>
|
|
1095
|
+
</dl>
|
|
1096
|
+
|
|
1097
|
+
<dl>
|
|
1098
|
+
<dd>
|
|
1099
|
+
|
|
1100
|
+
**requestOptions:** `ParseRunsClient.RequestOptions`
|
|
1101
|
+
|
|
1102
|
+
</dd>
|
|
1103
|
+
</dl>
|
|
1104
|
+
</dd>
|
|
1105
|
+
</dl>
|
|
1106
|
+
|
|
1107
|
+
|
|
1012
1108
|
</dd>
|
|
1013
1109
|
</dl>
|
|
1014
1110
|
</details>
|
|
@@ -1027,7 +1123,7 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1027
1123
|
|
|
1028
1124
|
Submit up to **1,000 files** for parsing in a single request. Each file is processed as an independent parse run using the same configuration.
|
|
1029
1125
|
|
|
1030
|
-
Unlike the single [Parse File (Async)](https://docs.extend.ai/2026-02-09/
|
|
1126
|
+
Unlike the single [Parse File (Async)](https://docs.extend.ai/2026-02-09/api-reference/endpoints/parse/create-parse-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
1031
1127
|
|
|
1032
1128
|
**Monitoring results:**
|
|
1033
1129
|
- **Webhooks (recommended):** Subscribe to `batch_parse_run.processed` and `batch_parse_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /parse_runs?batchId={id}`.
|
|
@@ -1201,7 +1297,7 @@ await client.editRuns.create({
|
|
|
1201
1297
|
|
|
1202
1298
|
Retrieve the status and results of an edit run.
|
|
1203
1299
|
|
|
1204
|
-
Use this endpoint to get results for an edit run that has already completed, or to check on the status of an edit run initiated via the [Create Edit Run](https://docs.extend.ai/2026-02-09/
|
|
1300
|
+
Use this endpoint to get results for an edit run that has already completed, or to check on the status of an edit run initiated via the [Create Edit Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/edit/create-edit-run) endpoint.
|
|
1205
1301
|
</dd>
|
|
1206
1302
|
</dl>
|
|
1207
1303
|
</dd>
|
|
@@ -1438,7 +1534,7 @@ Use this endpoint when you want Extend to bootstrap an `EditRootJSON` schema fro
|
|
|
1438
1534
|
|
|
1439
1535
|
This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
|
|
1440
1536
|
|
|
1441
|
-
For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/
|
|
1537
|
+
For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/editing/generate-edit-schema) and the [Edit File guide](https://docs.extend.ai/2026-02-09/editing/edit).
|
|
1442
1538
|
</dd>
|
|
1443
1539
|
</dl>
|
|
1444
1540
|
</dd>
|
|
@@ -1653,7 +1749,7 @@ await client.extractRuns.create({
|
|
|
1653
1749
|
|
|
1654
1750
|
Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.
|
|
1655
1751
|
|
|
1656
|
-
A common use case for this endpoint is to poll for the status and final output of an extract run when using the [Create Extract Run](https://docs.extend.ai/2026-02-09/
|
|
1752
|
+
A common use case for this endpoint is to poll for the status and final output of an extract run when using the [Create Extract Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/extract/create-extract-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
1657
1753
|
</dd>
|
|
1658
1754
|
</dl>
|
|
1659
1755
|
</dd>
|
|
@@ -1880,7 +1976,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1880
1976
|
|
|
1881
1977
|
Submit up to **1,000 files** for extraction in a single request. Each file is processed as an independent extract run using the same extractor and configuration.
|
|
1882
1978
|
|
|
1883
|
-
Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/
|
|
1979
|
+
Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/api-reference/endpoints/extract/create-extract-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
1884
1980
|
|
|
1885
1981
|
**Monitoring results:**
|
|
1886
1982
|
- **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /extract_runs?batchId={id}`.
|
|
@@ -2084,11 +2180,27 @@ await client.extractors.create({
|
|
|
2084
2180
|
"description": "The invoice number"
|
|
2085
2181
|
},
|
|
2086
2182
|
"total_amount": {
|
|
2087
|
-
"type":
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2183
|
+
"type": "object",
|
|
2184
|
+
"extend:type": "currency",
|
|
2185
|
+
"description": "The total amount due",
|
|
2186
|
+
"properties": {
|
|
2187
|
+
"amount": {
|
|
2188
|
+
"type": [
|
|
2189
|
+
"number",
|
|
2190
|
+
"null"
|
|
2191
|
+
]
|
|
2192
|
+
},
|
|
2193
|
+
"iso_4217_currency_code": {
|
|
2194
|
+
"type": [
|
|
2195
|
+
"string",
|
|
2196
|
+
"null"
|
|
2197
|
+
]
|
|
2198
|
+
}
|
|
2199
|
+
},
|
|
2200
|
+
"required": [
|
|
2201
|
+
"amount",
|
|
2202
|
+
"iso_4217_currency_code"
|
|
2203
|
+
]
|
|
2092
2204
|
}
|
|
2093
2205
|
}
|
|
2094
2206
|
}
|
|
@@ -2685,7 +2797,7 @@ await client.classifyRuns.create({
|
|
|
2685
2797
|
|
|
2686
2798
|
Retrieve details about a specific classify run, including its status and outputs.
|
|
2687
2799
|
|
|
2688
|
-
A common use case for this endpoint is to poll for the status and final output of a classify run when using the [Create Classify Run](https://docs.extend.ai/2026-02-09/
|
|
2800
|
+
A common use case for this endpoint is to poll for the status and final output of a classify run when using the [Create Classify Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/classify/create-classify-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
2689
2801
|
</dd>
|
|
2690
2802
|
</dl>
|
|
2691
2803
|
</dd>
|
|
@@ -2912,7 +3024,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2912
3024
|
|
|
2913
3025
|
Submit up to **1,000 files** for classification in a single request. Each file is processed as an independent classify run using the same classifier and configuration.
|
|
2914
3026
|
|
|
2915
|
-
Unlike the single [Classify File (Async)](https://docs.extend.ai/2026-02-09/
|
|
3027
|
+
Unlike the single [Classify File (Async)](https://docs.extend.ai/2026-02-09/api-reference/endpoints/classify/create-classify-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
2916
3028
|
|
|
2917
3029
|
**Monitoring results:**
|
|
2918
3030
|
- **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /classify_runs?batchId={id}`.
|
|
@@ -3702,7 +3814,7 @@ await client.splitRuns.create({
|
|
|
3702
3814
|
|
|
3703
3815
|
Retrieve details about a specific split run, including its status and outputs.
|
|
3704
3816
|
|
|
3705
|
-
A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/
|
|
3817
|
+
A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
3706
3818
|
</dd>
|
|
3707
3819
|
</dl>
|
|
3708
3820
|
</dd>
|
|
@@ -3929,7 +4041,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3929
4041
|
|
|
3930
4042
|
Submit up to **1,000 files** for splitting in a single request. Each file is processed as an independent split run using the same splitter and configuration.
|
|
3931
4043
|
|
|
3932
|
-
Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/
|
|
4044
|
+
Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
3933
4045
|
|
|
3934
4046
|
**Monitoring results:**
|
|
3935
4047
|
- **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /split_runs?batchId={id}`.
|
|
@@ -5528,17 +5640,17 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
5528
5640
|
|
|
5529
5641
|
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.
|
|
5530
5642
|
|
|
5531
|
-
Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/
|
|
5643
|
+
Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/create-workflow-run) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
|
|
5532
5644
|
|
|
5533
|
-
Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
5645
|
+
Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/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/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/api-reference/endpoints/workflow/get-workflow-run) to fetch the full outputs each run.
|
|
5534
5646
|
|
|
5535
|
-
**Priority:**
|
|
5647
|
+
**Priority:** By default, workflow runs created through this batch endpoint are assigned a priority of 90. You can override this by passing an optional `priority` value (1–100) in the request body — lower values run first.
|
|
5536
5648
|
|
|
5537
5649
|
**Processing and Monitoring:**
|
|
5538
5650
|
Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
|
|
5539
5651
|
|
|
5540
|
-
- **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
5541
|
-
- **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/
|
|
5652
|
+
- **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration). Subscribe to events like `workflow_run.completed`, `workflow_run.failed`, etc. The webhook payload for these events will include the corresponding `batchId` and the `metadata` you provided for each input.
|
|
5653
|
+
- **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/list-workflow-runs) endpoint and filter using the `batchId` query param.
|
|
5542
5654
|
</dd>
|
|
5543
5655
|
</dl>
|
|
5544
5656
|
</dd>
|
|
@@ -5693,8 +5805,8 @@ Run processors (extraction, classification, splitting, etc.) on a given document
|
|
|
5693
5805
|
- **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
|
|
5694
5806
|
|
|
5695
5807
|
**For asynchronous processing:**
|
|
5696
|
-
- You can [configure webhooks](https://docs.extend.ai/2026-02-09/
|
|
5697
|
-
- Or you can [poll the get endpoint](https://docs.extend.ai/2026-02-09/
|
|
5808
|
+
- You can [configure webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
5809
|
+
- Or you can [poll the get endpoint](https://docs.extend.ai/2026-02-09/api-reference/endpoints/legacy/get-processor-run) for updates on the status of the processor run.
|
|
5698
5810
|
</dd>
|
|
5699
5811
|
</dl>
|
|
5700
5812
|
</dd>
|
|
@@ -5761,7 +5873,7 @@ await client.processorRun.create({
|
|
|
5761
5873
|
|
|
5762
5874
|
Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
|
|
5763
5875
|
|
|
5764
|
-
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/
|
|
5876
|
+
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/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.
|
|
5765
5877
|
</dd>
|
|
5766
5878
|
</dl>
|
|
5767
5879
|
</dd>
|
|
@@ -6443,7 +6555,7 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
6443
6555
|
|
|
6444
6556
|
Retrieve details about a batch processor run, including evaluation runs.
|
|
6445
6557
|
|
|
6446
|
-
**Deprecated:** This endpoint is maintained for backwards compatibility only and will be replaced in a future API version. Use [Get Evaluation Set Run](https://docs.extend.ai/2026-02-09/
|
|
6558
|
+
**Deprecated:** This endpoint is maintained for backwards compatibility only and will be replaced in a future API version. Use [Get Evaluation Set Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/evaluation/get-evaluation-set-run) for interacting with evaluation set runs.
|
|
6447
6559
|
</dd>
|
|
6448
6560
|
</dl>
|
|
6449
6561
|
</dd>
|
|
@@ -6669,9 +6781,9 @@ await client.evaluationSets.list({
|
|
|
6669
6781
|
<dl>
|
|
6670
6782
|
<dd>
|
|
6671
6783
|
|
|
6672
|
-
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/
|
|
6784
|
+
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/api-reference/endpoints/evaluation/create-evaluation-set-item) endpoint.
|
|
6673
6785
|
|
|
6674
|
-
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/
|
|
6786
|
+
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/evaluation/overview) product page.
|
|
6675
6787
|
</dd>
|
|
6676
6788
|
</dl>
|
|
6677
6789
|
</dd>
|
|
@@ -6738,7 +6850,7 @@ await client.evaluationSets.create({
|
|
|
6738
6850
|
<dl>
|
|
6739
6851
|
<dd>
|
|
6740
6852
|
|
|
6741
|
-
Retrieve a specific evaluation set by ID. This returns an evaluation set object, but does not include the items in the evaluation set. You can use the [List Evaluation Set Items](https://docs.extend.ai/2026-02-09/
|
|
6853
|
+
Retrieve a specific evaluation set by ID. This returns an evaluation set object, but does not include the items in the evaluation set. You can use the [List Evaluation Set Items](https://docs.extend.ai/2026-02-09/api-reference/endpoints/evaluation/list-evaluation-set-items) endpoint to get the items in an evaluation set.
|
|
6742
6854
|
</dd>
|
|
6743
6855
|
</dl>
|
|
6744
6856
|
</dd>
|
|
@@ -6816,7 +6928,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
|
6816
6928
|
|
|
6817
6929
|
List items in a specific evaluation set.
|
|
6818
6930
|
|
|
6819
|
-
Returns a summary of each evaluation set item. Use the [Get Evaluation Set Item](https://docs.extend.ai/2026-02-09/
|
|
6931
|
+
Returns a summary of each evaluation set item. Use the [Get Evaluation Set Item](https://docs.extend.ai/2026-02-09/api-reference/endpoints/evaluation/get-evaluation-set-item) endpoint to get the full details of an evaluation set item.
|
|
6820
6932
|
</dd>
|
|
6821
6933
|
</dl>
|
|
6822
6934
|
</dd>
|
|
@@ -6897,7 +7009,7 @@ Evaluation set items are the individual files and expected outputs that are used
|
|
|
6897
7009
|
|
|
6898
7010
|
**Limit:** You can create up to 100 items at a time.
|
|
6899
7011
|
|
|
6900
|
-
Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/
|
|
7012
|
+
Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/evaluation/overview) product page.
|
|
6901
7013
|
</dd>
|
|
6902
7014
|
</dl>
|
|
6903
7015
|
</dd>
|
|
@@ -7339,7 +7451,7 @@ Get details of an evaluation set run.
|
|
|
7339
7451
|
<dd>
|
|
7340
7452
|
|
|
7341
7453
|
```typescript
|
|
7342
|
-
await client.evaluationSetRuns.retrieve("
|
|
7454
|
+
await client.evaluationSetRuns.retrieve("bpr_Xj8mK2pL9nR4vT7qY5wZ");
|
|
7343
7455
|
|
|
7344
7456
|
```
|
|
7345
7457
|
</dd>
|
|
@@ -7359,7 +7471,7 @@ await client.evaluationSetRuns.retrieve("evaluation_set_run_id_here");
|
|
|
7359
7471
|
|
|
7360
7472
|
The ID of the evaluation set run.
|
|
7361
7473
|
|
|
7362
|
-
Example: `"
|
|
7474
|
+
Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
7363
7475
|
|
|
7364
7476
|
</dd>
|
|
7365
7477
|
</dl>
|
|
@@ -7467,9 +7579,9 @@ await client.webhookEndpoints.list({
|
|
|
7467
7579
|
|
|
7468
7580
|
Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
|
|
7469
7581
|
|
|
7470
|
-
The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/
|
|
7582
|
+
The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/api-reference/webhook-events) reference to see available event types.
|
|
7471
7583
|
|
|
7472
|
-
To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/
|
|
7584
|
+
To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/api-reference/endpoints/webhook/create-webhook-subscription) after creating the endpoint.
|
|
7473
7585
|
</dd>
|
|
7474
7586
|
</dl>
|
|
7475
7587
|
</dd>
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.14.0";
|
package/version.js
CHANGED
|
@@ -34,7 +34,7 @@ function createMockParseRun(overrides = {}) {
|
|
|
34
34
|
metadata: {},
|
|
35
35
|
createdAt: "2024-01-01T00:00:00Z",
|
|
36
36
|
updatedAt: "2024-01-01T00:00:00Z",
|
|
37
|
-
}, failureReason: null, failureMessage: null, output: null, outputUrl: null, metrics: null, usage: null }, overrides);
|
|
37
|
+
}, failureReason: null, failureMessage: null, metadata: null, output: null, outputUrl: null, metrics: null, usage: null }, overrides);
|
|
38
38
|
}
|
|
39
39
|
// ============================================================================
|
|
40
40
|
// Tests
|