@mistralai/mistralai 1.4.0 → 1.5.1

package/README.md

@@ -190,11 +190,11 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.embeddings.create({
+    model: "mistral-embed",
     inputs: [
       "Embed this sentence.",
       "As well as this one.",
     ],
-    model: "mistral-embed",
   });
 
   // Handle the result
@@ -283,6 +283,10 @@ We have dedicated SDKs for the following providers:
 * [archive](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model
 * [unarchive](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
 
+### [ocr](docs/sdks/ocr/README.md)
+
+* [process](docs/sdks/ocr/README.md#process) - OCR
+
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -687,6 +691,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`modelsRetrieve`](docs/sdks/models/README.md#retrieve) - Retrieve Model
 - [`modelsUnarchive`](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model
 - [`modelsUpdate`](docs/sdks/models/README.md#update) - Update Fine Tuned Model
+- [`ocrProcess`](docs/sdks/ocr/README.md#process) - OCR
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->

package/docs/sdks/classifiers/README.md

@@ -25,6 +25,7 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.classifiers.moderate({
+    model: "V90",
     inputs: [
       "<value>",
     ],
@@ -53,6 +54,7 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await classifiersModerate(mistral, {
+    model: "V90",
     inputs: [
       "<value>",
     ],
@@ -106,6 +108,7 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.classifiers.moderateChat({
+    model: "Roadster",
     inputs: [
       [
         {
@@ -136,7 +139,7 @@ async function run() {
         },
       ],
     ],
-    model: "Roadster",
+    truncateForContextLength: false,
   });
 
   // Handle the result
@@ -162,6 +165,7 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await classifiersModerateChat(mistral, {
+    model: "Roadster",
     inputs: [
       [
         {
@@ -192,7 +196,7 @@ async function run() {
         },
       ],
     ],
-    model: "Roadster",
+    truncateForContextLength: false,
   });
 
   if (!res.ok) {
@@ -212,7 +216,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.ChatClassificationRequest](../../models/components/chatclassificationrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.ChatModerationRequest](../../models/components/chatmoderationrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |

package/docs/sdks/embeddings/README.md

@@ -24,11 +24,11 @@ const mistral = new Mistral({
 
 async function run() {
   const result = await mistral.embeddings.create({
+    model: "mistral-embed",
     inputs: [
       "Embed this sentence.",
       "As well as this one.",
     ],
-    model: "mistral-embed",
   });
 
   // Handle the result
@@ -54,11 +54,11 @@ const mistral = new MistralCore({
 
 async function run() {
   const res = await embeddingsCreate(mistral, {
+    model: "mistral-embed",
     inputs: [
       "Embed this sentence.",
       "As well as this one.",
     ],
-    model: "mistral-embed",
   });
 
   if (!res.ok) {

package/docs/sdks/ocr/README.md

@@ -0,0 +1,93 @@
+# Ocr
+(*ocr*)
+
+## Overview
+
+OCR API
+
+### Available Operations
+
+* [process](#process) - OCR
+
+## process
+
+OCR
+
+### Example Usage
+
+```typescript
+import { Mistral } from "@mistralai/mistralai";
+
+const mistral = new Mistral({
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await mistral.ocr.process({
+    model: "Focus",
+    document: {
+      documentUrl: "https://dutiful-horst.org",
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { MistralCore } from "@mistralai/mistralai/core.js";
+import { ocrProcess } from "@mistralai/mistralai/funcs/ocrProcess.js";
+
+// Use `MistralCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const mistral = new MistralCore({
+  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await ocrProcess(mistral, {
+    model: "Focus",
+    document: {
+      documentUrl: "https://dutiful-horst.org",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.OCRRequest](../../models/components/ocrrequest.md)                                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.OCRResponse](../../models/components/ocrresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/examples/README.md

@@ -5,25 +5,35 @@ Below is a guide how to run the examples if you have cloned this repo.
 ## Prerequisites
 
 - Node.js v18+
-- `cp .env.template .env` and fill in the fields corresponding to the examples you want to run.
 
-## Install
+## How to run the examples locally
 
-- You'll need to run `npm install` in the root of the repository
-- You'll need to run `npm install` in `packages/gcp` directory
-- You'll need to run `npm install` in `packages/azure` directory
-- Finally, you'll need to run `npm install` in this `examples` directory
-
-## Run
-
-```
-npm run script -- ./src/chat_streaming.ts
+### Install the npm dependencies or the repository and the `examples` directory
+```properties
+npm install && npm install --prefix examples
 ```
 
-## Test
+### Set your environment variables
+```properties
+cp examples/.env.template examples/.env
+# Edit your .env file
+```
 
-The following will run all `examples` directory:
+### [Dev only] Link the local `mistralai` package
 
+If you want to use the local `mistralai` package, you can link it to the examples directory. From the repository's root:
+```properties
+npm run build
+npm link
+(cd examples/src && npm link @mistralai/mistralai)
 ```
-npm run test
+
+### Run the examples
+```properties
+npm run test --prefix examples
 ```
+
+If you just want to run one example file, you can do so with:
+```properties
+npm run test --prefix examples -- --files src/stag_async_moderation.ts
+```

package/examples/package-lock.json

@@ -11,7 +11,8 @@
       "dependencies": {
         "@mistralai/mistralai": "file:../",
         "@mistralai/mistralai-azure": "file:../packages/mistralai-azure",
-        "@mistralai/mistralai-gcp": "file:../packages/mistralai-gcp"
+        "@mistralai/mistralai-gcp": "file:../packages/mistralai-gcp",
+        "yargs": "^17.0.0"
       },
       "devDependencies": {
         "@types/node": "^20.11.4",
@@ -22,7 +23,10 @@
     },
     "..": {
       "name": "@mistralai/mistralai",
-      "version": "1.4.0",
+      "version": "1.5.1",
+      "dependencies": {
+        "zod-to-json-schema": "^3.24.1"
+      },
       "devDependencies": {
         "@typescript-eslint/eslint-plugin": "^7.7.1",
         "@typescript-eslint/parser": "^7.7.1",
@@ -38,7 +42,7 @@
     },
     "../packages/mistralai-azure": {
       "name": "@mistralai/mistralai-azure",
-      "version": "1.3.6",
+      "version": "1.4.0",
       "devDependencies": {
         "@typescript-eslint/eslint-plugin": "^7.7.1",
         "@typescript-eslint/parser": "^7.7.1",
@@ -54,7 +58,7 @@
     },
     "../packages/mistralai-gcp": {
       "name": "@mistralai/mistralai-gcp",
-      "version": "1.3.6",
+      "version": "1.4.0",
       "dependencies": {
         "google-auth-library": "^9.11.0"
       },
@@ -573,11 +577,97 @@
         "balanced-match": "^1.0.0"
       }
     },
+    "node_modules/cliui": {
+      "version": "8.0.1",
+      "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+      "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+      "license": "ISC",
+      "dependencies": {
+        "string-width": "^4.2.0",
+        "strip-ansi": "^6.0.1",
+        "wrap-ansi": "^7.0.0"
+      },
+      "engines": {
+        "node": ">=12"
+      }
+    },
+    "node_modules/cliui/node_modules/ansi-regex": {
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+      "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/cliui/node_modules/ansi-styles": {
+      "version": "4.3.0",
+      "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+      "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+      "license": "MIT",
+      "dependencies": {
+        "color-convert": "^2.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      },
+      "funding": {
+        "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+      }
+    },
+    "node_modules/cliui/node_modules/emoji-regex": {
+      "version": "8.0.0",
+      "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+      "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
+      "license": "MIT"
+    },
+    "node_modules/cliui/node_modules/string-width": {
+      "version": "4.2.3",
+      "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+      "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+      "license": "MIT",
+      "dependencies": {
+        "emoji-regex": "^8.0.0",
+        "is-fullwidth-code-point": "^3.0.0",
+        "strip-ansi": "^6.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/cliui/node_modules/strip-ansi": {
+      "version": "6.0.1",
+      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+      "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+      "license": "MIT",
+      "dependencies": {
+        "ansi-regex": "^5.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/cliui/node_modules/wrap-ansi": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+      "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+      "license": "MIT",
+      "dependencies": {
+        "ansi-styles": "^4.0.0",
+        "string-width": "^4.1.0",
+        "strip-ansi": "^6.0.0"
+      },
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+      }
+    },
     "node_modules/color-convert": {
       "version": "2.0.1",
       "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
       "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
-      "dev": true,
       "license": "MIT",
       "dependencies": {
         "color-name": "~1.1.4"
@@ -590,7 +680,6 @@
       "version": "1.1.4",
       "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
       "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
-      "dev": true,
       "license": "MIT"
     },
     "node_modules/cross-spawn": {
@@ -662,6 +751,15 @@
         "@esbuild/win32-x64": "0.23.1"
       }
     },
+    "node_modules/escalade": {
+      "version": "3.2.0",
+      "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz",
+      "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=6"
+      }
+    },
     "node_modules/foreground-child": {
       "version": "3.3.0",
       "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.0.tgz",
@@ -694,6 +792,15 @@
         "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
       }
     },
+    "node_modules/get-caller-file": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+      "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
+      "license": "ISC",
+      "engines": {
+        "node": "6.* || 8.* || >= 10.*"
+      }
+    },
     "node_modules/get-tsconfig": {
       "version": "4.8.1",
       "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.8.1.tgz",
@@ -735,7 +842,6 @@
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
       "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
-      "dev": true,
       "license": "MIT",
       "engines": {
         "node": ">=8"
@@ -853,6 +959,15 @@
         "url": "https://github.com/prettier/prettier?sponsor=1"
       }
     },
+    "node_modules/require-directory": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+      "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/resolve-pkg-maps": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz",
@@ -1143,6 +1258,83 @@
       "engines": {
         "node": ">=8"
       }
+    },
+    "node_modules/y18n": {
+      "version": "5.0.8",
+      "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+      "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
+      "license": "ISC",
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/yargs": {
+      "version": "17.7.2",
+      "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
+      "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==",
+      "license": "MIT",
+      "dependencies": {
+        "cliui": "^8.0.1",
+        "escalade": "^3.1.1",
+        "get-caller-file": "^2.0.5",
+        "require-directory": "^2.1.1",
+        "string-width": "^4.2.3",
+        "y18n": "^5.0.5",
+        "yargs-parser": "^21.1.1"
+      },
+      "engines": {
+        "node": ">=12"
+      }
+    },
+    "node_modules/yargs-parser": {
+      "version": "21.1.1",
+      "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+      "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
+      "license": "ISC",
+      "engines": {
+        "node": ">=12"
+      }
+    },
+    "node_modules/yargs/node_modules/ansi-regex": {
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+      "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/yargs/node_modules/emoji-regex": {
+      "version": "8.0.0",
+      "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+      "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==",
+      "license": "MIT"
+    },
+    "node_modules/yargs/node_modules/string-width": {
+      "version": "4.2.3",
+      "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+      "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+      "license": "MIT",
+      "dependencies": {
+        "emoji-regex": "^8.0.0",
+        "is-fullwidth-code-point": "^3.0.0",
+        "strip-ansi": "^6.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      }
+    },
+    "node_modules/yargs/node_modules/strip-ansi": {
+      "version": "6.0.1",
+      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+      "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+      "license": "MIT",
+      "dependencies": {
+        "ansi-regex": "^5.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      }
     }
   }
 }

package/examples/package.json

@@ -18,7 +18,8 @@
   "dependencies": {
     "@mistralai/mistralai": "file:../",
     "@mistralai/mistralai-azure": "file:../packages/mistralai-azure",
-    "@mistralai/mistralai-gcp": "file:../packages/mistralai-gcp"
+    "@mistralai/mistralai-gcp": "file:../packages/mistralai-gcp",
+    "yargs": "^17.0.0"
   },
   "devDependencies": {
     "glob": "^11.0.0",

package/examples/src/async_ocr_process_from_file.ts

@@ -0,0 +1,33 @@
+import { Mistral } from '@mistralai/mistralai';
+import fs from 'fs';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new Mistral({ apiKey: apiKey });
+
+
+const file_path = "/path/to/uploaded_file.pdf"
+const uploaded_file = fs.readFileSync(file_path);
+const uploaded_pdf = await client.files.upload({
+    file: {
+        fileName: "uploaded_file.pdf",
+        content: uploaded_file,
+    },
+    purpose: "ocr"
+});
+
+client.files.retrieve({ fileId: uploaded_pdf.id })
+
+const signed_url = client.files.getSignedUrl({ fileId: uploaded_pdf.id })
+
+
+
+const ocrResponse = await client.ocr.process({
+    model: "mistral-ocr-latest",
+    document: {
+        type: "document_url",
+        documentUrl: "https://arxiv.org/pdf/2201.04234"
+    },
+    include_image_base64: true
+});
+console.log("OCR ", ocrResponse);

package/examples/src/async_ocr_process_from_url.ts

@@ -0,0 +1,15 @@
+import { Mistral } from '@mistralai/mistralai';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+const client = new Mistral({ apiKey: apiKey });
+
+const ocrResponse = await client.ocr.process({
+    model: "mistral-ocr-latest",
+    document: {
+        type: "document_url",
+        documentUrl: "https://arxiv.org/pdf/2201.04234"
+    },
+    include_image_base64: true
+});
+
+console.log("OCR:", ocrResponse);