extend-ai 1.10.0 → 1.13.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/.gitattributes +1 -0
- package/BaseClient.js +2 -2
- package/Client.d.ts +32 -13
- package/Client.js +32 -13
- package/LICENSE +21 -0
- package/api/client/requests/ExtractRequest.d.ts +21 -2
- 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 +37 -3
- package/api/resources/evaluationSetRuns/client/Client.js +104 -3
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsCreateRequest.d.ts +27 -0
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsCreateRequest.js +3 -0
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSetRuns/client/requests/index.d.ts +1 -0
- package/api/resources/evaluationSetRuns/index.d.ts +1 -0
- package/api/resources/evaluationSetRuns/index.js +1 -0
- package/api/resources/evaluationSetRuns/types/EvaluationSetRunsCreateRequestEntity.d.ts +9 -0
- package/api/resources/evaluationSetRuns/types/EvaluationSetRunsCreateRequestEntity.js +3 -0
- package/api/resources/evaluationSetRuns/types/index.d.ts +1 -0
- package/api/resources/evaluationSetRuns/types/index.js +17 -0
- 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/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/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 +43 -5
- package/api/resources/extractors/client/Client.js +43 -5
- package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +48 -6
- 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/extractors/types/ExtractorsCreateRequestGenerate.d.ts +12 -0
- package/api/resources/extractors/types/ExtractorsCreateRequestGenerate.js +3 -0
- package/api/resources/extractors/types/ExtractorsCreateRequestGenerateFilesItem.d.ts +2 -0
- package/api/resources/extractors/types/ExtractorsCreateRequestGenerateFilesItem.js +3 -0
- package/api/resources/extractors/types/index.d.ts +2 -0
- package/api/resources/extractors/types/index.js +2 -0
- 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/index.d.ts +1 -0
- package/api/resources/index.js +1 -0
- package/api/resources/parseRuns/client/Client.d.ts +3 -3
- package/api/resources/parseRuns/client/Client.js +3 -3
- 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/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 +5 -5
- package/api/resources/workflowRuns/client/Client.js +5 -5
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.d.ts +1 -1
- 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/ClassifyAdvancedOptions.d.ts +2 -0
- 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 +9 -9
- 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 +10 -3
- package/api/types/ExtractAdvancedOptionsCitationMode.d.ts +12 -0
- package/api/types/ExtractAdvancedOptionsCitationMode.js +15 -0
- 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 +2 -2
- 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/ExtractRun.d.ts +16 -16
- package/api/types/ExtractRunSummary.d.ts +2 -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/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/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/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 +9 -9
- 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/StepRun.d.ts +28 -2
- 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 +2 -0
- package/api/types/index.js +2 -0
- package/auth/BearerAuthProvider.d.ts +1 -1
- package/auth/BearerAuthProvider.js +6 -3
- package/package.json +2 -1
- package/reference.md +162 -45
- package/version.d.ts +1 -1
- package/version.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
171
|
The Extract endpoint allows you to extract structured data from files using an existing extractor or an inline configuration.
|
|
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>
|
|
@@ -1027,7 +1046,7 @@ Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
1027
1046
|
|
|
1028
1047
|
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
1048
|
|
|
1030
|
-
Unlike the single [Parse File (Async)](https://docs.extend.ai/2026-02-09/
|
|
1049
|
+
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
1050
|
|
|
1032
1051
|
**Monitoring results:**
|
|
1033
1052
|
- **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 +1220,7 @@ await client.editRuns.create({
|
|
|
1201
1220
|
|
|
1202
1221
|
Retrieve the status and results of an edit run.
|
|
1203
1222
|
|
|
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/
|
|
1223
|
+
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
1224
|
</dd>
|
|
1206
1225
|
</dl>
|
|
1207
1226
|
</dd>
|
|
@@ -1438,7 +1457,7 @@ Use this endpoint when you want Extend to bootstrap an `EditRootJSON` schema fro
|
|
|
1438
1457
|
|
|
1439
1458
|
This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
|
|
1440
1459
|
|
|
1441
|
-
For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/
|
|
1460
|
+
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
1461
|
</dd>
|
|
1443
1462
|
</dl>
|
|
1444
1463
|
</dd>
|
|
@@ -1653,7 +1672,7 @@ await client.extractRuns.create({
|
|
|
1653
1672
|
|
|
1654
1673
|
Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.
|
|
1655
1674
|
|
|
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/
|
|
1675
|
+
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
1676
|
</dd>
|
|
1658
1677
|
</dl>
|
|
1659
1678
|
</dd>
|
|
@@ -1880,7 +1899,7 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
1880
1899
|
|
|
1881
1900
|
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
1901
|
|
|
1883
|
-
Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/
|
|
1902
|
+
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
1903
|
|
|
1885
1904
|
**Monitoring results:**
|
|
1886
1905
|
- **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}`.
|
|
@@ -2047,6 +2066,8 @@ await client.extractors.list({
|
|
|
2047
2066
|
<dd>
|
|
2048
2067
|
|
|
2049
2068
|
Create a new extractor.
|
|
2069
|
+
|
|
2070
|
+
You can optionally provide a `generate` object to automatically generate an extraction schema from sample documents using AI. `generate` is mutually exclusive with `config` and `cloneExtractorId`.
|
|
2050
2071
|
</dd>
|
|
2051
2072
|
</dl>
|
|
2052
2073
|
</dd>
|
|
@@ -2068,16 +2089,41 @@ await client.extractors.create({
|
|
|
2068
2089
|
"type": "object",
|
|
2069
2090
|
"properties": {
|
|
2070
2091
|
"vendor_name": {
|
|
2071
|
-
"type":
|
|
2092
|
+
"type": [
|
|
2093
|
+
"string",
|
|
2094
|
+
"null"
|
|
2095
|
+
],
|
|
2072
2096
|
"description": "The name of the vendor"
|
|
2073
2097
|
},
|
|
2074
2098
|
"invoice_number": {
|
|
2075
|
-
"type":
|
|
2099
|
+
"type": [
|
|
2100
|
+
"string",
|
|
2101
|
+
"null"
|
|
2102
|
+
],
|
|
2076
2103
|
"description": "The invoice number"
|
|
2077
2104
|
},
|
|
2078
2105
|
"total_amount": {
|
|
2079
|
-
"type": "
|
|
2080
|
-
"
|
|
2106
|
+
"type": "object",
|
|
2107
|
+
"extend:type": "currency",
|
|
2108
|
+
"description": "The total amount due",
|
|
2109
|
+
"properties": {
|
|
2110
|
+
"amount": {
|
|
2111
|
+
"type": [
|
|
2112
|
+
"number",
|
|
2113
|
+
"null"
|
|
2114
|
+
]
|
|
2115
|
+
},
|
|
2116
|
+
"iso_4217_currency_code": {
|
|
2117
|
+
"type": [
|
|
2118
|
+
"string",
|
|
2119
|
+
"null"
|
|
2120
|
+
]
|
|
2121
|
+
}
|
|
2122
|
+
},
|
|
2123
|
+
"required": [
|
|
2124
|
+
"amount",
|
|
2125
|
+
"iso_4217_currency_code"
|
|
2126
|
+
]
|
|
2081
2127
|
}
|
|
2082
2128
|
}
|
|
2083
2129
|
}
|
|
@@ -2674,7 +2720,7 @@ await client.classifyRuns.create({
|
|
|
2674
2720
|
|
|
2675
2721
|
Retrieve details about a specific classify run, including its status and outputs.
|
|
2676
2722
|
|
|
2677
|
-
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/
|
|
2723
|
+
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.
|
|
2678
2724
|
</dd>
|
|
2679
2725
|
</dl>
|
|
2680
2726
|
</dd>
|
|
@@ -2901,7 +2947,7 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
2901
2947
|
|
|
2902
2948
|
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.
|
|
2903
2949
|
|
|
2904
|
-
Unlike the single [Classify File (Async)](https://docs.extend.ai/2026-02-09/
|
|
2950
|
+
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.
|
|
2905
2951
|
|
|
2906
2952
|
**Monitoring results:**
|
|
2907
2953
|
- **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}`.
|
|
@@ -3691,7 +3737,7 @@ await client.splitRuns.create({
|
|
|
3691
3737
|
|
|
3692
3738
|
Retrieve details about a specific split run, including its status and outputs.
|
|
3693
3739
|
|
|
3694
|
-
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/
|
|
3740
|
+
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.
|
|
3695
3741
|
</dd>
|
|
3696
3742
|
</dl>
|
|
3697
3743
|
</dd>
|
|
@@ -3918,7 +3964,7 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
3918
3964
|
|
|
3919
3965
|
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.
|
|
3920
3966
|
|
|
3921
|
-
Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/
|
|
3967
|
+
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.
|
|
3922
3968
|
|
|
3923
3969
|
**Monitoring results:**
|
|
3924
3970
|
- **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}`.
|
|
@@ -5517,17 +5563,17 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
5517
5563
|
|
|
5518
5564
|
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.
|
|
5519
5565
|
|
|
5520
|
-
Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/
|
|
5566
|
+
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`.
|
|
5521
5567
|
|
|
5522
|
-
Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
5568
|
+
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.
|
|
5523
5569
|
|
|
5524
5570
|
**Priority:** All workflow runs created through this batch endpoint are automatically assigned a priority of 90.
|
|
5525
5571
|
|
|
5526
5572
|
**Processing and Monitoring:**
|
|
5527
5573
|
Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
|
|
5528
5574
|
|
|
5529
|
-
- **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
5530
|
-
- **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/
|
|
5575
|
+
- **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.
|
|
5576
|
+
- **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.
|
|
5531
5577
|
</dd>
|
|
5532
5578
|
</dl>
|
|
5533
5579
|
</dd>
|
|
@@ -5682,8 +5728,8 @@ Run processors (extraction, classification, splitting, etc.) on a given document
|
|
|
5682
5728
|
- **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
|
|
5683
5729
|
|
|
5684
5730
|
**For asynchronous processing:**
|
|
5685
|
-
- You can [configure webhooks](https://docs.extend.ai/2026-02-09/
|
|
5686
|
-
- Or you can [poll the get endpoint](https://docs.extend.ai/2026-02-09/
|
|
5731
|
+
- You can [configure webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
5732
|
+
- 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.
|
|
5687
5733
|
</dd>
|
|
5688
5734
|
</dl>
|
|
5689
5735
|
</dd>
|
|
@@ -5750,7 +5796,7 @@ await client.processorRun.create({
|
|
|
5750
5796
|
|
|
5751
5797
|
Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
|
|
5752
5798
|
|
|
5753
|
-
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/
|
|
5799
|
+
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.
|
|
5754
5800
|
</dd>
|
|
5755
5801
|
</dl>
|
|
5756
5802
|
</dd>
|
|
@@ -6432,7 +6478,7 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
6432
6478
|
|
|
6433
6479
|
Retrieve details about a batch processor run, including evaluation runs.
|
|
6434
6480
|
|
|
6435
|
-
**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/
|
|
6481
|
+
**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.
|
|
6436
6482
|
</dd>
|
|
6437
6483
|
</dl>
|
|
6438
6484
|
</dd>
|
|
@@ -6658,9 +6704,9 @@ await client.evaluationSets.list({
|
|
|
6658
6704
|
<dl>
|
|
6659
6705
|
<dd>
|
|
6660
6706
|
|
|
6661
|
-
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/
|
|
6707
|
+
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.
|
|
6662
6708
|
|
|
6663
|
-
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/
|
|
6709
|
+
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.
|
|
6664
6710
|
</dd>
|
|
6665
6711
|
</dl>
|
|
6666
6712
|
</dd>
|
|
@@ -6727,7 +6773,7 @@ await client.evaluationSets.create({
|
|
|
6727
6773
|
<dl>
|
|
6728
6774
|
<dd>
|
|
6729
6775
|
|
|
6730
|
-
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/
|
|
6776
|
+
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.
|
|
6731
6777
|
</dd>
|
|
6732
6778
|
</dl>
|
|
6733
6779
|
</dd>
|
|
@@ -6805,7 +6851,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
|
|
|
6805
6851
|
|
|
6806
6852
|
List items in a specific evaluation set.
|
|
6807
6853
|
|
|
6808
|
-
Returns a summary of each evaluation set item. Use the [Get Evaluation Set Item](https://docs.extend.ai/2026-02-09/
|
|
6854
|
+
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.
|
|
6809
6855
|
</dd>
|
|
6810
6856
|
</dl>
|
|
6811
6857
|
</dd>
|
|
@@ -6886,7 +6932,7 @@ Evaluation set items are the individual files and expected outputs that are used
|
|
|
6886
6932
|
|
|
6887
6933
|
**Limit:** You can create up to 100 items at a time.
|
|
6888
6934
|
|
|
6889
|
-
Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/
|
|
6935
|
+
Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/evaluation/overview) product page.
|
|
6890
6936
|
</dd>
|
|
6891
6937
|
</dl>
|
|
6892
6938
|
</dd>
|
|
@@ -7230,6 +7276,77 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
|
|
|
7230
7276
|
</details>
|
|
7231
7277
|
|
|
7232
7278
|
## EvaluationSetRuns
|
|
7279
|
+
<details><summary><code>client.evaluationSetRuns.<a href="/src/api/resources/evaluationSetRuns/client/Client.ts">create</a>({ ...params }) -> Extend.EvaluationSetRun</code></summary>
|
|
7280
|
+
<dl>
|
|
7281
|
+
<dd>
|
|
7282
|
+
|
|
7283
|
+
#### 📝 Description
|
|
7284
|
+
|
|
7285
|
+
<dl>
|
|
7286
|
+
<dd>
|
|
7287
|
+
|
|
7288
|
+
<dl>
|
|
7289
|
+
<dd>
|
|
7290
|
+
|
|
7291
|
+
Create and start an async evaluation set run. The response returns the evaluation set run object with its initial status; use `GET /evaluation_set_runs/{id}` to poll for completion.
|
|
7292
|
+
|
|
7293
|
+
Evaluation set runs are currently supported for document processor evaluation sets.
|
|
7294
|
+
</dd>
|
|
7295
|
+
</dl>
|
|
7296
|
+
</dd>
|
|
7297
|
+
</dl>
|
|
7298
|
+
|
|
7299
|
+
#### 🔌 Usage
|
|
7300
|
+
|
|
7301
|
+
<dl>
|
|
7302
|
+
<dd>
|
|
7303
|
+
|
|
7304
|
+
<dl>
|
|
7305
|
+
<dd>
|
|
7306
|
+
|
|
7307
|
+
```typescript
|
|
7308
|
+
await client.evaluationSetRuns.create({
|
|
7309
|
+
evaluationSetId: "ev_2LcgeY_mp2T5yPaEuq5Lw",
|
|
7310
|
+
entity: {
|
|
7311
|
+
id: "ex_Xj8mK2pL9nR4vT7qY5wZ",
|
|
7312
|
+
version: "1.0"
|
|
7313
|
+
}
|
|
7314
|
+
});
|
|
7315
|
+
|
|
7316
|
+
```
|
|
7317
|
+
</dd>
|
|
7318
|
+
</dl>
|
|
7319
|
+
</dd>
|
|
7320
|
+
</dl>
|
|
7321
|
+
|
|
7322
|
+
#### ⚙️ Parameters
|
|
7323
|
+
|
|
7324
|
+
<dl>
|
|
7325
|
+
<dd>
|
|
7326
|
+
|
|
7327
|
+
<dl>
|
|
7328
|
+
<dd>
|
|
7329
|
+
|
|
7330
|
+
**request:** `Extend.EvaluationSetRunsCreateRequest`
|
|
7331
|
+
|
|
7332
|
+
</dd>
|
|
7333
|
+
</dl>
|
|
7334
|
+
|
|
7335
|
+
<dl>
|
|
7336
|
+
<dd>
|
|
7337
|
+
|
|
7338
|
+
**requestOptions:** `EvaluationSetRunsClient.RequestOptions`
|
|
7339
|
+
|
|
7340
|
+
</dd>
|
|
7341
|
+
</dl>
|
|
7342
|
+
</dd>
|
|
7343
|
+
</dl>
|
|
7344
|
+
|
|
7345
|
+
|
|
7346
|
+
</dd>
|
|
7347
|
+
</dl>
|
|
7348
|
+
</details>
|
|
7349
|
+
|
|
7233
7350
|
<details><summary><code>client.evaluationSetRuns.<a href="/src/api/resources/evaluationSetRuns/client/Client.ts">retrieve</a>(id, { ...params }) -> Extend.EvaluationSetRun</code></summary>
|
|
7234
7351
|
<dl>
|
|
7235
7352
|
<dd>
|
|
@@ -7257,7 +7374,7 @@ Get details of an evaluation set run.
|
|
|
7257
7374
|
<dd>
|
|
7258
7375
|
|
|
7259
7376
|
```typescript
|
|
7260
|
-
await client.evaluationSetRuns.retrieve("
|
|
7377
|
+
await client.evaluationSetRuns.retrieve("bpr_Xj8mK2pL9nR4vT7qY5wZ");
|
|
7261
7378
|
|
|
7262
7379
|
```
|
|
7263
7380
|
</dd>
|
|
@@ -7277,7 +7394,7 @@ await client.evaluationSetRuns.retrieve("evaluation_set_run_id_here");
|
|
|
7277
7394
|
|
|
7278
7395
|
The ID of the evaluation set run.
|
|
7279
7396
|
|
|
7280
|
-
Example: `"
|
|
7397
|
+
Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
7281
7398
|
|
|
7282
7399
|
</dd>
|
|
7283
7400
|
</dl>
|
|
@@ -7385,9 +7502,9 @@ await client.webhookEndpoints.list({
|
|
|
7385
7502
|
|
|
7386
7503
|
Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
|
|
7387
7504
|
|
|
7388
|
-
The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/
|
|
7505
|
+
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.
|
|
7389
7506
|
|
|
7390
|
-
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/
|
|
7507
|
+
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.
|
|
7391
7508
|
</dd>
|
|
7392
7509
|
</dl>
|
|
7393
7510
|
</dd>
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.13.0";
|
package/version.js
CHANGED