extend-ai 1.11.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (262) hide show
  1. package/BaseClient.js +2 -2
  2. package/Client.d.ts +33 -14
  3. package/Client.js +33 -14
  4. package/LICENSE +21 -0
  5. package/api/client/requests/ExtractRequest.d.ts +23 -4
  6. package/api/client/requests/ParseRequest.d.ts +1 -1
  7. package/api/resources/batchProcessorRun/client/Client.d.ts +2 -2
  8. package/api/resources/batchProcessorRun/client/Client.js +2 -2
  9. package/api/resources/batchProcessorRun/client/requests/BatchProcessorRunGetRequest.d.ts +1 -1
  10. package/api/resources/batchRuns/client/Client.d.ts +1 -1
  11. package/api/resources/batchRuns/client/Client.js +1 -1
  12. package/api/resources/classifierVersions/client/Client.d.ts +1 -1
  13. package/api/resources/classifierVersions/client/Client.js +1 -1
  14. package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +1 -1
  15. package/api/resources/classifierVersions/client/requests/ClassifierVersionsListRequest.d.ts +1 -1
  16. package/api/resources/classifierVersions/client/requests/ClassifierVersionsRetrieveRequest.d.ts +1 -1
  17. package/api/resources/classifiers/client/Client.d.ts +1 -1
  18. package/api/resources/classifiers/client/Client.js +1 -1
  19. package/api/resources/classifiers/client/requests/ClassifiersListRequest.d.ts +1 -1
  20. package/api/resources/classifiers/client/requests/ClassifiersRetrieveRequest.d.ts +1 -1
  21. package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +1 -1
  22. package/api/resources/classifyRuns/client/Client.d.ts +3 -3
  23. package/api/resources/classifyRuns/client/Client.js +3 -3
  24. package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.d.ts +1 -1
  25. package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.d.ts +1 -1
  26. package/api/resources/classifyRuns/client/requests/ClassifyRunsListRequest.d.ts +1 -1
  27. package/api/resources/classifyRuns/client/requests/ClassifyRunsRetrieveRequest.d.ts +1 -1
  28. package/api/resources/editRuns/client/Client.d.ts +2 -2
  29. package/api/resources/editRuns/client/Client.js +2 -2
  30. package/api/resources/editRuns/client/requests/EditRunsDeleteRequest.d.ts +1 -1
  31. package/api/resources/editRuns/client/requests/EditRunsRetrieveRequest.d.ts +1 -1
  32. package/api/resources/editSchemas/client/Client.d.ts +2 -2
  33. package/api/resources/editSchemas/client/Client.js +2 -2
  34. package/api/resources/editTemplates/client/Client.d.ts +1 -1
  35. package/api/resources/editTemplates/client/Client.js +1 -1
  36. package/api/resources/editTemplates/client/requests/EditTemplatesRetrieveRequest.d.ts +1 -1
  37. package/api/resources/evaluationSetItems/client/Client.d.ts +3 -3
  38. package/api/resources/evaluationSetItems/client/Client.js +3 -3
  39. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +1 -1
  40. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.d.ts +1 -1
  41. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsListRequest.d.ts +1 -1
  42. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.d.ts +1 -1
  43. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +1 -1
  44. package/api/resources/evaluationSetRuns/client/Client.d.ts +3 -3
  45. package/api/resources/evaluationSetRuns/client/Client.js +3 -3
  46. package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsCreateRequest.d.ts +1 -1
  47. package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts +1 -1
  48. package/api/resources/evaluationSets/client/Client.d.ts +4 -4
  49. package/api/resources/evaluationSets/client/Client.js +4 -4
  50. package/api/resources/evaluationSets/client/requests/EvaluationSetsListRequest.d.ts +1 -1
  51. package/api/resources/evaluationSets/client/requests/EvaluationSetsRetrieveRequest.d.ts +1 -1
  52. package/api/resources/extractRuns/client/Client.d.ts +3 -3
  53. package/api/resources/extractRuns/client/Client.js +3 -3
  54. package/api/resources/extractRuns/client/requests/ExtractRunsCancelRequest.d.ts +1 -1
  55. package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +2 -2
  56. package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.d.ts +1 -1
  57. package/api/resources/extractRuns/client/requests/ExtractRunsListRequest.d.ts +1 -1
  58. package/api/resources/extractRuns/client/requests/ExtractRunsRetrieveRequest.d.ts +1 -1
  59. package/api/resources/extractRuns/types/ExtractRunsCreateRequestExtractor.d.ts +1 -1
  60. package/api/resources/extractorVersions/client/Client.d.ts +1 -1
  61. package/api/resources/extractorVersions/client/Client.js +1 -1
  62. package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +1 -1
  63. package/api/resources/extractorVersions/client/requests/ExtractorVersionsListRequest.d.ts +1 -1
  64. package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.d.ts +1 -1
  65. package/api/resources/extractors/client/Client.d.ts +22 -6
  66. package/api/resources/extractors/client/Client.js +22 -6
  67. package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +21 -5
  68. package/api/resources/extractors/client/requests/ExtractorsListRequest.d.ts +1 -1
  69. package/api/resources/extractors/client/requests/ExtractorsRetrieveRequest.d.ts +1 -1
  70. package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +1 -1
  71. package/api/resources/files/client/Client.d.ts +3 -3
  72. package/api/resources/files/client/Client.js +3 -3
  73. package/api/resources/files/client/requests/FilesDeleteRequest.d.ts +1 -1
  74. package/api/resources/files/client/requests/FilesListRequest.d.ts +1 -1
  75. package/api/resources/files/client/requests/FilesRetrieveRequest.d.ts +1 -1
  76. package/api/resources/files/client/requests/FilesUploadRequest.d.ts +1 -1
  77. package/api/resources/parseRuns/client/Client.d.ts +28 -3
  78. package/api/resources/parseRuns/client/Client.js +81 -3
  79. package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.d.ts +8 -0
  80. package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.js +3 -0
  81. package/api/resources/parseRuns/client/requests/ParseRunsDeleteRequest.d.ts +1 -1
  82. package/api/resources/parseRuns/client/requests/ParseRunsListRequest.d.ts +1 -1
  83. package/api/resources/parseRuns/client/requests/ParseRunsRetrieveRequest.d.ts +1 -1
  84. package/api/resources/parseRuns/client/requests/index.d.ts +1 -0
  85. package/api/resources/parseRuns/types/ParseRunsListResponse.d.ts +1 -1
  86. package/api/resources/processor/client/Client.d.ts +1 -1
  87. package/api/resources/processor/client/Client.js +1 -1
  88. package/api/resources/processor/client/requests/ProcessorListRequest.d.ts +1 -1
  89. package/api/resources/processor/client/requests/ProcessorUpdateRequest.d.ts +1 -1
  90. package/api/resources/processorRun/client/Client.d.ts +4 -4
  91. package/api/resources/processorRun/client/Client.js +4 -4
  92. package/api/resources/processorRun/client/requests/ProcessorRunCancelRequest.d.ts +1 -1
  93. package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +2 -2
  94. package/api/resources/processorRun/client/requests/ProcessorRunDeleteRequest.d.ts +1 -1
  95. package/api/resources/processorRun/client/requests/ProcessorRunGetRequest.d.ts +1 -1
  96. package/api/resources/processorRun/client/requests/ProcessorRunListRequest.d.ts +1 -1
  97. package/api/resources/processorVersion/client/Client.d.ts +1 -1
  98. package/api/resources/processorVersion/client/Client.js +1 -1
  99. package/api/resources/processorVersion/client/requests/ProcessorVersionCreateRequest.d.ts +1 -1
  100. package/api/resources/processorVersion/client/requests/ProcessorVersionGetRequest.d.ts +1 -1
  101. package/api/resources/processorVersion/client/requests/ProcessorVersionListRequest.d.ts +1 -1
  102. package/api/resources/splitRuns/client/Client.d.ts +3 -3
  103. package/api/resources/splitRuns/client/Client.js +3 -3
  104. package/api/resources/splitRuns/client/requests/SplitRunsCancelRequest.d.ts +1 -1
  105. package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.d.ts +1 -1
  106. package/api/resources/splitRuns/client/requests/SplitRunsListRequest.d.ts +1 -1
  107. package/api/resources/splitRuns/client/requests/SplitRunsRetrieveRequest.d.ts +1 -1
  108. package/api/resources/splitterVersions/client/Client.d.ts +1 -1
  109. package/api/resources/splitterVersions/client/Client.js +1 -1
  110. package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +1 -1
  111. package/api/resources/splitterVersions/client/requests/SplitterVersionsListRequest.d.ts +1 -1
  112. package/api/resources/splitterVersions/client/requests/SplitterVersionsRetrieveRequest.d.ts +1 -1
  113. package/api/resources/splitters/client/Client.d.ts +1 -1
  114. package/api/resources/splitters/client/Client.js +1 -1
  115. package/api/resources/splitters/client/requests/SplittersListRequest.d.ts +1 -1
  116. package/api/resources/splitters/client/requests/SplittersRetrieveRequest.d.ts +1 -1
  117. package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +1 -1
  118. package/api/resources/webhookEndpoints/client/Client.d.ts +3 -3
  119. package/api/resources/webhookEndpoints/client/Client.js +3 -3
  120. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsDeleteRequest.d.ts +1 -1
  121. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +1 -1
  122. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsRetrieveRequest.d.ts +1 -1
  123. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +1 -1
  124. package/api/resources/webhookSubscriptions/client/Client.d.ts +1 -1
  125. package/api/resources/webhookSubscriptions/client/Client.js +1 -1
  126. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.d.ts +1 -1
  127. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +1 -1
  128. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.d.ts +1 -1
  129. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +1 -1
  130. package/api/resources/workflowRuns/client/Client.d.ts +6 -6
  131. package/api/resources/workflowRuns/client/Client.js +6 -6
  132. package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.d.ts +1 -1
  133. package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +2 -0
  134. package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +1 -1
  135. package/api/resources/workflowRuns/client/requests/WorkflowRunsDeleteRequest.d.ts +1 -1
  136. package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +2 -2
  137. package/api/resources/workflowRuns/client/requests/WorkflowRunsRetrieveRequest.d.ts +1 -1
  138. package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +1 -1
  139. package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
  140. package/api/resources/workflowVersions/client/Client.d.ts +1 -1
  141. package/api/resources/workflowVersions/client/Client.js +1 -1
  142. package/api/resources/workflowVersions/client/requests/WorkflowVersionsCreateRequest.d.ts +1 -1
  143. package/api/resources/workflows/client/Client.d.ts +1 -1
  144. package/api/resources/workflows/client/Client.js +1 -1
  145. package/api/resources/workflows/client/requests/WorkflowsCreateRequest.d.ts +1 -1
  146. package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.d.ts +1 -1
  147. package/api/types/ApiError.d.ts +1 -1
  148. package/api/types/BlockMetadata.d.ts +6 -0
  149. package/api/types/BlockMetadataSheet.d.ts +9 -0
  150. package/api/types/BlockMetadataSheet.js +3 -0
  151. package/api/types/ChunkMetadata.d.ts +4 -0
  152. package/api/types/ClassificationNextEntry.d.ts +1 -1
  153. package/api/types/ClassifyBaseProcessor.d.ts +1 -1
  154. package/api/types/ClassifyBaseProcessor.js +1 -1
  155. package/api/types/ClassifyConfig.d.ts +1 -1
  156. package/api/types/ClassifyOverrideConfig.d.ts +1 -1
  157. package/api/types/ClassifyRun.d.ts +2 -2
  158. package/api/types/ClassifyRunSummary.d.ts +2 -2
  159. package/api/types/ClassifyStepDefinition.d.ts +3 -3
  160. package/api/types/ClassifyStepDefinitionConfig.d.ts +1 -1
  161. package/api/types/CollectStepDefinition.d.ts +1 -1
  162. package/api/types/ConditionalExtractStepDefinition.d.ts +1 -1
  163. package/api/types/ConditionalExtractStepDefinitionConfig.d.ts +1 -1
  164. package/api/types/ConditionalExtractStepDefinitionConfigRulesItem.d.ts +1 -1
  165. package/api/types/ConditionalNextEntry.d.ts +1 -1
  166. package/api/types/ConditionalStepDefinition.d.ts +2 -2
  167. package/api/types/ConditionalStepDefinitionConfig.d.ts +1 -1
  168. package/api/types/ConditionalStepDefinitionConfigConditionsItem.d.ts +3 -3
  169. package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.d.ts +1 -1
  170. package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.js +1 -1
  171. package/api/types/EvaluationSetRun.d.ts +1 -1
  172. package/api/types/ExternalDataValidationStepDefinition.d.ts +1 -1
  173. package/api/types/ExternalDataValidationStepDefinitionConfig.d.ts +2 -2
  174. package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.d.ts +1 -1
  175. package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.js +1 -1
  176. package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptions.d.ts +3 -3
  177. package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.d.ts +1 -1
  178. package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.js +1 -1
  179. package/api/types/ExtractAdvancedOptions.d.ts +1 -1
  180. package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
  181. package/api/types/ExtractBaseProcessor.d.ts +1 -1
  182. package/api/types/ExtractBaseProcessor.js +1 -1
  183. package/api/types/ExtractConfigJson.d.ts +9 -5
  184. package/api/types/ExtractConfigLegacy.d.ts +2 -2
  185. package/api/types/ExtractConfigLegacyBaseProcessor.d.ts +1 -1
  186. package/api/types/ExtractConfigLegacyBaseProcessor.js +1 -1
  187. package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
  188. package/api/types/ExtractOverrideConfigJson.d.ts +2 -2
  189. package/api/types/ExtractRequestExtractor.d.ts +1 -1
  190. package/api/types/ExtractRun.d.ts +5 -4
  191. package/api/types/ExtractRunSummary.d.ts +16 -2
  192. package/api/types/ExtractStepDefinition.d.ts +1 -1
  193. package/api/types/ExtractorVersion.d.ts +1 -1
  194. package/api/types/FileConversionStepDefinition.d.ts +1 -1
  195. package/api/types/FileConversionStepDefinitionConfig.d.ts +1 -1
  196. package/api/types/FileConversionStepDefinitionConfigFailureBehavior.d.ts +1 -1
  197. package/api/types/FileConversionStepDefinitionConfigFailureBehavior.js +1 -1
  198. package/api/types/FileFromUrl.d.ts +1 -1
  199. package/api/types/HumanReviewStepDefinition.d.ts +1 -1
  200. package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
  201. package/api/types/LegacyClassificationConfig.d.ts +2 -2
  202. package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
  203. package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
  204. package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
  205. package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
  206. package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
  207. package/api/types/LegacyExtractionConfig.d.ts +3 -3
  208. package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
  209. package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
  210. package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
  211. package/api/types/LegacySplitterAdvancedOptions.d.ts +1 -1
  212. package/api/types/LegacySplitterConfig.d.ts +2 -2
  213. package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
  214. package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
  215. package/api/types/MergeExtractStepDefinition.d.ts +1 -1
  216. package/api/types/MergeExtractStepDefinitionConfig.d.ts +1 -1
  217. package/api/types/MergeExtractStepDefinitionConfigMergeOrder.d.ts +1 -1
  218. package/api/types/MergeExtractStepDefinitionConfigMergeOrder.js +1 -1
  219. package/api/types/PageRanges.d.ts +1 -1
  220. package/api/types/ParseConfig.d.ts +2 -2
  221. package/api/types/ParseConfigBlockOptionsFigures.d.ts +2 -0
  222. package/api/types/ParseConfigEngine.d.ts +1 -1
  223. package/api/types/ParseConfigEngine.js +1 -1
  224. package/api/types/ParseConfigTarget.d.ts +1 -1
  225. package/api/types/ParseConfigTarget.js +1 -1
  226. package/api/types/ParseRun.d.ts +6 -0
  227. package/api/types/ParseRunSummary.d.ts +81 -0
  228. package/api/types/ParseRunSummary.js +3 -0
  229. package/api/types/ParseRunSummaryMetrics.d.ts +11 -0
  230. package/api/types/ParseRunSummaryMetrics.js +3 -0
  231. package/api/types/ParseRunSummaryStatus.d.ts +14 -0
  232. package/api/types/ParseRunSummaryStatus.js +17 -0
  233. package/api/types/ParseStepDefinition.d.ts +1 -1
  234. package/api/types/RuleValidationNextEntry.d.ts +1 -1
  235. package/api/types/RuleValidationStepDefinition.d.ts +2 -2
  236. package/api/types/RuleValidationStepDefinitionConfig.d.ts +1 -1
  237. package/api/types/RuleValidationStepDefinitionConfigRulesItem.d.ts +1 -1
  238. package/api/types/RunUsage.d.ts +1 -1
  239. package/api/types/RunUsageBreakdownCharge.d.ts +15 -0
  240. package/api/types/RunUsageBreakdownCharge.js +3 -0
  241. package/api/types/RunUsageBreakdownEntry.d.ts +7 -1
  242. package/api/types/RunUsageSummary.d.ts +1 -1
  243. package/api/types/SplitBaseProcessor.d.ts +1 -1
  244. package/api/types/SplitBaseProcessor.js +1 -1
  245. package/api/types/SplitConfig.d.ts +1 -1
  246. package/api/types/SplitOverrideConfig.d.ts +1 -1
  247. package/api/types/SplitRun.d.ts +2 -2
  248. package/api/types/SplitRunSummary.d.ts +2 -2
  249. package/api/types/SplitStepDefinition.d.ts +3 -3
  250. package/api/types/SplitStepDefinitionConfig.d.ts +1 -1
  251. package/api/types/TriggerStepDefinition.d.ts +1 -1
  252. package/api/types/WebhookResponseStepDefinition.d.ts +1 -1
  253. package/api/types/WorkflowStepDefinition.d.ts +1 -1
  254. package/api/types/index.d.ts +5 -0
  255. package/api/types/index.js +5 -0
  256. package/auth/BearerAuthProvider.d.ts +1 -1
  257. package/auth/BearerAuthProvider.js +6 -3
  258. package/package.json +2 -1
  259. package/reference.md +160 -48
  260. package/version.d.ts +1 -1
  261. package/version.js +1 -1
  262. package/wrapper/resources/parseRuns/ParseRunsWrapper.test.js +1 -1
