✨ add support for client V2 (#359)

Author: sebastianMindee

.github/workflows/_test-code-samples.yml

@@ -35,5 +35,5 @@ jobs:
 
       - name: Tests sample code
         run: |
-          ./tests/test_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }} ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
+          ./tests/test_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }} ${{ secrets.MINDEE_API_KEY_SE_TESTS }} ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }} ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
 

.github/workflows/_test-integrations.yml

@@ -45,4 +45,6 @@ jobs:
         env:
           MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
           WORKFLOW_ID: ${{ secrets.WORKFLOW_ID_SE_TESTS }}
+          MINDEE_V2_API_KEY: ${{ secrets.MINDEE_V2_SE_TESTS_API_KEY }}
+          MINDEE_V2_FINDOC_MODEL_ID: ${{ secrets.MINDEE_V2_SE_TESTS_FINDOC_MODEL_ID }}
         run: npm run test-integration

.github/workflows/pull-request.yml

@@ -3,18 +3,22 @@ name: Pull Request
 on:
   pull_request:
 
+permissions:
+  contents: read
+  pull-requests: read
+
 jobs:
   static_analysis:
-    uses: mindee/mindee-api-nodejs/.github/workflows/_static-analysis.yml@main
+    uses: ./.github/workflows/_static-analysis.yml
   test_units:
-    uses: mindee/mindee-api-nodejs/.github/workflows/_test-units.yml@main
+    uses: ./.github/workflows/_test-units.yml
     needs: static_analysis
     secrets: inherit
   test_integrations:
-    uses: mindee/mindee-api-nodejs/.github/workflows/_test-integrations.yml@main
+    uses: ./.github/workflows/_test-integrations.yml
     needs: test_units
     secrets: inherit
   test_code_samples:
-    uses: mindee/mindee-api-nodejs/.github/workflows/_test-code-samples.yml@main
+    uses: ./.github/workflows/_test-code-samples.yml
     needs: test_units
     secrets: inherit

README.md

@@ -154,27 +154,6 @@ const apiResponse = mindeeClient.parse(
   });
 ```
 
-## Further Reading
-Complete details on the working of the library are available in the following guides: 
-
-* [Node.js Getting Started](https://developers.mindee.com/docs/nodejs-getting-started)
-* [Node.js Generated API](https://developers.mindee.com/docs/nodejs-generated-ocr)
-* [Node.js Custom OCR (Deprecated)](https://developers.mindee.com/docs/nodejs-api-builder)
-* [Node.js Invoice OCR](https://developers.mindee.com/docs/nodejs-invoice-ocr)
-* [Node.js International Id OCR](https://developers.mindee.com/docs/nodejs-international-id-ocr)
-* [Node.js Receipt OCR](https://developers.mindee.com/docs/nodejs-receipt-ocr)
-* [Node.js Resume OCR](https://developers.mindee.com/docs/nodejs-resume-ocr)
-* [Node.js Financial Document OCR](https://developers.mindee.com/docs/nodejs-financial-document-ocr)
-* [Node.js Passport OCR](https://developers.mindee.com/docs/nodejs-passport-ocr)
-* [Node.js FR Bank Account Detail OCR](https://developers.mindee.com/docs/nodejs-fr-bank-account-details-ocr)
-* [Node.js FR Health Card OCR](https://developers.mindee.com/docs/nodejs-fr-health-card-ocr)
-* [Node.js FR ID Card OCR](https://developers.mindee.com/docs/nodejs-fr-carte-nationale-didentite-ocr)
-* [Node.js US Bank Check OCR](https://developers.mindee.com/docs/nodejs-us-bank-check-ocr)
-* [Node.js Barcode Reader API](https://developers.mindee.com/docs/nodejs-barcode-reader-ocr)
-* [Node.js Cropper API](https://developers.mindee.com/docs/nodejs-cropper-ocr)
-* [Node.js Invoice Splitter API](https://developers.mindee.com/docs/nodejs-invoice-splitter-ocr)
-* [Node.js Multi Receipts Detector API](https://developers.mindee.com/docs/nodejs-multi-receipts-detector-ocr)
-
 You can also take a look at the **[Reference Documentation](https://mindee.github.io/mindee-api-nodejs/)**.
 
 ## License

docs/code_samples/default_v2.txt

@@ -0,0 +1,26 @@
+const mindee = require("mindee");
+// for TS or modules:
+// import * as mindee from "mindee";
+
+// Init a new client
+const mindeeClient = new mindee.ClientV2({ apiKey: "MY_API_KEY" });
+const modelId = "MY_MODEL_ID";
+
+// Load a file from disk
+const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
+const params = {
+  modelId: modelId,
+  // If set to `true`, will enable Retrieval-Augmented Generation.
+  rag: false
+};
+
+const apiResponse = mindeeClient.enqueueAndGetInference(
+  inputSource,
+  params
+);
+
+// Handle the response Promise
+apiResponse.then((resp) => {
+  // print a string summary
+  console.log(resp.inference.toString());
+});