mindee 5.6.0 → 5.7.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 (85) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/package.json +1 -3
  3. package/src/http/apiCore.d.ts +0 -7
  4. package/src/http/apiCore.js +0 -11
  5. package/src/http/baseSettings.js +2 -2
  6. package/src/http/dispatcher.d.ts +6 -0
  7. package/src/http/dispatcher.js +17 -0
  8. package/src/http/index.d.ts +1 -0
  9. package/src/http/index.js +1 -0
  10. package/src/input/urlInput.js +3 -2
  11. package/src/v1/http/baseEndpoint.d.ts +15 -0
  12. package/src/v1/http/baseEndpoint.js +17 -0
  13. package/src/v1/http/endpoint.d.ts +2 -5
  14. package/src/v1/http/endpoint.js +6 -6
  15. package/src/v1/http/workflowEndpoint.d.ts +2 -5
  16. package/src/v1/http/workflowEndpoint.js +5 -5
  17. package/src/v2/client.d.ts +9 -0
  18. package/src/v2/client.js +18 -1
  19. package/src/v2/clientOptions/{baseParameters.d.ts → baseProductParameters.d.ts} +7 -19
  20. package/src/v2/clientOptions/baseProductParameters.js +30 -0
  21. package/src/v2/clientOptions/baseSearchParameters.d.ts +26 -0
  22. package/src/v2/clientOptions/baseSearchParameters.js +23 -0
  23. package/src/v2/clientOptions/index.d.ts +2 -1
  24. package/src/v2/clientOptions/index.js +2 -1
  25. package/src/v2/http/mindeeApiV2.d.ts +16 -15
  26. package/src/v2/http/mindeeApiV2.js +33 -32
  27. package/src/v2/index.d.ts +2 -1
  28. package/src/v2/index.js +1 -0
  29. package/src/v2/parsing/inference/field/listField.d.ts +1 -1
  30. package/src/v2/parsing/inference/field/listField.js +9 -9
  31. package/src/v2/parsing/search/baseSearchResponse.d.ts +18 -0
  32. package/src/v2/parsing/search/baseSearchResponse.js +17 -0
  33. package/src/v2/parsing/search/index.d.ts +2 -0
  34. package/src/v2/parsing/search/index.js +2 -0
  35. package/src/v2/parsing/search/searchModels.d.ts +6 -0
  36. package/src/v2/parsing/search/searchModels.js +19 -0
  37. package/src/v2/parsing/search/searchRagDocument.d.ts +35 -0
  38. package/src/v2/parsing/search/searchRagDocument.js +16 -0
  39. package/src/v2/parsing/search/searchRagDocuments.d.ts +9 -0
  40. package/src/v2/parsing/search/searchRagDocuments.js +26 -0
  41. package/src/v2/parsing/search/searchResponse.d.ts +3 -13
  42. package/src/v2/parsing/search/searchResponse.js +3 -17
  43. package/src/v2/product/baseProduct.d.ts +5 -2
  44. package/src/v2/product/baseProduct.js +3 -0
  45. package/src/v2/product/classification/classification.d.ts +3 -3
  46. package/src/v2/product/classification/classification.js +3 -3
  47. package/src/v2/product/classification/params/classificationParameters.d.ts +4 -18
  48. package/src/v2/product/classification/params/classificationParameters.js +3 -17
  49. package/src/v2/product/crop/crop.d.ts +3 -3
  50. package/src/v2/product/crop/crop.js +3 -3
  51. package/src/v2/product/crop/params/cropParameters.d.ts +4 -18
  52. package/src/v2/product/crop/params/cropParameters.js +3 -17
  53. package/src/v2/product/extraction/extraction.d.ts +3 -3
  54. package/src/v2/product/extraction/extraction.js +3 -3
  55. package/src/v2/product/extraction/params/extractionParameters.d.ts +5 -21
  56. package/src/v2/product/extraction/params/extractionParameters.js +12 -32
  57. package/src/v2/product/ocr/ocr.d.ts +3 -3
  58. package/src/v2/product/ocr/ocr.js +3 -3
  59. package/src/v2/product/ocr/params/ocrParameters.d.ts +4 -18
  60. package/src/v2/product/ocr/params/ocrParameters.js +3 -17
  61. package/src/v2/product/split/params/splitParameters.d.ts +4 -18
  62. package/src/v2/product/split/params/splitParameters.js +3 -17
  63. package/src/v2/product/split/split.d.ts +3 -3
  64. package/src/v2/product/split/split.js +3 -3
  65. package/src/v2/search/baseSearch.d.ts +15 -0
  66. package/src/v2/search/baseSearch.js +19 -0
  67. package/src/v2/search/index.d.ts +6 -0
  68. package/src/v2/search/index.js +6 -0
  69. package/src/v2/search/models/index.d.ts +3 -0
  70. package/src/v2/search/models/index.js +3 -0
  71. package/src/v2/search/models/modelSearch.d.ts +14 -0
  72. package/src/v2/search/models/modelSearch.js +20 -0
  73. package/src/v2/search/models/modelSearchParameters.d.ts +24 -0
  74. package/src/v2/search/models/modelSearchParameters.js +22 -0
  75. package/src/v2/search/models/modelSearchResponse.d.ts +14 -0
  76. package/src/v2/search/models/modelSearchResponse.js +14 -0
  77. package/src/v2/search/ragDocuments/index.d.ts +3 -0
  78. package/src/v2/search/ragDocuments/index.js +3 -0
  79. package/src/v2/search/ragDocuments/ragDocumentSearch.d.ts +14 -0
  80. package/src/v2/search/ragDocuments/ragDocumentSearch.js +20 -0
  81. package/src/v2/search/ragDocuments/ragDocumentSearchParameters.d.ts +24 -0
  82. package/src/v2/search/ragDocuments/ragDocumentSearchParameters.js +24 -0
  83. package/src/v2/search/ragDocuments/ragDocumentSearchResponse.d.ts +14 -0
  84. package/src/v2/search/ragDocuments/ragDocumentSearchResponse.js +14 -0
  85. package/src/v2/clientOptions/baseParameters.js +0 -42
@@ -1,42 +0,0 @@
1
- import { FormData } from "undici";
2
- import { MindeeConfigurationError } from "../../errors/index.js";
3
- /**
4
- * Parameters accepted by all v2 products.
5
- *
6
- * All fields are optional except `modelId`.
7
- *
8
- * @category ClientV2
9
- * @example
10
- * const params = {
11
- * modelId: "YOUR_MODEL_ID",
12
- * rag: true,
13
- * alias: "YOUR_ALIAS",
14
- * webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
15
- * };
16
- */
17
- export class BaseParameters {
18
- constructor(params) {
19
- if (params.modelId === undefined || params.modelId === null || params.modelId === "") {
20
- throw new MindeeConfigurationError("Model ID must be provided");
21
- }
22
- this.modelId = params.modelId;
23
- this.alias = params.alias;
24
- this.webhookIds = params.webhookIds;
25
- this.closeFile = params.closeFile;
26
- }
27
- /**
28
- * Returns the form data to send to the API.
29
- * @returns A `FormData` object.
30
- */
31
- getFormData() {
32
- const form = new FormData();
33
- form.set("model_id", this.modelId);
34
- if (this.alias !== undefined && this.alias !== null) {
35
- form.set("alias", this.alias);
36
- }
37
- if (this.webhookIds && this.webhookIds.length > 0) {
38
- form.set("webhook_ids", this.webhookIds.join(","));
39
- }
40
- return form;
41
- }
42
- }