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
|
@@ -4,7 +4,7 @@ export interface ConditionalExtractStepDefinitionConfigRulesItem {
|
|
|
4
4
|
/**
|
|
5
5
|
* The formula that determines when this extractor runs.
|
|
6
6
|
*
|
|
7
|
-
* See the [Conditional Extract step docs](https://docs.extend.ai/2026-02-09/
|
|
7
|
+
* See the [Conditional Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional-extract) and [Formulas](https://docs.extend.ai/2026-02-09/workflows/formulas).
|
|
8
8
|
*/
|
|
9
9
|
formula: string;
|
|
10
10
|
extractor: Extend.ExtractorRef;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* A next entry for `CONDITIONAL` steps. Routes based on which condition branch matched.
|
|
3
3
|
*
|
|
4
|
-
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows) for end-to-end examples.
|
|
5
5
|
*/
|
|
6
6
|
export interface ConditionalNextEntry {
|
|
7
7
|
/** The name of the target step. */
|
|
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* Routes to different next steps based on ordered conditional branches evaluated against upstream step outputs.
|
|
4
4
|
*
|
|
5
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
6
6
|
*/
|
|
7
7
|
export interface ConditionalStepDefinition {
|
|
8
8
|
name: string;
|
|
@@ -10,7 +10,7 @@ export interface ConditionalStepDefinition {
|
|
|
10
10
|
/**
|
|
11
11
|
* Each entry should include a `conditionId` matching a `config.conditions[].id` value.
|
|
12
12
|
*
|
|
13
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
13
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
14
14
|
*/
|
|
15
15
|
next?: Extend.ConditionalNextEntry[];
|
|
16
16
|
}
|
|
@@ -3,7 +3,7 @@ export interface ConditionalStepDefinitionConfig {
|
|
|
3
3
|
/**
|
|
4
4
|
* Ordered conditional branches for this step. Use `IF` for the first branch, `ELSE_IF` for additional branches, and `ELSE` for the fallback branch.
|
|
5
5
|
*
|
|
6
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
7
7
|
*/
|
|
8
8
|
conditions: Extend.ConditionalStepDefinitionConfigConditionsItem[];
|
|
9
9
|
}
|
|
@@ -6,19 +6,19 @@ export interface ConditionalStepDefinitionConfigConditionsItem {
|
|
|
6
6
|
/**
|
|
7
7
|
* The comparison operation for this branch.
|
|
8
8
|
*
|
|
9
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
9
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
10
10
|
*/
|
|
11
11
|
operation?: Extend.ConditionalStepDefinitionConfigConditionsItemOperation;
|
|
12
12
|
/**
|
|
13
13
|
* The left operand expression. This is typically a workflow variable or dynamic expression.
|
|
14
14
|
*
|
|
15
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
15
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
16
16
|
*/
|
|
17
17
|
leftOperand?: string;
|
|
18
18
|
/**
|
|
19
19
|
* The right operand value. This is typically a literal comparison value and is omitted for fallback branches like `ELSE`.
|
|
20
20
|
*
|
|
21
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
21
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
22
22
|
*/
|
|
23
23
|
rightOperand?: string;
|
|
24
24
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* The comparison operation for this branch.
|
|
3
3
|
*
|
|
4
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
5
5
|
*/
|
|
6
6
|
export declare const ConditionalStepDefinitionConfigConditionsItemOperation: {
|
|
7
7
|
readonly Equals: "EQUALS";
|
|
@@ -5,7 +5,7 @@ exports.ConditionalStepDefinitionConfigConditionsItemOperation = void 0;
|
|
|
5
5
|
/**
|
|
6
6
|
* The comparison operation for this branch.
|
|
7
7
|
*
|
|
8
|
-
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/
|
|
8
|
+
* See the [Conditional step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional).
|
|
9
9
|
*/
|
|
10
10
|
exports.ConditionalStepDefinitionConfigConditionsItemOperation = {
|
|
11
11
|
Equals: "EQUALS",
|
|
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* Sends extraction data to an external HTTP endpoint for validation.
|
|
4
4
|
*
|
|
5
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
6
6
|
*/
|
|
7
7
|
export interface ExternalDataValidationStepDefinition {
|
|
8
8
|
name: string;
|
|
@@ -6,13 +6,13 @@ export interface ExternalDataValidationStepDefinitionConfig {
|
|
|
6
6
|
/**
|
|
7
7
|
* HTTP request configuration for the external validation call.
|
|
8
8
|
*
|
|
9
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
9
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
10
10
|
*/
|
|
11
11
|
requestOptions: Extend.ExternalDataValidationStepDefinitionConfigRequestOptions;
|
|
12
12
|
/**
|
|
13
13
|
* Whether to continue or exit the workflow on validation failure. Defaults to `CONTINUE`.
|
|
14
14
|
*
|
|
15
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
15
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
16
16
|
*/
|
|
17
17
|
failureBehavior?: Extend.ExternalDataValidationStepDefinitionConfigFailureBehavior;
|
|
18
18
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Whether to continue or exit the workflow on validation failure. Defaults to `CONTINUE`.
|
|
3
3
|
*
|
|
4
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
5
5
|
*/
|
|
6
6
|
export declare const ExternalDataValidationStepDefinitionConfigFailureBehavior: {
|
|
7
7
|
readonly Continue: "CONTINUE";
|
|
@@ -5,7 +5,7 @@ exports.ExternalDataValidationStepDefinitionConfigFailureBehavior = void 0;
|
|
|
5
5
|
/**
|
|
6
6
|
* Whether to continue or exit the workflow on validation failure. Defaults to `CONTINUE`.
|
|
7
7
|
*
|
|
8
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
8
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
9
9
|
*/
|
|
10
10
|
exports.ExternalDataValidationStepDefinitionConfigFailureBehavior = {
|
|
11
11
|
Continue: "CONTINUE",
|
|
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* HTTP request configuration for the external validation call.
|
|
4
4
|
*
|
|
5
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
6
6
|
*/
|
|
7
7
|
export interface ExternalDataValidationStepDefinitionConfigRequestOptions {
|
|
8
8
|
/** The URL to send the validation request to. */
|
|
@@ -11,13 +11,13 @@ export interface ExternalDataValidationStepDefinitionConfigRequestOptions {
|
|
|
11
11
|
/**
|
|
12
12
|
* Optional HTTP headers to include on the external validation request.
|
|
13
13
|
*
|
|
14
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
14
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
15
15
|
*/
|
|
16
16
|
headers?: Record<string, string>;
|
|
17
17
|
/**
|
|
18
18
|
* Content type of the request body sent to the external endpoint.
|
|
19
19
|
*
|
|
20
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
20
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
21
21
|
*/
|
|
22
22
|
contentType?: Extend.ExternalDataValidationStepDefinitionConfigRequestOptionsContentType;
|
|
23
23
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Content type of the request body sent to the external endpoint.
|
|
3
3
|
*
|
|
4
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
5
5
|
*/
|
|
6
6
|
export declare const ExternalDataValidationStepDefinitionConfigRequestOptionsContentType: {
|
|
7
7
|
readonly ApplicationJson: "application/json";
|
|
@@ -5,7 +5,7 @@ exports.ExternalDataValidationStepDefinitionConfigRequestOptionsContentType = vo
|
|
|
5
5
|
/**
|
|
6
6
|
* Content type of the request body sent to the external endpoint.
|
|
7
7
|
*
|
|
8
|
-
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/
|
|
8
|
+
* See the [External Data Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#external-data-validation).
|
|
9
9
|
*/
|
|
10
10
|
exports.ExternalDataValidationStepDefinitionConfigRequestOptionsContentType = {
|
|
11
11
|
ApplicationJson: "application/json",
|
|
@@ -29,7 +29,7 @@ export interface ExtractAdvancedOptions {
|
|
|
29
29
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
30
30
|
* fields that may need manual review.
|
|
31
31
|
*
|
|
32
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/
|
|
32
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
|
|
33
33
|
*/
|
|
34
34
|
reviewAgent?: Extend.ExtractAdvancedOptionsReviewAgent;
|
|
35
35
|
/** Whether to include the current date as context for the model during extraction. Defaults to `false`. */
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
5
5
|
* fields that may need manual review.
|
|
6
6
|
*
|
|
7
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/
|
|
7
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
|
|
8
8
|
*/
|
|
9
9
|
export interface ExtractAdvancedOptionsReviewAgent {
|
|
10
10
|
/** Whether to enable the review agent. */
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
1
|
+
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
2
2
|
export declare const ExtractBaseProcessor: {
|
|
3
3
|
readonly ExtractionPerformance: "extraction_performance";
|
|
4
4
|
readonly ExtractionLight: "extraction_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.ExtractBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
6
6
|
exports.ExtractBaseProcessor = {
|
|
7
7
|
ExtractionPerformance: "extraction_performance",
|
|
8
8
|
ExtractionLight: "extraction_light",
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface ExtractConfigJson {
|
|
3
3
|
baseProcessor?: Extend.ExtractBaseProcessor;
|
|
4
|
-
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
5
5
|
baseVersion?: string;
|
|
6
6
|
/** Custom rules to guide the extraction process in natural language. */
|
|
7
7
|
extractionRules?: string;
|
|
8
8
|
/**
|
|
9
9
|
* JSON Schema definition of the data to extract.
|
|
10
10
|
*
|
|
11
|
-
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/
|
|
11
|
+
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/extraction/schema) for details and examples of schema configuration.
|
|
12
12
|
*/
|
|
13
13
|
schema: Extend.JsonObject;
|
|
14
14
|
/** Advanced configuration options. */
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface ExtractConfigLegacy {
|
|
3
|
-
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
3
|
+
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
4
4
|
baseProcessor?: Extend.ExtractConfigLegacyBaseProcessor;
|
|
5
|
-
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
6
6
|
baseVersion?: string;
|
|
7
7
|
/** Custom rules to guide the extraction process in natural language. */
|
|
8
8
|
extractionRules?: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
1
|
+
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
2
2
|
export declare const ExtractConfigLegacyBaseProcessor: {
|
|
3
3
|
readonly ExtractionPerformance: "extraction_performance";
|
|
4
4
|
readonly ExtractionLight: "extraction_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.ExtractConfigLegacyBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The base processor to use. For extractors, this can be either `"extraction_performance"` or `"extraction_light"`. Defaults to `"extraction_performance"` if not provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
6
6
|
exports.ExtractConfigLegacyBaseProcessor = {
|
|
7
7
|
ExtractionPerformance: "extraction_performance",
|
|
8
8
|
ExtractionLight: "extraction_light",
|
|
@@ -14,7 +14,7 @@ export interface ExtractOutputMetadataValue {
|
|
|
14
14
|
*
|
|
15
15
|
* These scores will be present when the `reviewAgent.enabled` flag is set to `true` in the processor config.
|
|
16
16
|
* If the review agent is enabled but a score is not returned for a field, this value will be `null`.
|
|
17
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/
|
|
17
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
|
|
18
18
|
*/
|
|
19
19
|
reviewAgentScore?: number | null;
|
|
20
20
|
citations?: Extend.Citation[];
|
|
@@ -5,14 +5,14 @@ import type * as Extend from "../index";
|
|
|
5
5
|
*/
|
|
6
6
|
export interface ExtractOverrideConfigJson {
|
|
7
7
|
baseProcessor?: Extend.ExtractBaseProcessor;
|
|
8
|
-
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
8
|
+
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
9
9
|
baseVersion?: string;
|
|
10
10
|
/** Custom rules to guide the extraction process in natural language. */
|
|
11
11
|
extractionRules?: string;
|
|
12
12
|
/**
|
|
13
13
|
* JSON Schema definition of the data to extract.
|
|
14
14
|
*
|
|
15
|
-
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/
|
|
15
|
+
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/extraction/schema) for details and examples of schema configuration.
|
|
16
16
|
*/
|
|
17
17
|
schema?: Extend.JsonObject;
|
|
18
18
|
/** Advanced configuration options. */
|
|
@@ -15,7 +15,7 @@ export interface ExtractRun {
|
|
|
15
15
|
/**
|
|
16
16
|
* The final output, either reviewed or initial. This is a union of two possible shapes:
|
|
17
17
|
*
|
|
18
|
-
* - **[JSON Schema output](https://docs.extend.ai/2026-02-09/
|
|
18
|
+
* - **[JSON Schema output](https://docs.extend.ai/2026-02-09/extraction/response-format):** The current output format, returned for runs created with a JSON Schema config.
|
|
19
19
|
* - **[Legacy output](https://docs.extend.ai/2025-04-21/product/legacy/output-type-legacy):** A legacy output format from a previous API version. This shape is only returned for runs that were originally created with a legacy config.
|
|
20
20
|
*
|
|
21
21
|
* **Availability:** Present when `status` is `"PROCESSED"`.
|
|
@@ -77,7 +77,7 @@ export interface ExtractRun {
|
|
|
77
77
|
/**
|
|
78
78
|
* The configuration used for this extract run. This is a union of two possible shapes:
|
|
79
79
|
*
|
|
80
|
-
* - **[JSON Schema config](https://docs.extend.ai/2026-02-09/
|
|
80
|
+
* - **[JSON Schema config](https://docs.extend.ai/2026-02-09/extraction/schema):** The current config format. All runs created through this API version use this shape.
|
|
81
81
|
* - **[Legacy config](https://docs.extend.ai/2025-04-21/product/legacy/legacy-schema):** A fields-array config from a previous API version. This shape is only returned when retrieving runs that were originally created with the legacy format. This API version does not support creating runs with legacy configs.
|
|
82
82
|
*/
|
|
83
83
|
config: Extend.ExtractConfig;
|
|
@@ -93,8 +93,8 @@ export interface ExtractRun {
|
|
|
93
93
|
* **Availability:** Present when an extractor reference was provided. Not present when using inline `config`.
|
|
94
94
|
*/
|
|
95
95
|
extractorVersion: Extend.ExtractorVersionSummary | null;
|
|
96
|
-
/** The file that was processed. */
|
|
97
|
-
file: Extend.FileSummary;
|
|
96
|
+
/** The file that was processed. `null` when the file could not be accessed or processed (for example a run that failed during file ingestion, or a multi-file batch run). */
|
|
97
|
+
file: Extend.FileSummary | null;
|
|
98
98
|
/**
|
|
99
99
|
* The ID of the parse run that was used for this extract run.
|
|
100
100
|
*
|
|
@@ -42,8 +42,8 @@ export interface ExtractRunSummary {
|
|
|
42
42
|
reviewed: boolean;
|
|
43
43
|
/** Indicates whether the run results have been edited during review. */
|
|
44
44
|
edited: boolean;
|
|
45
|
-
/** The file that was processed. */
|
|
46
|
-
file: Extend.FileSummary;
|
|
45
|
+
/** The file that was processed. `null` when the file could not be accessed or processed (for example a run that failed during file ingestion, or a multi-file batch run). */
|
|
46
|
+
file: Extend.FileSummary | null;
|
|
47
47
|
/**
|
|
48
48
|
* The ID of the parse run that was used for this extract run.
|
|
49
49
|
*
|
|
@@ -4,7 +4,7 @@ import type * as Extend from "../index";
|
|
|
4
4
|
*
|
|
5
5
|
* The extractor reference must include an explicit `version`. Valid values are `"latest"`, `"draft"`, or a specific semver string (e.g. `"1.0"`).
|
|
6
6
|
*
|
|
7
|
-
* See the [Extract step docs](https://docs.extend.ai/2026-02-09/
|
|
7
|
+
* See the [Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#extract).
|
|
8
8
|
*/
|
|
9
9
|
export interface ExtractStepDefinition {
|
|
10
10
|
name: string;
|
|
@@ -23,7 +23,7 @@ export interface ExtractorVersion {
|
|
|
23
23
|
/**
|
|
24
24
|
* The configuration settings for this version of the extractor. This is a union of two possible shapes:
|
|
25
25
|
*
|
|
26
|
-
* - **[JSON Schema config](https://docs.extend.ai/2026-02-09/
|
|
26
|
+
* - **[JSON Schema config](https://docs.extend.ai/2026-02-09/extraction/schema):** The current config format. All extractors created through this API version use this shape.
|
|
27
27
|
* - **[Legacy config](https://docs.extend.ai/2025-04-21/product/legacy/legacy-schema):** A fields-array config from a previous API version. This shape is only returned for extractors that were originally configured with the legacy format. This API version does not support creating extractors with legacy configs.
|
|
28
28
|
*/
|
|
29
29
|
config: Extend.ExtractConfig;
|
|
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* Converts files to a different format.
|
|
4
4
|
*
|
|
5
|
-
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
|
|
6
6
|
*/
|
|
7
7
|
export interface FileConversionStepDefinition {
|
|
8
8
|
name: string;
|
|
@@ -3,7 +3,7 @@ export interface FileConversionStepDefinitionConfig {
|
|
|
3
3
|
/**
|
|
4
4
|
* Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
|
|
5
5
|
*
|
|
6
|
-
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
|
|
7
7
|
*/
|
|
8
8
|
failureBehavior?: Extend.FileConversionStepDefinitionConfigFailureBehavior;
|
|
9
9
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
|
|
3
3
|
*
|
|
4
|
-
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
|
|
5
5
|
*/
|
|
6
6
|
export declare const FileConversionStepDefinitionConfigFailureBehavior: {
|
|
7
7
|
readonly Continue: "CONTINUE";
|
|
@@ -5,7 +5,7 @@ exports.FileConversionStepDefinitionConfigFailureBehavior = void 0;
|
|
|
5
5
|
/**
|
|
6
6
|
* Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
|
|
7
7
|
*
|
|
8
|
-
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/
|
|
8
|
+
* See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
|
|
9
9
|
*/
|
|
10
10
|
exports.FileConversionStepDefinitionConfigFailureBehavior = {
|
|
11
11
|
Continue: "CONTINUE",
|
|
@@ -3,7 +3,7 @@ export interface FileFromUrl {
|
|
|
3
3
|
/**
|
|
4
4
|
* A URL to download the file. For production use cases, we recommend using presigned URLs with a 5-15 minute expiration time.
|
|
5
5
|
*
|
|
6
|
-
* Supported file types can be found [here](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
* Supported file types can be found [here](https://docs.extend.ai/2026-02-09/general/supported-file-types).
|
|
7
7
|
*/
|
|
8
8
|
url: string;
|
|
9
9
|
/** The name of the file. If not set, the file name is taken from the URL. */
|
|
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* Pauses the workflow for human review in the dashboard.
|
|
4
4
|
*
|
|
5
|
-
* See the [Human Review step docs](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
* See the [Human Review step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#human-review).
|
|
6
6
|
*/
|
|
7
7
|
export interface HumanReviewStepDefinition {
|
|
8
8
|
name: string;
|
|
@@ -4,7 +4,7 @@ export interface LegacyClassificationAdvancedOptions {
|
|
|
4
4
|
context?: Extend.LegacyClassificationAdvancedOptionsContext;
|
|
5
5
|
/** Enable advanced multimodal processing for better handling of visual elements during classification. */
|
|
6
6
|
advancedMultimodalEnabled?: boolean;
|
|
7
|
-
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/
|
|
7
|
+
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges). */
|
|
8
8
|
fixedPageLimit?: number;
|
|
9
9
|
pageRanges?: Extend.PageRanges;
|
|
10
10
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface LegacyClassificationConfig {
|
|
3
|
-
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/
|
|
3
|
+
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
|
|
4
4
|
baseProcessor?: Extend.LegacyClassificationConfigBaseProcessor;
|
|
5
|
-
/** The version of the `"classification_performance"` or `"classification_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The version of the `"classification_performance"` or `"classification_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
|
|
6
6
|
baseVersion?: string;
|
|
7
7
|
/** Array of possible classifications for the document. */
|
|
8
8
|
classifications: Extend.LegacyClassification[];
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/
|
|
1
|
+
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
|
|
2
2
|
export declare const LegacyClassificationConfigBaseProcessor: {
|
|
3
3
|
readonly ClassificationPerformance: "classification_performance";
|
|
4
4
|
readonly ClassificationLight: "classification_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.LegacyClassificationConfigBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
|
|
6
6
|
exports.LegacyClassificationConfigBaseProcessor = {
|
|
7
7
|
ClassificationPerformance: "classification_performance",
|
|
8
8
|
ClassificationLight: "classification_light",
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* These are usage credits for document processing (extraction, classification, or splitting). File parsing credits are tracked separately and can be retrieved from the [Get File](https://docs.extend.ai/2026-02-09/
|
|
2
|
+
* These are usage credits for document processing (extraction, classification, or splitting). File parsing credits are tracked separately and can be retrieved from the [Get File](https://docs.extend.ai/2026-02-09/api-reference/endpoints/file/get-file) endpoint.
|
|
3
3
|
*
|
|
4
4
|
* This field will not be returned for processor runs created before October 7, 2025, or for customers on legacy billing systems.
|
|
5
5
|
*
|
|
6
|
-
* For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/
|
|
6
|
+
* For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/general/how-credits-work).
|
|
7
7
|
*/
|
|
8
8
|
export interface LegacyDocumentProcessorRunCredits {
|
|
9
9
|
/** The number of credits consumed specifically for document processing in this processor run. This does not include file parsing credits. */
|
|
@@ -20,7 +20,7 @@ export interface LegacyExtractionAdvancedOptions {
|
|
|
20
20
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
21
21
|
* fields that may need manual review.
|
|
22
22
|
*
|
|
23
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/
|
|
23
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
|
|
24
24
|
*/
|
|
25
25
|
reviewAgent?: Extend.LegacyExtractionAdvancedOptionsReviewAgent;
|
|
26
26
|
/** Strategy for handling large arrays in documents. */
|
|
@@ -30,7 +30,7 @@ export interface LegacyExtractionAdvancedOptions {
|
|
|
30
30
|
excelSheetRanges?: Extend.ExcelSheetRange[];
|
|
31
31
|
/** Strategy for selecting sheets from Excel documents. */
|
|
32
32
|
excelSheetSelectionStrategy?: Extend.LegacyExtractionAdvancedOptionsExcelSheetSelectionStrategy;
|
|
33
|
-
/** DEPRECATED - See [Page Ranges](https://docs.extend.ai/2026-02-09/
|
|
33
|
+
/** DEPRECATED - See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges). */
|
|
34
34
|
fixedPageLimit?: number;
|
|
35
35
|
pageRanges?: Extend.PageRanges;
|
|
36
36
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* and may include additional `insights` of type `issue` or `review_summary` to help identify
|
|
5
5
|
* fields that may need manual review.
|
|
6
6
|
*
|
|
7
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/
|
|
7
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
|
|
8
8
|
*/
|
|
9
9
|
export interface LegacyExtractionAdvancedOptionsReviewAgent {
|
|
10
10
|
/** Whether to enable the review agent for the extraction output. */
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import type * as Extend from "../index";
|
|
2
2
|
export interface LegacyExtractionConfig {
|
|
3
|
-
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
3
|
+
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
4
4
|
baseProcessor?: Extend.LegacyExtractionConfigBaseProcessor;
|
|
5
|
-
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
6
6
|
baseVersion?: string;
|
|
7
7
|
/** Custom rules to guide the extraction process in natural language. */
|
|
8
8
|
extractionRules?: string;
|
|
9
9
|
/**
|
|
10
10
|
* JSON Schema definition of the data to extract. Either `fields` or `schema` must be provided.
|
|
11
11
|
*
|
|
12
|
-
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/
|
|
12
|
+
* See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/extraction/schema) for details and examples of schema configuration.
|
|
13
13
|
*/
|
|
14
14
|
schema?: Extend.JsonObject;
|
|
15
15
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
1
|
+
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
2
2
|
export declare const LegacyExtractionConfigBaseProcessor: {
|
|
3
3
|
readonly ExtractionPerformance: "extraction_performance";
|
|
4
4
|
readonly ExtractionLight: "extraction_light";
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.LegacyExtractionConfigBaseProcessor = void 0;
|
|
5
|
-
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/
|
|
5
|
+
/** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
|
|
6
6
|
exports.LegacyExtractionConfigBaseProcessor = {
|
|
7
7
|
ExtractionPerformance: "extraction_performance",
|
|
8
8
|
ExtractionLight: "extraction_light",
|
|
@@ -14,7 +14,7 @@ export interface LegacyJsonOutputMetadataValue {
|
|
|
14
14
|
*
|
|
15
15
|
* These scores will be present when the `reviewAgent.enabled` flag is set to `true` in the processor config.
|
|
16
16
|
* If the review agent is enabled but a score is not returned for a field, this value will be `null`.
|
|
17
|
-
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/
|
|
17
|
+
* To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
|
|
18
18
|
*/
|
|
19
19
|
reviewAgentScore?: number | null;
|
|
20
20
|
citations?: Extend.LegacyJsonOutputMetadataValueCitationsItem[];
|
|
@@ -10,7 +10,7 @@ export interface LegacySplitterAdvancedOptions {
|
|
|
10
10
|
splitMethod?: Extend.LegacySplitterAdvancedOptionsSplitMethod;
|
|
11
11
|
/** For Excel documents, split by worksheet. */
|
|
12
12
|
splitExcelDocumentsBySheetEnabled?: boolean;
|
|
13
|
-
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/
|
|
13
|
+
/** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges). */
|
|
14
14
|
fixedPageLimit?: number;
|
|
15
15
|
pageRanges?: Extend.PageRanges;
|
|
16
16
|
}
|