extend-ai 1.11.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/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 +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/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 +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 +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/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 +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 +4 -4
- 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 +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 +1 -0
- package/api/types/index.js +1 -0
- package/auth/BearerAuthProvider.d.ts +1 -1
- package/auth/BearerAuthProvider.js +6 -3
- package/package.json +2 -1
- package/reference.md +81 -46
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface EditRunsRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace EditSchemasClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class EditSchemasClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<EditSchemasClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: EditSchemasClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* Detect fields in a PDF form and synchronously return an edit schema payload.
|
|
15
15
|
*
|
|
@@ -17,7 +17,7 @@ export declare class EditSchemasClient {
|
|
|
17
17
|
*
|
|
18
18
|
* This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
|
|
19
19
|
*
|
|
20
|
-
* For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/
|
|
20
|
+
* 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).
|
|
21
21
|
*
|
|
22
22
|
* @param {Extend.EditSchemasGenerateRequest} request
|
|
23
23
|
* @param {EditSchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class EditSchemasClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -62,7 +62,7 @@ class EditSchemasClient {
|
|
|
62
62
|
*
|
|
63
63
|
* This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
|
|
64
64
|
*
|
|
65
|
-
* For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/
|
|
65
|
+
* 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).
|
|
66
66
|
*
|
|
67
67
|
* @param {Extend.EditSchemasGenerateRequest} request
|
|
68
68
|
* @param {EditSchemasClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9,7 +9,7 @@ export declare namespace EditTemplatesClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class EditTemplatesClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<EditTemplatesClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: EditTemplatesClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* Retrieve a saved edit template by ID.
|
|
15
15
|
*
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class EditTemplatesClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface EditTemplatesRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,11 +9,11 @@ export declare namespace EvaluationSetItemsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class EvaluationSetItemsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<EvaluationSetItemsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: EvaluationSetItemsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List items in a specific evaluation set.
|
|
15
15
|
*
|
|
16
|
-
* Returns a summary of each evaluation set item. Use the [Get Evaluation Set Item](https://docs.extend.ai/2026-02-09/
|
|
16
|
+
* 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.
|
|
17
17
|
*
|
|
18
18
|
* @param {string} evaluationSetId - The ID of the evaluation set.
|
|
19
19
|
*
|
|
@@ -42,7 +42,7 @@ export declare class EvaluationSetItemsClient {
|
|
|
42
42
|
*
|
|
43
43
|
* **Limit:** You can create up to 100 items at a time.
|
|
44
44
|
*
|
|
45
|
-
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/
|
|
45
|
+
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/evaluation/overview) product page.
|
|
46
46
|
*
|
|
47
47
|
* @param {string} evaluationSetId - The ID of the evaluation set.
|
|
48
48
|
*
|
|
@@ -63,13 +63,13 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class EvaluationSetItemsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
70
|
* List items in a specific evaluation set.
|
|
71
71
|
*
|
|
72
|
-
* Returns a summary of each evaluation set item. Use the [Get Evaluation Set Item](https://docs.extend.ai/2026-02-09/
|
|
72
|
+
* 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.
|
|
73
73
|
*
|
|
74
74
|
* @param {string} evaluationSetId - The ID of the evaluation set.
|
|
75
75
|
*
|
|
@@ -160,7 +160,7 @@ class EvaluationSetItemsClient {
|
|
|
160
160
|
*
|
|
161
161
|
* **Limit:** You can create up to 100 items at a time.
|
|
162
162
|
*
|
|
163
|
-
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/
|
|
163
|
+
* Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/evaluation/overview) product page.
|
|
164
164
|
*
|
|
165
165
|
* @param {string} evaluationSetId - The ID of the evaluation set.
|
|
166
166
|
*
|
package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ import type * as Extend from "../../../../index";
|
|
|
15
15
|
* }
|
|
16
16
|
*/
|
|
17
17
|
export interface EvaluationSetItemsCreateRequest {
|
|
18
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
18
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
19
19
|
"x-extend-workspace-id"?: string;
|
|
20
20
|
/** An array of objects representing the evaluation set items to create. */
|
|
21
21
|
items: Extend.EvaluationSetItemsCreateRequestItemsItem[];
|
package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.d.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface EvaluationSetItemsDeleteRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -10,6 +10,6 @@ export interface EvaluationSetItemsListRequest {
|
|
|
10
10
|
sortDir?: Extend.SortDir;
|
|
11
11
|
nextPageToken?: Extend.NextPageToken;
|
|
12
12
|
maxPageSize?: Extend.MaxPageSize;
|
|
13
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
13
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
14
14
|
"x-extend-workspace-id"?: string;
|
|
15
15
|
}
|
package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.d.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface EvaluationSetItemsRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ import type * as Extend from "../../../../index";
|
|
|
12
12
|
* }
|
|
13
13
|
*/
|
|
14
14
|
export interface EvaluationSetItemsUpdateRequest {
|
|
15
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
15
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
16
16
|
"x-extend-workspace-id"?: string;
|
|
17
17
|
/** The expected output of the extractor, classifier, or splitter when run against the file. This must conform to the output schema of the entity associated with the evaluation set. */
|
|
18
18
|
expectedOutput: Extend.ProvidedProcessorOutput;
|
|
@@ -9,7 +9,7 @@ export declare namespace EvaluationSetRunsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class EvaluationSetRunsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<EvaluationSetRunsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: EvaluationSetRunsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* 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.
|
|
15
15
|
*
|
|
@@ -49,7 +49,7 @@ export declare class EvaluationSetRunsClient {
|
|
|
49
49
|
*
|
|
50
50
|
* @param {string} id - The ID of the evaluation set run.
|
|
51
51
|
*
|
|
52
|
-
* Example: `"
|
|
52
|
+
* Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
53
53
|
* @param {Extend.EvaluationSetRunsRetrieveRequest} request
|
|
54
54
|
* @param {EvaluationSetRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
55
|
*
|
|
@@ -63,7 +63,7 @@ export declare class EvaluationSetRunsClient {
|
|
|
63
63
|
* @throws {@link Extend.InternalServerError}
|
|
64
64
|
*
|
|
65
65
|
* @example
|
|
66
|
-
* await client.evaluationSetRuns.retrieve("
|
|
66
|
+
* await client.evaluationSetRuns.retrieve("bpr_Xj8mK2pL9nR4vT7qY5wZ")
|
|
67
67
|
*/
|
|
68
68
|
retrieve(id: string, request?: Extend.EvaluationSetRunsRetrieveRequest, requestOptions?: EvaluationSetRunsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSetRun>;
|
|
69
69
|
private __retrieve;
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class EvaluationSetRunsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -161,7 +161,7 @@ class EvaluationSetRunsClient {
|
|
|
161
161
|
*
|
|
162
162
|
* @param {string} id - The ID of the evaluation set run.
|
|
163
163
|
*
|
|
164
|
-
* Example: `"
|
|
164
|
+
* Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
165
165
|
* @param {Extend.EvaluationSetRunsRetrieveRequest} request
|
|
166
166
|
* @param {EvaluationSetRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
167
167
|
*
|
|
@@ -175,7 +175,7 @@ class EvaluationSetRunsClient {
|
|
|
175
175
|
* @throws {@link Extend.InternalServerError}
|
|
176
176
|
*
|
|
177
177
|
* @example
|
|
178
|
-
* await client.evaluationSetRuns.retrieve("
|
|
178
|
+
* await client.evaluationSetRuns.retrieve("bpr_Xj8mK2pL9nR4vT7qY5wZ")
|
|
179
179
|
*/
|
|
180
180
|
retrieve(id, request = {}, requestOptions) {
|
|
181
181
|
return core.HttpResponsePromise.fromPromise(this.__retrieve(id, request, requestOptions));
|
|
@@ -16,7 +16,7 @@ import type * as Extend from "../../../../index";
|
|
|
16
16
|
* }
|
|
17
17
|
*/
|
|
18
18
|
export interface EvaluationSetRunsCreateRequest {
|
|
19
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
19
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
20
20
|
"x-extend-workspace-id"?: string;
|
|
21
21
|
/** The ID of the evaluation set to run. */
|
|
22
22
|
evaluationSetId: string;
|
package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface EvaluationSetRunsRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace EvaluationSetsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class EvaluationSetsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<EvaluationSetsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: EvaluationSetsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List evaluation sets in your account.
|
|
15
15
|
*
|
|
@@ -34,9 +34,9 @@ export declare class EvaluationSetsClient {
|
|
|
34
34
|
list(request?: Extend.EvaluationSetsListRequest, requestOptions?: EvaluationSetsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSetsListResponse>;
|
|
35
35
|
private __list;
|
|
36
36
|
/**
|
|
37
|
-
* Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given extractor, classifier, or splitter. This endpoint will create a new evaluation set, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2026-02-09/
|
|
37
|
+
* Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given extractor, classifier, or splitter. This endpoint will create a new evaluation set, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2026-02-09/api-reference/endpoints/evaluation/create-evaluation-set-item) endpoint.
|
|
38
38
|
*
|
|
39
|
-
* Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/2026-02-09/
|
|
39
|
+
* Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/2026-02-09/evaluation/overview) product page.
|
|
40
40
|
*
|
|
41
41
|
* @param {Extend.EvaluationSetsCreateRequest} request
|
|
42
42
|
* @param {EvaluationSetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -60,7 +60,7 @@ export declare class EvaluationSetsClient {
|
|
|
60
60
|
create(request: Extend.EvaluationSetsCreateRequest, requestOptions?: EvaluationSetsClient.RequestOptions): core.HttpResponsePromise<Extend.EvaluationSet>;
|
|
61
61
|
private __create;
|
|
62
62
|
/**
|
|
63
|
-
* 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/
|
|
63
|
+
* 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.
|
|
64
64
|
*
|
|
65
65
|
* @param {string} id - The ID of the evaluation set.
|
|
66
66
|
*
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class EvaluationSetsClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -139,9 +139,9 @@ class EvaluationSetsClient {
|
|
|
139
139
|
});
|
|
140
140
|
}
|
|
141
141
|
/**
|
|
142
|
-
* 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/
|
|
142
|
+
* 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.
|
|
143
143
|
*
|
|
144
|
-
* 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/
|
|
144
|
+
* 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.
|
|
145
145
|
*
|
|
146
146
|
* @param {Extend.EvaluationSetsCreateRequest} request
|
|
147
147
|
* @param {EvaluationSetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -217,7 +217,7 @@ class EvaluationSetsClient {
|
|
|
217
217
|
});
|
|
218
218
|
}
|
|
219
219
|
/**
|
|
220
|
-
* 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/
|
|
220
|
+
* 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.
|
|
221
221
|
*
|
|
222
222
|
* @param {string} id - The ID of the evaluation set.
|
|
223
223
|
*
|
|
@@ -17,6 +17,6 @@ export interface EvaluationSetsListRequest {
|
|
|
17
17
|
sortDir?: Extend.SortDir;
|
|
18
18
|
nextPageToken?: Extend.NextPageToken;
|
|
19
19
|
maxPageSize?: Extend.MaxPageSize;
|
|
20
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
20
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
21
21
|
"x-extend-workspace-id"?: string;
|
|
22
22
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface EvaluationSetsRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace ExtractRunsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class ExtractRunsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ExtractRunsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: ExtractRunsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all extract runs.
|
|
15
15
|
*
|
|
@@ -66,7 +66,7 @@ export declare class ExtractRunsClient {
|
|
|
66
66
|
/**
|
|
67
67
|
* Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.
|
|
68
68
|
*
|
|
69
|
-
* 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/
|
|
69
|
+
* 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.
|
|
70
70
|
*
|
|
71
71
|
* @param {string} id - The unique identifier for this extract run.
|
|
72
72
|
*
|
|
@@ -139,7 +139,7 @@ export declare class ExtractRunsClient {
|
|
|
139
139
|
/**
|
|
140
140
|
* 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.
|
|
141
141
|
*
|
|
142
|
-
* Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/
|
|
142
|
+
* 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.
|
|
143
143
|
*
|
|
144
144
|
* **Monitoring results:**
|
|
145
145
|
* - **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}`.
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class ExtractRunsClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -228,7 +228,7 @@ class ExtractRunsClient {
|
|
|
228
228
|
/**
|
|
229
229
|
* Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.
|
|
230
230
|
*
|
|
231
|
-
* 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/
|
|
231
|
+
* 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.
|
|
232
232
|
*
|
|
233
233
|
* @param {string} id - The unique identifier for this extract run.
|
|
234
234
|
*
|
|
@@ -460,7 +460,7 @@ class ExtractRunsClient {
|
|
|
460
460
|
/**
|
|
461
461
|
* 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.
|
|
462
462
|
*
|
|
463
|
-
* Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/
|
|
463
|
+
* 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.
|
|
464
464
|
*
|
|
465
465
|
* **Monitoring results:**
|
|
466
466
|
* - **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}`.
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface ExtractRunsCancelRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface ExtractRunsDeleteRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -33,6 +33,6 @@ export interface ExtractRunsListRequest {
|
|
|
33
33
|
sortDir?: Extend.SortDir;
|
|
34
34
|
nextPageToken?: Extend.NextPageToken;
|
|
35
35
|
maxPageSize?: Extend.MaxPageSize;
|
|
36
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
36
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
37
37
|
"x-extend-workspace-id"?: string;
|
|
38
38
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface ExtractRunsRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace ExtractorVersionsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class ExtractorVersionsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ExtractorVersionsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: ExtractorVersionsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* This endpoint allows you to fetch all versions of a given extractor, including the current `draft` version.
|
|
15
15
|
*
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class ExtractorVersionsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -7,7 +7,7 @@ import type * as Extend from "../../../../index";
|
|
|
7
7
|
* }
|
|
8
8
|
*/
|
|
9
9
|
export interface ExtractorVersionsCreateRequest {
|
|
10
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
10
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
11
11
|
"x-extend-workspace-id"?: string;
|
|
12
12
|
releaseType: Extend.ReleaseType;
|
|
13
13
|
description?: Extend.VersionDescription;
|
|
@@ -9,6 +9,6 @@ export interface ExtractorVersionsListRequest {
|
|
|
9
9
|
sortDir?: Extend.SortDir;
|
|
10
10
|
nextPageToken?: Extend.NextPageToken;
|
|
11
11
|
maxPageSize?: Extend.MaxPageSize;
|
|
12
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
12
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
13
13
|
"x-extend-workspace-id"?: string;
|
|
14
14
|
}
|
package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.d.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface ExtractorVersionsRetrieveRequest {
|
|
6
|
-
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
/** The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace ExtractorsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class ExtractorsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<ExtractorsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: ExtractorsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all extractors.
|
|
15
15
|
*
|
|
@@ -73,11 +73,27 @@ export declare class ExtractorsClient {
|
|
|
73
73
|
* "description": "The invoice number"
|
|
74
74
|
* },
|
|
75
75
|
* "total_amount": {
|
|
76
|
-
* "type":
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
76
|
+
* "type": "object",
|
|
77
|
+
* "extend:type": "currency",
|
|
78
|
+
* "description": "The total amount due",
|
|
79
|
+
* "properties": {
|
|
80
|
+
* "amount": {
|
|
81
|
+
* "type": [
|
|
82
|
+
* "number",
|
|
83
|
+
* "null"
|
|
84
|
+
* ]
|
|
85
|
+
* },
|
|
86
|
+
* "iso_4217_currency_code": {
|
|
87
|
+
* "type": [
|
|
88
|
+
* "string",
|
|
89
|
+
* "null"
|
|
90
|
+
* ]
|
|
91
|
+
* }
|
|
92
|
+
* },
|
|
93
|
+
* "required": [
|
|
94
|
+
* "amount",
|
|
95
|
+
* "iso_4217_currency_code"
|
|
96
|
+
* ]
|
|
81
97
|
* }
|
|
82
98
|
* }
|
|
83
99
|
* }
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class ExtractorsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -188,11 +188,27 @@ class ExtractorsClient {
|
|
|
188
188
|
* "description": "The invoice number"
|
|
189
189
|
* },
|
|
190
190
|
* "total_amount": {
|
|
191
|
-
* "type":
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
191
|
+
* "type": "object",
|
|
192
|
+
* "extend:type": "currency",
|
|
193
|
+
* "description": "The total amount due",
|
|
194
|
+
* "properties": {
|
|
195
|
+
* "amount": {
|
|
196
|
+
* "type": [
|
|
197
|
+
* "number",
|
|
198
|
+
* "null"
|
|
199
|
+
* ]
|
|
200
|
+
* },
|
|
201
|
+
* "iso_4217_currency_code": {
|
|
202
|
+
* "type": [
|
|
203
|
+
* "string",
|
|
204
|
+
* "null"
|
|
205
|
+
* ]
|
|
206
|
+
* }
|
|
207
|
+
* },
|
|
208
|
+
* "required": [
|
|
209
|
+
* "amount",
|
|
210
|
+
* "iso_4217_currency_code"
|
|
211
|
+
* ]
|
|
196
212
|
* }
|
|
197
213
|
* }
|
|
198
214
|
* }
|
|
@@ -22,11 +22,27 @@ import type * as Extend from "../../../../index";
|
|
|
22
22
|
* "description": "The invoice number"
|
|
23
23
|
* },
|
|
24
24
|
* "total_amount": {
|
|
25
|
-
* "type":
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
25
|
+
* "type": "object",
|
|
26
|
+
* "extend:type": "currency",
|
|
27
|
+
* "description": "The total amount due",
|
|
28
|
+
* "properties": {
|
|
29
|
+
* "amount": {
|
|
30
|
+
* "type": [
|
|
31
|
+
* "number",
|
|
32
|
+
* "null"
|
|
33
|
+
* ]
|
|
34
|
+
* },
|
|
35
|
+
* "iso_4217_currency_code": {
|
|
36
|
+
* "type": [
|
|
37
|
+
* "string",
|
|
38
|
+
* "null"
|
|
39
|
+
* ]
|
|
40
|
+
* }
|
|
41
|
+
* },
|
|
42
|
+
* "required": [
|
|
43
|
+
* "amount",
|
|
44
|
+
* "iso_4217_currency_code"
|
|
45
|
+
* ]
|
|
30
46
|
* }
|
|
31
47
|
* }
|
|
32
48
|
* }
|