@mistralai/mistralai 0.0.5

package/.eslintrc.yml

@@ -0,0 +1,10 @@
+env:
+  browser: true
+  es2021: true
+extends: google
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+rules: 
+  indent: ["error", 2]
+  space-before-function-paren: ["error", "never"]

package/.github/workflows/build_publish.yaml

@@ -0,0 +1,65 @@
+name: Build and Publish
+
+on:
+  push:
+    branches: ["main"]
+    
+    # We only deploy on tags and main branch
+    tags:
+      # Only run on tags that match the following regex
+      # This will match tags like 1.0.0, 1.0.1, etc.
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+  # Build on pull requests
+  pull_request:
+
+jobs:
+  
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # Set node version
+      - name: set node version
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      # Install Build stuff
+      - name: Install Dependencies
+        run: |
+          npm install
+
+        # Ruff
+      - name: ESlint check
+        run: |
+          ./node_modules/.bin/eslint .
+
+  publish:
+    needs: lint
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags')
+
+    steps:
+      # Checkout the repository
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # Set node version
+      - name: set node version
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      # Publish module
+      - name: Publish
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> .npmrc
+          npm version ${{ github.ref_name }}
+          npm publish 
+
+      

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,43 @@
+# Mistral Javascript Client
+
+You can use the Mistral Javascript client to interact with the Mistral AI API
+
+## Installing
+
+You can install the library in your project using:
+
+`npm install mistralai`
+
+## Usage
+
+### Chat
+
+The simplest use case is to chat with Mistral AI models:
+
+```javascript
+const client = require("mistralai");
+
+const response = client.chat('le-tiny', [{role: 'user', content: 'What is your favourite French food, and why is it mayonnaise?'}])
+
+```
+
+You can also use `client.chatStream` for streaming results.
+
+### Embeddings
+
+To use our embedding API you can use the following code:
+
+```javascript
+const client = require('mistralai');
+
+const response = client.embed('le-embed', 'My favourite place to eat mayonnaise is embed');
+```
+
+## Run examples
+
+Examples can be found in the `examples/` directory you can run them using:
+
+```bash
+node [example.js]
+
+```

package/examples/examples.js

@@ -0,0 +1,51 @@
+import MistralClient from '../client.js';
+
+const apiKey = process.env.MISTRAL_API_KEY;
+
+const client = new MistralClient(apiKey);
+
+// LIST MODELS
+const listModelsResponse = await client.listModels();
+
+listModelsResponse.data.forEach((model) => {
+  console.log('Model:', model);
+});
+
+// CHAT
+const chatResponse = await client.chat(
+  'le-tiny-v2312',
+  [{role: 'user', content: 'hello world'}],
+);
+
+console.log('Chat:', chatResponse);
+
+// CHAT STREAM
+const chatStreamResponse = await client.chatStream(
+  'le-tiny-v2312', [{role: 'user', content: 'hello world'}],
+);
+
+for await (const chunk of chatStreamResponse) {
+  console.log('Chat Stream:', '' + chunk);
+}
+
+// chatStreamResponse.data.on('data', (data) => {
+//   console.log('Chat Stream:', '' + data);
+// });
+
+// EMBEDDINGS
+const embeddingsResponse = await client.embeddings('le-embed', 'hello world');
+
+console.log('Embeddings:', embeddingsResponse.data);
+
+
+// EMBEDDINGS BATCH
+
+// Create 100 strings to embed
+const input = [];
+for (let i = 0; i < 10; i++) {
+  input.push('hello world');
+}
+
+const embeddingsBatchResponse = await client.embeddings('le-embed', input);
+
+console.log('Embeddings Batch:', embeddingsBatchResponse.data);

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@mistralai/mistralai",
+  "version": "0.0.5",
+  "description": "",
+  "author": "bam4d@mistral.ai",
+  "license": "ISC",
+  "type": "module",
+  "main": "src/client.js",
+  "dependencies": {
+    "axios": "^1.6.2",
+    "axios-retry": "^4.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.55.0",
+    "eslint-config-google": "^0.14.0",
+    "prettier": "2.8.8"
+  }
+}

package/src/client.js

