together-ai 0.3.0 → 0.5.0

package/README.md

@@ -16,21 +16,37 @@
 
 ## Usage
 
-Add open source LLMs to your apps in a few lines of code. Simply create a new Together.ai client, specify your preferred AI model with inputs, and get back a result.
+Create an account at [together.ai](https://www.together.ai/) and add the API key in. Then simply run the code snippet below with your preferred AI model and inputs to get back a reply.
 
 ```js
 import Together from 'together-ai';
 
 const together = new Together({
-  auth: `api token`,
+  auth: process.env.TOGETHER_API_KEY,
 });
 
-const result = await together.inference('mistralai/Mistral-7B-Instruct-v0.1', {
-  prompt: 'tell me about the history of the United States',
+const model = 'mistralai/Mistral-7B-Instruct-v0.1';
+
+const result = await together.inference(model, {
+  prompt: 'Suggest some fun family activities for the new year',
   max_tokens: 300,
 });
 ```
 
+### Streaming with LLMs
+
+If you want to stream, simply specify `stream-tokens: true`.
+
+```js
+const model = 'togethercomputer/llama-2-70b-chat';
+
+const result = await together.inference(model, {
+  prompt: 'Tell me about the history of the United States',
+  max_tokens: 1000,
+  stream_tokens: true,
+});
+```
+
 ## Popular Supported Models
 
 This is a list of popular models that are supported.

package/dist/index.d.ts

@@ -30,6 +30,6 @@ declare class Together {
     });
     inference(model: string, { ...inputs }: {
         [x: string]: any;
-    }): Promise<ApiResponse>;
+    }): Promise<ApiResponse | ReadableStream<Uint8Array>>;
 }
 export default Together;

package/dist/index.js

@@ -39,8 +39,13 @@ class Together {
                 },
                 body: JSON.stringify(Object.assign({ model }, inputs)),
             });
-            const data = yield res.json();
-            return data;
+            if (inputs.stream_tokens === true) {
+                return res.body;
+            }
+            else {
+                const data = yield res.json();
+                return data;
+            }
         });
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "together-ai",
-  "version": "0.3.0",
-  "description": "A Node SDK for Together.ai.",
+  "version": "0.5.0",
+  "description": "Node.js SDK for Together.ai.",
   "author": "Hassan El Mghari (@nutlope)",
   "repository": "Nutlope/together-js",
   "license": "MIT",

package/src/index.ts

@@ -34,6 +34,7 @@ class Together {
     if (!this.authApiKey) {
       throw new Error('Auth key is not set!');
     }
+
     const res = await fetch('https://api.together.xyz/inference', {
       method: 'POST',
       headers: {
@@ -46,9 +47,12 @@ class Together {
       }),
     });
 
-    const data: ApiResponse = await res.json();
-
-    return data;
+    if (inputs.stream_tokens === true) {
+      return res.body;
+    } else {
+      const data: ApiResponse = await res.json();
+      return data;
+    }
   }
 }