use base64

Author: ianardee

src/authentication.ts

@@ -23,13 +23,15 @@ export default {
     {
       computed: false,
       key: "connectionName",
+      label: "Connection Name",
       required: true,
       type: "string",
-      helpText: "Name of the connection.",
+      helpText: "Name of the connection, should be in the format: `MindeeV2-` + your API key's name",
     },
     {
       computed: false,
       key: "apiKey",
+      label: "API Key",
       required: true,
       type: "password",
       helpText:

src/constants.ts

@@ -1,5 +1,5 @@
 import packageJson from "../package.json" with { type: "json" };
 
-export const MINDEE_V2_BASE_URL = "https://api-v2.mindee.net";
+export const MINDEE_V2_BASE_URL = process.env["MINDEE_V2_BASE_URL"] ?? "https://api-v2.mindee.net";
 
 export const appVersion = packageJson.version;

src/v2/api/inputFields.ts

@@ -14,11 +14,11 @@ const optionChoices: FieldChoices = [
 export const inferenceCreateFields = defineInputFields([
   {
     key: "modelId",
-    label: "Model ID",
+    label: "Model to Use",
     required: true,
     type: "string",
-    dynamic: "search_models.id.name",
-    helpText: "Start typing to search a model by name...",
+    dynamic: "v2_search_models.id.name",
+    helpText: "The model to use.",
   },
   {
     key: "file",
@@ -40,44 +40,44 @@ export const inferenceCreateFields = defineInputFields([
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Calculate confidence scores for values, and fill the confidence attribute of fields." +
-      " Useful for automation.",
+      "Enable automated workflows by enhancing model accuracy and measuring field confidence.",
   },
   {
     key: "polygon",
-    label: "Enable Confidence Scores",
+    label: "Enable Polygons (Bounding Boxes)",
     type: "string",
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Calculate bounding box polygons for all fields and fill the `locations` attribute.",
+      "Add the polygon coordinates of each extracted field to the API response.",
   },
   {
     key: "rag",
-    label: "Enable Confidence Scores",
+    label: "Enable RAG (Continuous Learning)",
     type: "string",
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Enhance extraction accuracy with Retrieval-Augmented Generation.",
+      "Enhance extraction accuracy with Retrieval-Augmented Generation using your own documents.",
   },
   {
     key: "rawText",
-    label: "Enable Confidence Scores",
+    label: "Enable Raw Text (Full OCR)",
     type: "string",
     choices: optionChoices,
     default: optionDefault,
     helpText:
-      "Extract full document text as strings and fill the `rawText` attribute.",
+      "Add the full text content of your documents to the API response.",
   },
 ]);
 
 export const pollingFields = defineInputFields([
   {
     key: "maxPollingTimeOut",
+    label: "Polling Timeout",
     required: true,
     default: "180",
     type: "number",
-    helpText: "Maximum polling timeout in seconds."
+    helpText: "Stop attempting to poll for the result after this number of seconds. Raises an error when reached."
   },
 ]);

src/v2/api/requests.ts

@@ -79,6 +79,7 @@ export function setupEnqueueForm(bundle: Bundle): FormData {
   const form = new FormData();
 
   form.append("model_id", bundle.inputData.modelId);
+  // Zapier sends the file as a base64 string, so we cannot use the 'file' field.
   form.append("file_base64", bundle.inputData.file);
 
   if (bundle.inputData.alias) {

src/v2/test/creates/enqueue.test.ts

@@ -8,19 +8,30 @@ import fs from "node:fs";
 const appTester = zapier.createAppTester(App);
 zapier.tools.env.inject();
 
+const modelId = process.env["MINDEE_V2_FINDOC_MODEL_ID"];
+const bundle: any = {
+  authData: {
+    apiKey: process.env["MINDEE_V2_API_KEY"],
+  },
+  inputData: {
+    file: fs.readFileSync(blankPdfPath).toString("base64"),
+    modelId: modelId,
+    alias: "zapier-test-enqueue",
+  }
+};
+
 describe("creates.enqueue", () => {
-  it("should run", async () => {
-    const bundle = {
-      authData: { apiKey: process.env["MINDEE_V2_API_KEY"] },
-      inputData: {
-        file: fs.createReadStream(blankPdfPath),
-        modelId: process.env["MINDEE_V2_FINDOC_MODEL_ID"],
-      }
-    };
+  it("should run with default options", async () => {
+    delete bundle.inputData["polygon"];
+    delete bundle.inputData["confidence"];
 
     // @ts-expect-error TBD
-    const results = await appTester(App.creates["v2_enqueue"].operation.perform, bundle);
-    expect(results).toBeDefined();
-    // TODO: add more assertions
+    const response: any = await appTester(App.creates["v2_enqueue"].operation.perform, bundle);
+    expect(response).toBeInstanceOf(Object);
+    expect(response.job).toBeInstanceOf(Object);
+    expect(response.job.status).toEqual("Processing");
+    expect(response.job.model_id).toEqual(modelId);
+    expect(response.job.alias).toEqual("zapier-test-enqueue");
+    expect(response.job.error).toBeNull;
   }, 6000);
 });

src/v2/test/creates/enqueue_and_get_inference.test.ts

@@ -8,19 +8,36 @@ import fs from "node:fs";
 const appTester = zapier.createAppTester(App);
 zapier.tools.env.inject();
 
+const modelId = process.env["MINDEE_V2_FINDOC_MODEL_ID"];
+const bundle: any = {
+  authData: {
+    apiKey: process.env["MINDEE_V2_API_KEY"],
+  },
+  inputData: {
+    file: fs.readFileSync(blankPdfPath).toString("base64"),
+    modelId: modelId,
+    alias: "zapier-test-enqueue-get-inference",
+  }
+};
+
 describe("creates.enqueue_and_get_inference", () => {
   it("should run", async () => {
-    const bundle = {
-      authData: { apiKey: process.env["MINDEE_V2_API_KEY"] },
-      inputData: {
-        file: fs.createReadStream(blankPdfPath),
-        modelId: process.env["MINDEE_V2_FINDOC_MODEL_ID"],
-      }
-    };
+    delete bundle.inputData["polygon"];
+    delete bundle.inputData["confidence"];
 
     // @ts-expect-error TBD
-    const results = await appTester(App.creates["v2_enqueue_and_get_inference"].operation.perform, bundle);
-    expect(results).toBeDefined();
-    // TODO: add more assertions
+    const results: any = await appTester(App.creates["v2_enqueue_and_get_inference"].operation.perform, bundle);
+    expect(results).toBeInstanceOf(Object);
+    expect(results.inference).toBeInstanceOf(Object);
+    expect(results.inference.model.id).toEqual(modelId);
+
+    expect(results.inference.active_options).toBeInstanceOf(Object);
+    expect(results.inference.active_options.rag).toEqual(false);
+
+    expect(results.inference.file).toBeInstanceOf(Object);
+    expect(results.inference.file.mime_type).toEqual("application/pdf");
+
+    expect(results.inference.result).toBeInstanceOf(Object);
+    expect(results.inference.result.fields).toBeInstanceOf(Object);
   }, 20000);
 });

src/v2/test/searches/inference.test.ts

@@ -12,7 +12,9 @@ zapier.tools.env.inject();
 describe("searches.inference", () => {
   it("Non-existing inference ID – must raise 4xx", async () => {
     const bundle = {
-      authData: { apiKey: process.env["MINDEE_V2_API_KEY"] },
+      authData: {
+        apiKey: process.env["MINDEE_V2_API_KEY"],
+      },
       inputData: {
         inferenceId: "fc405e37-4ba4-4d03-aeba-533a8d1f0f21",
       }

src/v2/test/searches/inference_by_polling.test.ts

@@ -12,7 +12,9 @@ zapier.tools.env.inject();
 describe("searches.inference", () => {
   it("Non-existing job ID – must raise 4xx", async () => {
     const bundle = {
-      authData: { apiKey: process.env["MINDEE_V2_API_KEY"] },
+      authData: {
+        apiKey: process.env["MINDEE_V2_API_KEY"],
+      },
       inputData: {
         jobId: "fc405e37-4ba4-4d03-aeba-533a8d1f0f21",
       }