mindee 5.8.0 → 5.9.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 (258) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/package.json +104 -95
  3. package/src/geometry/bbox.js +1 -1
  4. package/src/image/extractedImages.d.ts +1 -1
  5. package/src/image/imageExtractor.d.ts +1 -1
  6. package/src/image/imageExtractor.js +2 -2
  7. package/src/input/localInputSource.d.ts +1 -1
  8. package/src/parsing/baseLocalResponse.d.ts +1 -1
  9. package/src/pdf/extractedPdfs.d.ts +1 -1
  10. package/src/pdf/pdfExtractor.d.ts +1 -1
  11. package/src/pdf/pdfExtractor.js +2 -2
  12. package/src/v1/extraction/invoiceSplitterExtractor/invoiceSplitterExtractor.d.ts +2 -2
  13. package/src/v1/extraction/invoiceSplitterExtractor/invoiceSplitterExtractor.js +2 -2
  14. package/src/v1/extraction/multiReceiptsExtractor/multiReceiptsExtractor.d.ts +2 -2
  15. package/src/v1/extraction/multiReceiptsExtractor/multiReceiptsExtractor.js +1 -1
  16. package/src/v1/http/baseEndpoint.d.ts +1 -1
  17. package/src/v1/http/endpoint.d.ts +1 -1
  18. package/src/v1/http/endpoint.js +1 -1
  19. package/src/v1/http/httpParams.d.ts +1 -1
  20. package/src/v1/http/workflowEndpoint.d.ts +2 -2
  21. package/src/v1/http/workflowEndpoint.js +1 -1
  22. package/src/v1/parsing/common/execution.d.ts +1 -1
  23. package/src/v1/parsing/common/execution.js +1 -1
  24. package/src/v1/parsing/common/extras/cropperExtra.d.ts +1 -1
  25. package/src/v1/parsing/common/extras/cropperExtra.js +1 -1
  26. package/src/v1/parsing/common/ocrPage.d.ts +1 -1
  27. package/src/v1/parsing/common/ocrPage.js +1 -1
  28. package/src/v1/parsing/common/orientation.d.ts +1 -1
  29. package/src/v1/parsing/common/orientation.js +1 -1
  30. package/src/v1/parsing/generated/generatedList.d.ts +1 -1
  31. package/src/v1/parsing/generated/generatedList.js +1 -1
  32. package/src/v1/parsing/generated/generatedObject.d.ts +1 -1
  33. package/src/v1/parsing/generated/generatedObject.js +1 -1
  34. package/src/v1/parsing/localResponse.d.ts +1 -1
  35. package/src/v1/parsing/localResponse.js +1 -1
  36. package/src/v1/parsing/standard/amount.js +1 -1
  37. package/src/v1/parsing/standard/companyRegistration.js +1 -1
  38. package/src/v1/parsing/standard/tax.d.ts +1 -1
  39. package/src/v1/parsing/standard/tax.js +1 -1
  40. package/src/v1/product/barcodeReader/barcodeReaderV1.d.ts +1 -1
  41. package/src/v1/product/barcodeReader/barcodeReaderV1.js +1 -1
  42. package/src/v1/product/barcodeReader/barcodeReaderV1Document.d.ts +2 -2
  43. package/src/v1/product/barcodeReader/barcodeReaderV1Document.js +2 -2
  44. package/src/v1/product/cliProducts.d.ts +2 -2
  45. package/src/v1/product/cliProducts.js +1 -1
  46. package/src/v1/product/cropper/cropperV1.d.ts +1 -1
  47. package/src/v1/product/cropper/cropperV1.js +1 -1
  48. package/src/v1/product/cropper/cropperV1Document.d.ts +1 -1
  49. package/src/v1/product/cropper/cropperV1Page.d.ts +2 -2
  50. package/src/v1/product/cropper/cropperV1Page.js +2 -2
  51. package/src/v1/product/driverLicense/driverLicenseV1.d.ts +1 -1
  52. package/src/v1/product/driverLicense/driverLicenseV1.js +1 -1
  53. package/src/v1/product/driverLicense/driverLicenseV1Document.d.ts +2 -2
  54. package/src/v1/product/driverLicense/driverLicenseV1Document.js +2 -2
  55. package/src/v1/product/financialDocument/financialDocumentV1.d.ts +1 -1
  56. package/src/v1/product/financialDocument/financialDocumentV1.js +1 -1
  57. package/src/v1/product/financialDocument/financialDocumentV1Document.d.ts +2 -2
  58. package/src/v1/product/financialDocument/financialDocumentV1Document.js +2 -2
  59. package/src/v1/product/financialDocument/financialDocumentV1LineItem.js +1 -1
  60. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1.d.ts +1 -1
  61. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1.js +1 -1
  62. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1Document.d.ts +2 -2
  63. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1Document.js +2 -2
  64. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2.d.ts +1 -1
  65. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2.js +1 -1
  66. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2Document.d.ts +2 -2
  67. package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2Document.js +2 -2
  68. package/src/v1/product/fr/carteGrise/carteGriseV1.d.ts +1 -1
  69. package/src/v1/product/fr/carteGrise/carteGriseV1.js +1 -1
  70. package/src/v1/product/fr/carteGrise/carteGriseV1Document.d.ts +2 -2
  71. package/src/v1/product/fr/carteGrise/carteGriseV1Document.js +2 -2
  72. package/src/v1/product/fr/idCard/idCardV2.d.ts +1 -1
  73. package/src/v1/product/fr/idCard/idCardV2.js +1 -1
  74. package/src/v1/product/fr/idCard/idCardV2Document.d.ts +2 -2
  75. package/src/v1/product/fr/idCard/idCardV2Document.js +2 -2
  76. package/src/v1/product/fr/idCard/idCardV2Page.d.ts +2 -2
  77. package/src/v1/product/fr/idCard/idCardV2Page.js +2 -2
  78. package/src/v1/product/generated/generatedV1.d.ts +1 -1
  79. package/src/v1/product/generated/generatedV1.js +1 -1
  80. package/src/v1/product/generated/generatedV1Document.js +2 -2
  81. package/src/v1/product/generated/generatedV1Page.js +2 -2
  82. package/src/v1/product/generated/generatedV1Prediction.d.ts +3 -3
  83. package/src/v1/product/generated/generatedV1Prediction.js +3 -3
  84. package/src/v1/product/internationalId/internationalIdV2.d.ts +1 -1
  85. package/src/v1/product/internationalId/internationalIdV2.js +1 -1
  86. package/src/v1/product/internationalId/internationalIdV2Document.d.ts +2 -2
  87. package/src/v1/product/internationalId/internationalIdV2Document.js +2 -2
  88. package/src/v1/product/invoice/invoiceV4.d.ts +1 -1
  89. package/src/v1/product/invoice/invoiceV4.js +1 -1
  90. package/src/v1/product/invoice/invoiceV4Document.d.ts +2 -2
  91. package/src/v1/product/invoice/invoiceV4Document.js +2 -2
  92. package/src/v1/product/invoice/invoiceV4LineItem.js +1 -1
  93. package/src/v1/product/invoiceSplitter/invoiceSplitterV1.d.ts +1 -1
  94. package/src/v1/product/invoiceSplitter/invoiceSplitterV1.js +1 -1
  95. package/src/v1/product/invoiceSplitter/invoiceSplitterV1Document.d.ts +1 -1
  96. package/src/v1/product/invoiceSplitter/invoiceSplitterV1Document.js +1 -1
  97. package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1.d.ts +1 -1
  98. package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1.js +1 -1
  99. package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.d.ts +2 -2
  100. package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.js +2 -2
  101. package/src/v1/product/passport/passportV1.d.ts +1 -1
  102. package/src/v1/product/passport/passportV1.js +1 -1
  103. package/src/v1/product/passport/passportV1Document.d.ts +2 -2
  104. package/src/v1/product/passport/passportV1Document.js +2 -2
  105. package/src/v1/product/receipt/receiptV5.d.ts +1 -1
  106. package/src/v1/product/receipt/receiptV5.js +1 -1
  107. package/src/v1/product/receipt/receiptV5Document.d.ts +2 -2
  108. package/src/v1/product/receipt/receiptV5Document.js +2 -2
  109. package/src/v1/product/receipt/receiptV5LineItem.js +1 -1
  110. package/src/v1/product/resume/resumeV1.d.ts +1 -1
  111. package/src/v1/product/resume/resumeV1.js +1 -1
  112. package/src/v1/product/resume/resumeV1Certificate.js +1 -1
  113. package/src/v1/product/resume/resumeV1Document.d.ts +2 -2
  114. package/src/v1/product/resume/resumeV1Document.js +2 -2
  115. package/src/v1/product/resume/resumeV1Education.js +1 -1
  116. package/src/v1/product/resume/resumeV1Language.js +1 -1
  117. package/src/v1/product/resume/resumeV1ProfessionalExperience.js +1 -1
  118. package/src/v1/product/resume/resumeV1SocialNetworksUrl.js +1 -1
  119. package/src/v1/product/us/bankCheck/bankCheckV1.d.ts +1 -1
  120. package/src/v1/product/us/bankCheck/bankCheckV1.js +1 -1
  121. package/src/v1/product/us/bankCheck/bankCheckV1Document.d.ts +2 -2
  122. package/src/v1/product/us/bankCheck/bankCheckV1Document.js +2 -2
  123. package/src/v1/product/us/bankCheck/bankCheckV1Page.d.ts +2 -2
  124. package/src/v1/product/us/bankCheck/bankCheckV1Page.js +2 -2
  125. package/src/v2/cli.js +1 -1
  126. package/src/v2/client.d.ts +94 -18
  127. package/src/v2/client.js +171 -27
  128. package/src/v2/clientOptions/baseAnnotationParameters.d.ts +23 -0
  129. package/src/v2/clientOptions/baseAnnotationParameters.js +17 -0
  130. package/src/v2/clientOptions/baseProductParameters.js +3 -2
  131. package/src/v2/clientOptions/baseRagDocumentUploadParameters.d.ts +23 -0
  132. package/src/v2/clientOptions/baseRagDocumentUploadParameters.js +24 -0
  133. package/src/v2/clientOptions/index.d.ts +2 -0
  134. package/src/v2/clientOptions/index.js +2 -0
  135. package/src/v2/fileOperations/crop.d.ts +1 -1
  136. package/src/v2/http/errors.d.ts +1 -1
  137. package/src/v2/http/mindeeApiV2.d.ts +35 -6
  138. package/src/v2/http/mindeeApiV2.js +79 -3
  139. package/src/v2/parsing/baseRagAnnotationResponse.d.ts +28 -0
  140. package/src/v2/parsing/baseRagAnnotationResponse.js +14 -0
  141. package/src/v2/parsing/baseResponse.d.ts +6 -2
  142. package/src/v2/parsing/baseResponse.js +3 -1
  143. package/src/v2/parsing/error/errorResponse.d.ts +1 -1
  144. package/src/v2/parsing/error/errorResponse.js +1 -1
  145. package/src/v2/parsing/index.d.ts +2 -0
  146. package/src/v2/parsing/index.js +1 -0
  147. package/src/v2/parsing/inference/failedInferenceResponse.d.ts +2 -2
  148. package/src/v2/parsing/inference/failedInferenceResponse.js +2 -2
  149. package/src/v2/parsing/inference/field/inferenceFields.d.ts +9 -3
  150. package/src/v2/parsing/inference/field/inferenceFields.js +9 -3
  151. package/src/v2/parsing/inference/field/objectField.d.ts +13 -9
  152. package/src/v2/parsing/inference/field/objectField.js +19 -33
  153. package/src/v2/parsing/job/job.d.ts +8 -8
  154. package/src/v2/parsing/job/job.js +1 -1
  155. package/src/v2/parsing/job/jobResponse.d.ts +1 -1
  156. package/src/v2/parsing/job/jobResponse.js +1 -1
  157. package/src/v2/parsing/job/jobWebhook.d.ts +1 -1
  158. package/src/v2/parsing/job/jobWebhook.js +1 -1
  159. package/src/v2/parsing/search/baseSearchResponse.d.ts +1 -1
  160. package/src/v2/parsing/search/baseSearchResponse.js +1 -1
  161. package/src/v2/parsing/search/searchModels.d.ts +1 -1
  162. package/src/v2/parsing/search/searchModels.js +1 -1
  163. package/src/v2/parsing/search/searchRagDocuments.d.ts +1 -1
  164. package/src/v2/parsing/search/searchRagDocuments.js +1 -1
  165. package/src/v2/parsing/search/searchResponse.d.ts +1 -1
  166. package/src/v2/parsing/search/searchResponse.js +1 -1
  167. package/src/v2/product/baseProduct.d.ts +26 -6
  168. package/src/v2/product/baseProduct.js +31 -7
  169. package/src/v2/product/classification/classification.d.ts +1 -1
  170. package/src/v2/product/classification/classification.js +1 -1
  171. package/src/v2/product/classification/classificationClassifier.d.ts +1 -1
  172. package/src/v2/product/classification/classificationClassifier.js +1 -1
  173. package/src/v2/product/classification/classificationInference.d.ts +1 -1
  174. package/src/v2/product/classification/classificationInference.js +1 -1
  175. package/src/v2/product/classification/classificationResponse.d.ts +1 -1
  176. package/src/v2/product/classification/classificationResponse.js +1 -1
  177. package/src/v2/product/classification/params/classificationParameters.d.ts +1 -1
  178. package/src/v2/product/classification/params/classificationParameters.js +1 -1
  179. package/src/v2/product/crop/crop.d.ts +1 -1
  180. package/src/v2/product/crop/crop.js +1 -1
  181. package/src/v2/product/crop/cropInference.d.ts +2 -2
  182. package/src/v2/product/crop/cropInference.js +2 -2
  183. package/src/v2/product/crop/cropItem.d.ts +2 -2
  184. package/src/v2/product/crop/cropItem.js +3 -3
  185. package/src/v2/product/crop/cropResponse.d.ts +1 -1
  186. package/src/v2/product/crop/cropResponse.js +1 -1
  187. package/src/v2/product/crop/cropResult.d.ts +1 -1
  188. package/src/v2/product/crop/cropResult.js +2 -2
  189. package/src/v2/product/crop/params/cropParameters.d.ts +1 -1
  190. package/src/v2/product/crop/params/cropParameters.js +1 -1
  191. package/src/v2/product/extraction/extraction.d.ts +10 -2
  192. package/src/v2/product/extraction/extraction.js +17 -3
  193. package/src/v2/product/extraction/extractionInference.d.ts +1 -1
  194. package/src/v2/product/extraction/extractionInference.js +1 -1
  195. package/src/v2/product/extraction/extractionResponse.d.ts +1 -1
  196. package/src/v2/product/extraction/extractionResponse.js +1 -1
  197. package/src/v2/product/extraction/extractionResult.d.ts +3 -3
  198. package/src/v2/product/extraction/extractionResult.js +3 -3
  199. package/src/v2/product/extraction/index.d.ts +1 -0
  200. package/src/v2/product/extraction/index.js +1 -0
  201. package/src/v2/product/extraction/params/extractionParameters.d.ts +1 -1
  202. package/src/v2/product/extraction/params/extractionParameters.js +1 -1
  203. package/src/v2/product/extraction/ragDocuments/annotatedBaseField.d.ts +20 -0
  204. package/src/v2/product/extraction/ragDocuments/annotatedBaseField.js +15 -0
  205. package/src/v2/product/extraction/ragDocuments/annotatedFields.d.ts +27 -0
  206. package/src/v2/product/extraction/ragDocuments/annotatedFields.js +57 -0
  207. package/src/v2/product/extraction/ragDocuments/annotatedListField.d.ts +24 -0
  208. package/src/v2/product/extraction/ragDocuments/annotatedListField.js +67 -0
  209. package/src/v2/product/extraction/ragDocuments/annotatedObjectField.d.ts +43 -0
  210. package/src/v2/product/extraction/ragDocuments/annotatedObjectField.js +47 -0
  211. package/src/v2/product/extraction/ragDocuments/annotatedSimpleField.d.ts +15 -0
  212. package/src/v2/product/extraction/ragDocuments/annotatedSimpleField.js +13 -0
  213. package/src/v2/product/extraction/ragDocuments/extractionRagAnnotationResponse.d.ts +25 -0
  214. package/src/v2/product/extraction/ragDocuments/extractionRagAnnotationResponse.js +17 -0
  215. package/src/v2/product/extraction/ragDocuments/fieldFactory.d.ts +12 -0
  216. package/src/v2/product/extraction/ragDocuments/fieldFactory.js +23 -0
  217. package/src/v2/product/extraction/ragDocuments/index.d.ts +7 -0
  218. package/src/v2/product/extraction/ragDocuments/index.js +7 -0
  219. package/src/v2/product/extraction/ragDocuments/params/index.d.ts +2 -0
  220. package/src/v2/product/extraction/ragDocuments/params/index.js +2 -0
  221. package/src/v2/product/extraction/ragDocuments/params/ragDocumentAnnotationParameters.d.ts +27 -0
  222. package/src/v2/product/extraction/ragDocuments/params/ragDocumentAnnotationParameters.js +43 -0
  223. package/src/v2/product/extraction/ragDocuments/params/ragDocumentUploadParameters.d.ts +7 -0
  224. package/src/v2/product/extraction/ragDocuments/params/ragDocumentUploadParameters.js +9 -0
  225. package/src/v2/product/extraction/ragDocuments/ragAnnotation.d.ts +12 -0
  226. package/src/v2/product/extraction/ragDocuments/ragAnnotation.js +9 -0
  227. package/src/v2/product/ocr/ocr.d.ts +1 -1
  228. package/src/v2/product/ocr/ocr.js +1 -1
  229. package/src/v2/product/ocr/ocrInference.d.ts +2 -2
  230. package/src/v2/product/ocr/ocrInference.js +2 -2
  231. package/src/v2/product/ocr/ocrResponse.d.ts +1 -1
  232. package/src/v2/product/ocr/ocrResponse.js +1 -1
  233. package/src/v2/product/ocr/params/ocrParameters.d.ts +1 -1
  234. package/src/v2/product/ocr/params/ocrParameters.js +1 -1
  235. package/src/v2/product/split/params/splitParameters.d.ts +1 -1
  236. package/src/v2/product/split/params/splitParameters.js +1 -1
  237. package/src/v2/product/split/split.d.ts +1 -1
  238. package/src/v2/product/split/split.js +1 -1
  239. package/src/v2/product/split/splitInference.d.ts +1 -1
  240. package/src/v2/product/split/splitInference.js +1 -1
  241. package/src/v2/product/split/splitRange.d.ts +1 -1
  242. package/src/v2/product/split/splitRange.js +2 -2
  243. package/src/v2/product/split/splitResponse.d.ts +1 -1
  244. package/src/v2/product/split/splitResponse.js +1 -1
  245. package/src/v2/product/split/splitResult.js +1 -1
  246. package/src/v2/search/baseSearch.d.ts +2 -2
  247. package/src/v2/search/models/modelSearch.d.ts +3 -3
  248. package/src/v2/search/models/modelSearch.js +3 -3
  249. package/src/v2/search/models/modelSearchParameters.d.ts +1 -1
  250. package/src/v2/search/models/modelSearchParameters.js +1 -1
  251. package/src/v2/search/models/modelSearchResponse.d.ts +2 -2
  252. package/src/v2/search/models/modelSearchResponse.js +2 -2
  253. package/src/v2/search/ragDocuments/ragDocumentSearch.d.ts +3 -3
  254. package/src/v2/search/ragDocuments/ragDocumentSearch.js +3 -3
  255. package/src/v2/search/ragDocuments/ragDocumentSearchParameters.d.ts +1 -1
  256. package/src/v2/search/ragDocuments/ragDocumentSearchParameters.js +1 -1
  257. package/src/v2/search/ragDocuments/ragDocumentSearchResponse.d.ts +2 -2
  258. package/src/v2/search/ragDocuments/ragDocumentSearchResponse.js +2 -2