@@ -5,6 +5,12 @@ import type * as Extend from "../index";
5
5
  export interface BlockMetadata {
6
6
  /** Information about the page this block appears on. */
7
7
  page?: Extend.BlockMetadataPage;
8
+ /** Spreadsheet sheet metadata. Present for blocks parsed from spreadsheet files, such as Excel workbooks. */
9
+ sheet?: Extend.BlockMetadataSheet;
8
10
  /** Text direction for this block's content ("ltr" for left-to-right, "rtl" for right-to-left). */
9
11
  textDirection?: Extend.BlockMetadataTextDirection;
12
+ /** Lowest per-word OCR confidence across words in this block, or `null` when word-level confidence is unavailable. */
13
+ minOcrConfidence?: number | null;
14
+ /** Average per-word OCR confidence across words in this block, or `null` when word-level confidence is unavailable. */
15
+ avgOcrConfidence?: number | null;
10
16
  }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Spreadsheet sheet metadata. Present for blocks parsed from spreadsheet files, such as Excel workbooks.
3
+ */
4
+ export interface BlockMetadataSheet {
5
+ /** The zero-based index of the sheet in the original workbook. */
6
+ index: number;
7
+ /** The name of the sheet in the original workbook. */
8
+ name: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,4 +5,8 @@ import type * as Extend from "../index";
5
5
  export interface ChunkMetadata {
6
6
  /** The page range this chunk covers. Often will just be a partial page, in which cases `start` and `end` will be the same. */
7
7
  pageRange: Extend.ChunkMetadataPageRange;
8
+ /** Lowest per-word OCR confidence across words in this chunk, or `null` when word-level confidence is unavailable. */
9
+ minOcrConfidence?: number | null;
10
+ /** Average per-word OCR confidence across words in this chunk, or `null` when word-level confidence is unavailable. */
11
+ avgOcrConfidence?: number | null;
8
12
  }
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * A next entry for `CLASSIFY` and `SPLIT` steps. Routes based on the classification result.
3
3
  *
4
- * See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for end-to-end examples.
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 ClassificationNextEntry {
7
7
  /** The name of the target step. */
@@ -1,4 +1,4 @@
1
- /** The base processor to use. For classifiers, this can be either `"classification_performance"` or `"classification_light"`. Defaults to `"classification_performance"` if not provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
1
+ /** The base processor to use. For classifiers, this can be either `"classification_performance"` or `"classification_light"`. Defaults to `"classification_performance"` if not provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
2
2
  export declare const ClassifyBaseProcessor: {
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.ClassifyBaseProcessor = void 0;
5
- /** The base processor to use. For classifiers, this can be either `"classification_performance"` or `"classification_light"`. Defaults to `"classification_performance"` if not provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
5
+ /** The base processor to use. For classifiers, this can be either `"classification_performance"` or `"classification_light"`. Defaults to `"classification_performance"` if not provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
6
6
  exports.ClassifyBaseProcessor = {
7
7
  ClassificationPerformance: "classification_performance",
8
8
  ClassificationLight: "classification_light",
@@ -1,7 +1,7 @@
1
1
  import type * as Extend from "../index";
2
2
  export interface ClassifyConfig {
3
3
  baseProcessor?: Extend.ClassifyBaseProcessor;
4
- /** The version of the `"classification_performance"` or `"classification_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
4
+ /** The version of the `"classification_performance"` or `"classification_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
5
5
  baseVersion?: string;
6
6
  classifications: Extend.Classifications;
7
7
  /** Custom rules to guide the classification process in natural language. */
@@ -5,7 +5,7 @@ import type * as Extend from "../index";
5
5
  */
6
6
  export interface ClassifyOverrideConfig {
7
7
  baseProcessor?: Extend.ClassifyBaseProcessor;
8
- /** The version of the `"classification_performance"` or `"classification_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
8
+ /** The version of the `"classification_performance"` or `"classification_light"` processor to use. If not provided, the latest stable version for the selected `baseProcessor` will be used automatically. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
9
9
  baseVersion?: string;
10
10
  classifications?: Extend.Classifications;
11
11
  /** Custom rules to guide the classification process in natural language. */
@@ -79,8 +79,8 @@ export interface ClassifyRun {
79
79
  edited: boolean;
80
80
  /** The configuration used for this classify run. */
81
81
  config: Extend.ClassifyConfig;
82
- /** The file that was processed. */
83
- file: Extend.FileSummary;
82
+ /** 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). */
83
+ file: Extend.FileSummary | null;
84
84
  /**
85
85
  * The ID of the parse run that was used for this classify run.
86
86
  *
@@ -42,8 +42,8 @@ export interface ClassifyRunSummary {
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 classify run.
49
49
  *
@@ -4,7 +4,7 @@ import type * as Extend from "../index";
4
4
  *
5
5
  * The classifier reference must include a pinned `version` — `"latest"` is not supported for `CLASSIFY` steps. Use a specific semver string (e.g. `"0.1"`) or `"draft"`. This is because classification IDs used for routing are tied to a specific processor version's config.
6
6
  *
7
- * See the [Classify step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#classify-step).
7
+ * See the [Classify step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#classify).
8
8
  */
9
9
  export interface ClassifyStepDefinition {
10
10
  name: string;
@@ -15,13 +15,13 @@ export interface ClassifyStepDefinition {
15
15
  *
16
16
  * The classifier `version` is required and must be a pinned version (semver like `"0.1"` or `"draft"`). `"latest"` is not allowed.
17
17
  *
18
- * See the [Classify step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#classify-step).
18
+ * See the [Classify step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#classify).
19
19
  */
20
20
  config?: Extend.ClassifyStepDefinitionConfig;
21
21
  /**
22
22
  * Can only be set when `config` is present. Each entry must include a `classificationId` matching a classification `id` from the referenced classifier's configuration. Use the classification's stable `id` (e.g. `"cls_invoice"`), not the `type` string.
23
23
  *
24
- * See the [Classify step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#classify-step).
24
+ * See the [Classify step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#classify).
25
25
  */
26
26
  next?: Extend.ClassificationNextEntry[];
27
27
  }
@@ -6,7 +6,7 @@ import type * as Extend from "../index";
6
6
  *
7
7
  * The classifier `version` is required and must be a pinned version (semver like `"0.1"` or `"draft"`). `"latest"` is not allowed.
8
8
  *
9
- * See the [Classify step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#classify-step).
9
+ * See the [Classify step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#classify).
10
10
  */
11
11
  export interface ClassifyStepDefinitionConfig {
12
12
  classifier: Extend.ClassifierRef;
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * Collects outputs from multiple upstream branches before continuing.
4
4
  *
5
- * See the [Collect step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#collect-step).
5
+ * See the [Collect step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#collect).
6
6
  */
7
7
  export interface CollectStepDefinition {
8
8
  name: string;
@@ -4,7 +4,7 @@ import type * as Extend from "../index";
4
4
  *
5
5
  * Each 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 [Conditional Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#conditional-extract-step).
7
+ * See the [Conditional Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional-extract).
8
8
  */
9
9
  export interface ConditionalExtractStepDefinition {
10
10
  name: string;
@@ -6,7 +6,7 @@ export interface ConditionalExtractStepDefinitionConfig {
6
6
  /**
7
7
  * Formula-based extractor rules for this step. Each rule pairs a formula with an extractor reference. The last rule must have `formula: "TRUE"` as a default catch-all.
8
8
  *
9
- * See the [Conditional Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#conditional-extract-step).
9
+ * See the [Conditional Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#conditional-extract).
10
10
  */
11
11
  rules: Extend.ConditionalExtractStepDefinitionConfigRulesItem[];
12
12
  }
@@ -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/product/workflows/configuring-workflows-via-api#conditional-extract-step) and [Formulas](https://docs.extend.ai/2026-02-09/product/workflows/formulas).
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/product/workflows/configuring-workflows-via-api) for end-to-end examples.
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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/product/workflows/configuring-workflows-via-api#conditional-step).
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",
@@ -5,7 +5,7 @@ export interface EvaluationSetRun {
5
5
  /**
6
6
  * The unique identifier for this evaluation set run.
7
7
  *
8
- * Example: `"eval_set_run_Xj8mK2pL9nR4vT7qY5wZ"`
8
+ * Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
9
9
  */
10
10
  id: string;
11
11
  /**
@@ -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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/workflows/configuring-workflows-via-api#external-data-validation-step).
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/product/extraction/review-agent)
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/product/extraction/review-agent)
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/changelog/extraction/extraction-performance) for more details. */
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/changelog/extraction/extraction-performance) for more details. */
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,16 +1,20 @@
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/changelog/extraction/extraction-performance) for more details. */
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
- /** Custom rules to guide the extraction process in natural language. */
6
+ /**
7
+ * Custom rules to guide the extraction process in natural language.
8
+ *
9
+ * When `schema` is omitted, `extractionRules` also serves as schema generation instructions — for example, `"Invoice with vendor name, line items, and total due"`. Providing focused instructions produces a more targeted inferred schema.
10
+ */
7
11
  extractionRules?: string;
8
12
  /**
9
- * JSON Schema definition of the data to extract.
13
+ * JSON Schema definition of the data to extract. **Optional** — if omitted, Extend automatically infers a schema from the document before running extraction. No extractor is required.
10
14
  *
11
- * See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema) for details and examples of schema configuration.
15
+ * See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/extraction/schema) for details and examples of schema configuration.
12
16
  */
13
- schema: Extend.JsonObject;
17
+ schema?: Extend.JsonObject;
14
18
  /** Advanced configuration options. */
15
19
  advancedOptions?: Extend.ExtractAdvancedOptions;
16
20
  /** Configuration options for the parsing process. */
@@ -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/changelog/extraction/extraction-performance) for more details. */
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/changelog/extraction/extraction-performance) for more details. */
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/changelog/extraction/extraction-performance) for more details. */
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/changelog/extraction/extraction-performance) for more details. */
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/product/extraction/review-agent)
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/changelog/extraction/extraction-performance) for more details. */
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/product/extraction/schema) for details and examples of schema configuration.
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. */
@@ -1,6 +1,6 @@
1
1
  import type * as Extend from "../index";
2
2
  /**
3
- * Reference to an existing extractor. One of `extractor` or `config` must be provided.
3
+ * Reference to an existing extractor. Mutually exclusive with `config` — provide one or the other, or omit both to have Extend infer a schema from the document.
4
4
  */
5
5
  export interface ExtractRequestExtractor {
6
6
  /** The ID of the extractor to use. */
@@ -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/product/extraction/output-types):** The current output format, returned for runs created with a JSON Schema config.
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"`.
@@ -48,6 +48,7 @@ export interface ExtractRun {
48
48
  * * `PRE_PROCESSING_FAILURE` - An error occurred during preprocessing (e.g., chunking)
49
49
  * * `POST_PROCESSING_FAILURE` - An error occurred during postprocessing
50
50
  * * `OUT_OF_CREDITS` - Insufficient credits to run the extraction
51
+ * * `SCHEMA_GENERATION_FAILED` - Automatic schema inference failed (only applies when `schema` is omitted). The file could not be parsed or a schema could not be generated from it.
51
52
  *
52
53
  * **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.
53
54
  */
@@ -77,7 +78,7 @@ export interface ExtractRun {
77
78
  /**
78
79
  * The configuration used for this extract run. This is a union of two possible shapes:
79
80
  *
80
- * - **[JSON Schema config](https://docs.extend.ai/2026-02-09/product/extraction/schema):** The current config format. All runs created through this API version use this shape.
81
+ * - **[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
82
  * - **[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
83
  */
83
84
  config: Extend.ExtractConfig;
@@ -93,8 +94,8 @@ export interface ExtractRun {
93
94
  * **Availability:** Present when an extractor reference was provided. Not present when using inline `config`.
94
95
  */
95
96
  extractorVersion: Extend.ExtractorVersionSummary | null;
96
- /** The file that was processed. */
97
- file: Extend.FileSummary;
97
+ /** 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). */
98
+ file: Extend.FileSummary | null;
98
99
  /**
99
100
  * The ID of the parse run that was used for this extract run.
100
101
  *
@@ -24,6 +24,20 @@ export interface ExtractRunSummary {
24
24
  * The reason for failure.
25
25
  *
26
26
  * **Availability:** Present when `status` is `"FAILED"`.
27
+ *
28
+ * Possible values include:
29
+ * * `ABORTED` - The run was aborted by the user
30
+ * * `INTERNAL_ERROR` - An unexpected internal error occurred
31
+ * * `FAILED_TO_PROCESS_FILE` - Failed to process the file (e.g., OCR failure, file access issues)
32
+ * * `INVALID_PROCESSOR` - The processor configuration is invalid
33
+ * * `INVALID_CONFIGURATION` - The provided configuration is incompatible with the selected model
34
+ * * `PARSING_ERROR` - Failed to parse the extraction output
35
+ * * `PRE_PROCESSING_FAILURE` - An error occurred during preprocessing (e.g., chunking)
36
+ * * `POST_PROCESSING_FAILURE` - An error occurred during postprocessing
37
+ * * `OUT_OF_CREDITS` - Insufficient credits to run the extraction
38
+ * * `SCHEMA_GENERATION_FAILED` - Automatic schema inference failed (only applies when `schema` is omitted). The file could not be parsed or a schema could not be generated from it.
39
+ *
40
+ * **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.
27
41
  */
28
42
  failureReason: string | null;
29
43
  /**
@@ -42,8 +56,8 @@ export interface ExtractRunSummary {
42
56
  reviewed: boolean;
43
57
  /** Indicates whether the run results have been edited during review. */
44
58
  edited: boolean;
45
- /** The file that was processed. */
46
- file: Extend.FileSummary;
59
+ /** 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). */
60
+ file: Extend.FileSummary | null;
47
61
  /**
48
62
  * The ID of the parse run that was used for this extract run.
49
63
  *
@@ -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/product/workflows/configuring-workflows-via-api#extract-step).
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;