@@ -0,0 +1,197 @@
+import axios from 'axios';
+import axiosRetry from 'axios-retry';
+
+const RETRY_STATUS_CODES = [429, 500, 502, 503, 504];
+const ENDPOINT = 'http://api.mistral.ai';
+
+/**
+ * MistralClient
+ * @return {MistralClient}
+ */
+class MistralClient {
+  /**
+   *
+   * @param {*} apiKey
+   * @param {*} endpoint
+   */
+  constructor(apiKey, endpoint = ENDPOINT) {
+    this.endpoint = endpoint;
+    this.apiKey = apiKey;
+
+    this.textDecoder = new TextDecoder();
+
+    axiosRetry(axios, {
+      retries: 3,
+      retryCondition: (error) => {
+        return RETRY_STATUS_CODES.includes(error.response.status);
+      },
+
+      retryDelay: (retryCount, error) => {
+        console.debug(`retry attempt: ${retryCount}`, error);
+        return retryCount * 500;
+      },
+    });
+  }
+
+  /**
+   *
+   * @param {*} method
+   * @param {*} path
+   * @param {*} request
+   * @return {Promise<*>}
+   */
+  _request = async function(method, path, request) {
+    const response = await axios({
+      method: method,
+      url: `${this.endpoint}/${path}`,
+      data: request,
+      headers: {
+        'Authorization': `Bearer ${this.apiKey}`,
+      },
+      responseType: request?.stream ? 'stream' : 'json',
+    }).catch((error) => {
+      console.error(error);
+      return error.response;
+    });
+    return response.data;
+  };
+
+  /**
+   * Creates a chat completion request
+   * @param {*} model
+   * @param {*} messages
+   * @param {*} temperature
+   * @param {*} maxTokens
+   * @param {*} topP
+   * @param {*} randomSeed
+   * @param {*} stream
+   * @param {*} safeMode
+   * @return {Promise<Object>}
+   */
+  _makeChatCompletionRequest = function(
+    model,
+    messages,
+    temperature,
+    maxTokens,
+    topP,
+    randomSeed,
+    stream,
+    safeMode,
+  ) {
+    return {
+      model: model,
+      messages: messages,
+      temperature: temperature ?? undefined,
+      maxTokens: maxTokens ?? undefined,
+      topP: topP ?? undefined,
+      randomSeed: randomSeed ?? undefined,
+      stream: stream ?? undefined,
+      safeMode: safeMode ?? undefined,
+    };
+  };
+
+
+  listModels = async function() {
+    const response = await this._request('get', 'v1/models');
+    return response;
+  };
+
+  /**
+   * Chat
+   * @param {*} model
+   * @param {*} messages
+   * @param {*} temperature
+   * @param {*} maxTokens
+   * @param {*} topP
+   * @param {*} randomSeed
+   * @param {*} safeMode
+   * @return {Promise<Object>}
+   */
+  chat = async function(
+    model,
+    messages,
+    temperature,
+    maxTokens,
+    topP,
+    randomSeed,
+    safeMode) {
+    const request = this._makeChatCompletionRequest(
+      model,
+      messages,
+      temperature,
+      maxTokens,
+      topP,
+      randomSeed,
+      false,
+      safeMode,
+    );
+    const response = await this._request(
+      'post', 'v1/chat/completions', request,
+    );
+    return response;
+  };
+
+  /**
+   * Chat with streaming
+   * @param {*} model
+   * @param {*} messages
+   * @param {*} temperature
+   * @param {*} maxTokens
+   * @param {*} topP
+   * @param {*} randomSeed
+   * @param {*} safeMode
+   * @return {Promise<Object>}
+   */
+  chatStream = async function* (
+    model,
+    messages,
+    temperature,
+    maxTokens,
+    topP,
+    randomSeed,
+    safeMode) {
+    const request = this._makeChatCompletionRequest(
+      model,
+      messages,
+      temperature,
+      maxTokens,
+      topP,
+      randomSeed,
+      true,
+      safeMode,
+    );
+    const response = await this._request(
+      'post', 'v1/chat/completions', request,
+    );
+
+    for await (const chunk of response) {
+      const chunkString = this.textDecoder.decode(chunk);
+      if (chunkString.startsWith('data:')) {
+        const chunkData = chunkString.substring(6).trim();
+        if (chunkData !== '[DONE]') {
+          yield JSON.parse(chunkData);
+        }
+      }
+    }
+  };
+
+  /**
+   * Embeddings
+   * @param {*} model
+   * @param {*} input
+   * @return {Promise<Object>}
+   */
+  embeddings = async function(model, input) {
+    const request = {
+      model: model,
+      input: input,
+    };
+    const response = await this._request(
+      'post', 'v1/embeddings', request,
+    );
+    return response;
+  };
+}
+
+
+export default MistralClient;