Skip to content

Commit

Permalink
rename
Browse files Browse the repository at this point in the history
Signed-off-by: Matteo Collina <[email protected]>
  • Loading branch information
mcollina committed Apr 14, 2024
1 parent e33a2f3 commit 00987a6
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 10 deletions.
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# when we run npm version, we don't want to create a git tag
git-tag-version=false
package-lock=true
13 changes: 13 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2024 Platformatic

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.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
This javascript client is inspired from [cohere-typescript](https://github.com/cohere-ai/cohere-typescript)
Forked from https://github.com/mistralai/client-js because the original monkey-patched `fetch()`.

# Mistral Javascript Client

Expand All @@ -8,14 +9,14 @@ You can use the Mistral Javascript client to interact with the Mistral AI API.

You can install the library in your project using:

`npm install @mistralai/mistralai`
`npm install @platformatic/mistral-client`

## Usage

### Set up

```typescript
import MistralClient from '@mistralai/mistralai';
import MistralClient from '@platformatic/mistral-client';

const apiKey = process.env.MISTRAL_API_KEY || 'your_api_key';

Expand Down Expand Up @@ -117,7 +118,7 @@ node chat_with_streaming.js
After the env variable setup the client will find the `MISTRAL_API_KEY` by itself

```typescript
import MistralClient from '@mistralai/mistralai';
import MistralClient from '@platformatic/mistral-client';

const client = new MistralClient();
```
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "@mistralai/mistralai",
"name": "@platformatic/mistral-client",
"version": "0.0.1",
"description": "",
"author": "[email protected]",
"license": "ISC",
"license": "Apache-2.0",
"type": "module",
"main": "src/client.js",
"scripts": {
Expand All @@ -15,7 +15,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/mistralai/client-js"
"url": "https://github.com/platformatic/mistral-client"
},
"types": "src/client.d.ts",
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion src/client.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
declare module '@mistralai/mistralai' {
declare module '@platformatic/mistral-client' {
export interface ModelPermission {
id: string;
object: 'model_permission';
Expand Down

0 comments on commit 00987a6

Please sign in to comment.