@@ -1,5 +1,5 @@
1
- import { BaseSearchResponse } from "../../../v2/parsing/search/baseSearchResponse.js";
2
- import { SearchModels } from "../../../v2/parsing/search/searchModels.js";
1
+ import { BaseSearchResponse } from "../../parsing/search/baseSearchResponse.js";
2
+ import { SearchModels } from "../../parsing/search/searchModels.js";
3
3
  /**
4
4
  * Models search response.
5
5
  */
@@ -1,6 +1,6 @@
1
- import { BaseSearch } from "../../../v2/search/baseSearch.js";
2
- import { RagDocumentSearchParameters } from "../../../v2/search/index.js";
3
- import { RagDocumentSearchResponse } from "../../../v2/search/ragDocuments/ragDocumentSearchResponse.js";
1
+ import { BaseSearch } from "../baseSearch.js";
2
+ import { RagDocumentSearchParameters } from "../index.js";
3
+ import { RagDocumentSearchResponse } from "./ragDocumentSearchResponse.js";
4
4
  /**
5
5
  * Search for RAG Documents.
6
6
  */
@@ -1,6 +1,6 @@
1
- import { BaseSearch } from "../../../v2/search/baseSearch.js";
2
- import { RagDocumentSearchParameters } from "../../../v2/search/index.js";
3
- import { RagDocumentSearchResponse } from "../../../v2/search/ragDocuments/ragDocumentSearchResponse.js";
1
+ import { BaseSearch } from "../baseSearch.js";
2
+ import { RagDocumentSearchParameters } from "../index.js";
3
+ import { RagDocumentSearchResponse } from "./ragDocumentSearchResponse.js";
4
4
  /**
5
5
  * Search for RAG Documents.
6
6
  */
@@ -1,4 +1,4 @@
1
- import { BaseSearchParameters, BaseSearchParametersConstructor } from "../../../v2/clientOptions/baseSearchParameters.js";
1
+ import { BaseSearchParameters, BaseSearchParametersConstructor } from "../../clientOptions/baseSearchParameters.js";
2
2
  /**
3
3
  * Constructor parameters for RagDocumentSearchParameters.
4
4
  */
@@ -1,5 +1,5 @@
1
1
  import { MindeeConfigurationError } from "../../../errors/index.js";
2
- import { BaseSearchParameters } from "../../../v2/clientOptions/baseSearchParameters.js";
2
+ import { BaseSearchParameters } from "../../clientOptions/baseSearchParameters.js";
3
3
  /**
4
4
  * Search parameters for RAG Documents.
5
5
  */
@@ -1,6 +1,6 @@
1
1
  import { StringDict } from "../../../parsing/index.js";
2
- import { BaseSearchResponse } from "../../../v2/parsing/search/index.js";
3
- import { SearchRagDocuments } from "../../../v2/parsing/search/searchRagDocuments.js";
2
+ import { BaseSearchResponse } from "../../parsing/search/index.js";
3
+ import { SearchRagDocuments } from "../../parsing/search/searchRagDocuments.js";
4
4
  /**
5
5
  * RAG Documents search response.
6
6
  */
@@ -1,5 +1,5 @@
1
- import { BaseSearchResponse } from "../../../v2/parsing/search/index.js";
2
- import { SearchRagDocuments } from "../../../v2/parsing/search/searchRagDocuments.js";
1
+ import { BaseSearchResponse } from "../../parsing/search/index.js";
2
+ import { SearchRagDocuments } from "../../parsing/search/searchRagDocuments.js";
3
3
  /**
4
4
  * RAG Documents search response.
5
5
  */