release: 0.6.0-alpha.5

.github/workflows/release-doctor.yml

@@ -1,6 +1,8 @@
 name: Release Doctor
 on:
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:
@@ -17,3 +19,4 @@ jobs:
           bash ./bin/check-release-environment
         env:
           NPM_TOKEN: ${{ secrets.TOGETHER_NPM_TOKEN || secrets.NPM_TOKEN }}
+

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.6.0-alpha.4"
+  ".": "0.6.0-alpha.5"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 15
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2FTogetherAI-aa19594b663913393bdbc1b56903615e4eb84c6ebc60617ab2f451ede8a730c2.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2FTogetherAI-4d2d6b953f3918f01c022b00942571be9241e37a4e6877444e0353913f21cba0.yml

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.6.0-alpha.5 (2024-08-20)
+
+Full Changelog: [v0.6.0-alpha.4...v0.6.0-alpha.5](https://github.com/togethercomputer/together-typescript/compare/v0.6.0-alpha.4...v0.6.0-alpha.5)
+
+### Features
+
+* **api:** manual updates ([#31](https://github.com/togethercomputer/together-typescript/issues/31)) ([52c8005](https://github.com/togethercomputer/together-typescript/commit/52c800544043060963bf09ef10d3596d3855a86e))
+* **api:** OpenAPI spec update via Stainless API ([#28](https://github.com/togethercomputer/together-typescript/issues/28)) ([9544a3f](https://github.com/togethercomputer/together-typescript/commit/9544a3f961b816fd59338db99b5f9b499dbfe832))
+* **api:** OpenAPI spec update via Stainless API ([#36](https://github.com/togethercomputer/together-typescript/issues/36)) ([0154ccf](https://github.com/togethercomputer/together-typescript/commit/0154ccf0758b9ec9117b5a399eade3e51f49c5fd))
+* **api:** OpenAPI spec update via Stainless API ([#39](https://github.com/togethercomputer/together-typescript/issues/39)) ([a141abb](https://github.com/togethercomputer/together-typescript/commit/a141abb2184e99a291eb5ea634fda71fca85f47b))
+
+
+### Chores
+
+* **ci:** bump prism mock server version ([#35](https://github.com/togethercomputer/together-typescript/issues/35)) ([2723c30](https://github.com/togethercomputer/together-typescript/commit/2723c30cd88f69fb77442faeb8a316bf1c5cde88))
+* **ci:** minor changes ([#34](https://github.com/togethercomputer/together-typescript/issues/34)) ([54b4da5](https://github.com/togethercomputer/together-typescript/commit/54b4da54aeec098d154486f09ba52f6e8bc3f715))
+* **examples:** minor formatting changes ([#38](https://github.com/togethercomputer/together-typescript/issues/38)) ([35f5465](https://github.com/togethercomputer/together-typescript/commit/35f546552c433af8d518db0b44f7fcd473c02eab))
+* force eslint to use non flat config ([#33](https://github.com/togethercomputer/together-typescript/issues/33)) ([a327432](https://github.com/togethercomputer/together-typescript/commit/a327432973bc4f245ec272dcd58a7d0a4f117c09))
+* **internal:** codegen related update ([#32](https://github.com/togethercomputer/together-typescript/issues/32)) ([edd1691](https://github.com/togethercomputer/together-typescript/commit/edd16911c877b06679f6f7759486e2ed442c94c5))
+* **internal:** codegen related update ([#37](https://github.com/togethercomputer/together-typescript/issues/37)) ([12be697](https://github.com/togethercomputer/together-typescript/commit/12be697f897f91ce94edd5ec5fca6abe236a5135))
+
 ## 0.6.0-alpha.4 (2024-07-16)
 
 Full Changelog: [v0.6.0-alpha.3...v0.6.0-alpha.4](https://github.com/togethercomputer/together-typescript/compare/v0.6.0-alpha.3...v0.6.0-alpha.4)

README.md

@@ -22,12 +22,12 @@ The full API of this library can be found in [api.md](api.md).
 ```js
 import Together from 'together-ai';
 
-const together = new Together({
+const client = new Together({
   apiKey: process.env['TOGETHER_API_KEY'], // This is the default and can be omitted
 });
 
 async function main() {
-  const chatCompletion = await together.chat.completions.create({
+  const chatCompletion = await client.chat.completions.create({
     messages: [{ role: 'user', content: 'Say this is a test!' }],
     model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
   });
@@ -45,9 +45,9 @@ We provide support for streaming responses using Server Sent Events (SSE).
 ```ts
 import Together from 'together-ai';
 
-const together = new Together();
+const client = new Together();
 
-const stream = await together.chat.completions.create({
+const stream = await client.chat.completions.create({
   messages: [{ role: 'user', content: 'Say this is a test' }],
   model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
   stream: true,
@@ -68,7 +68,7 @@ This library includes TypeScript definitions for all request params and response
 ```ts
 import Together from 'together-ai';
 
-const together = new Together({
+const client = new Together({
   apiKey: process.env['TOGETHER_API_KEY'], // This is the default and can be omitted
 });
 
@@ -77,7 +77,7 @@ async function main() {
     messages: [{ role: 'user', content: 'Say this is a test' }],
     model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
   };
-  const chatCompletion: Together.Chat.ChatCompletion = await together.chat.completions.create(params);
+  const chatCompletion: Together.Chat.ChatCompletion = await client.chat.completions.create(params);
 }
 
 main();
@@ -94,7 +94,7 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 async function main() {
-  const chatCompletion = await together.chat.completions
+  const chatCompletion = await client.chat.completions
     .create({
       messages: [{ role: 'user', content: 'Say this is a test' }],
       model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
@@ -137,12 +137,12 @@ You can use the `maxRetries` option to configure or disable this:
 <!-- prettier-ignore -->
 ```js
 // Configure the default for all requests:
-const together = new Together({
+const client = new Together({
   maxRetries: 0, // default is 2
 });
 
 // Or, configure per-request:
-await together.chat.completions.create({ messages: [{ role: 'user', content: 'Say this is a test' }], model: 'mistralai/Mixtral-8x7B-Instruct-v0.1' }, {
+await client.chat.completions.create({ messages: [{ role: 'user', content: 'Say this is a test' }], model: 'mistralai/Mixtral-8x7B-Instruct-v0.1' }, {
   maxRetries: 5,
 });
 ```
@@ -154,12 +154,12 @@ Requests time out after 1 minute by default. You can configure this with a `time
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
-const together = new Together({
+const client = new Together({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
 // Override per-request:
-await together.chat.completions.create({ messages: [{ role: 'user', content: 'Say this is a test' }], model: 'mistralai/Mixtral-8x7B-Instruct-v0.1' }, {
+await client.chat.completions.create({ messages: [{ role: 'user', content: 'Say this is a test' }], model: 'mistralai/Mixtral-8x7B-Instruct-v0.1' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -178,9 +178,9 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 
 <!-- prettier-ignore -->
 ```ts
-const together = new Together();
+const client = new Together();
 
-const response = await together.chat.completions
+const response = await client.chat.completions
   .create({
     messages: [{ role: 'user', content: 'Say this is a test' }],
     model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
@@ -189,7 +189,7 @@ const response = await together.chat.completions
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: chatCompletion, response: raw } = await together.chat.completions
+const { data: chatCompletion, response: raw } = await client.chat.completions
   .create({
     messages: [{ role: 'user', content: 'Say this is a test' }],
     model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
@@ -295,12 +295,12 @@ import http from 'http';
 import { HttpsProxyAgent } from 'https-proxy-agent';
 
 // Configure the default for all requests:
-const together = new Together({
+const client = new Together({
   httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
 });
 
 // Override per-request:
-await together.chat.completions.create(
+await client.chat.completions.create(
   {
     messages: [{ role: 'user', content: 'Say this is a test' }],
     model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',

api.md

@@ -5,8 +5,16 @@
 Types:
 
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletion</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionAssistantMessageParam</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionChunk</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionFunctionMessageParam</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionMessage</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionMessageParam</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionSystemMessageParam</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionTool</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionToolMessageParam</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionUsage</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionUserMessageParam</a></code>
 
 Methods:
 

bin/check-release-environment

@@ -1,20 +1,9 @@
 #!/usr/bin/env bash
 
-warnings=()
 errors=()
 
 if [ -z "${NPM_TOKEN}" ]; then
-  warnings+=("The TOGETHER_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
-fi
-
-lenWarnings=${#warnings[@]}
-
-if [[ lenWarnings -gt 0 ]]; then
-  echo -e "Found the following warnings in the release environment:\n"
-
-  for warning in "${warnings[@]}"; do
-    echo -e "- $warning\n"
-  done
+  errors+=("The TOGETHER_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
 fi
 
 lenErrors=${#errors[@]}
@@ -30,3 +19,4 @@ if [[ lenErrors -gt 0 ]]; then
 fi
 
 echo "The environment is ready to push releases!"
+

bin/publish-npm

@@ -2,8 +2,24 @@
 
 set -eux
 
-npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
+npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
 
+# Build the project
 yarn build
+
+# Navigate to the dist directory
 cd dist
-yarn publish --access public
+
+# Get the version from package.json
+VERSION="$(node -p "require('./package.json').version")"
+
+# Extract the pre-release tag if it exists
+if [[ "$VERSION" =~ -([a-zA-Z]+) ]]; then
+  # Extract the part before any dot in the pre-release identifier
+  TAG="${BASH_REMATCH[1]}"
+else
+  TAG="latest"
+fi
+
+# Publish with the appropriate tag
+yarn publish --access public --tag "$TAG"

examples/chat-completions.ts

@@ -0,0 +1,24 @@
+#!/usr/bin/env -S npm run tsn -T
+
+import Together from 'together-ai';
+
+const together = new Together();
+async function main() {
+  const runner = together.chat.completions
+    .stream({
+      model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
+      messages: [{ role: 'user', content: 'Say this is a test' }],
+    })
+    .on('message', (msg) => console.log(msg))
+    .on('content', (diff) => process.stdout.write(diff));
+
+  for await (const chunk of runner) {
+    // Note: comment out the next line to print chunks as they are streamed from the API
+    // console.log('chunk', chunk);
+  }
+
+  const result = await runner.finalMessage();
+  console.log(result);
+}
+
+main();

examples/embedding.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S npm run tsn -T
 
-import Together from 'together';
+import Together from 'together-ai';
 
 const together = new Together();
 

examples/files.ts

@@ -2,7 +2,7 @@
 
 // Example of listing and retrieving files
 
-import Together from 'together';
+import Together from 'together-ai';
 
 const together = new Together();
 

examples/fine-tune.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S npm run tsn -T
 
-import Together from 'together';
+import Together from 'together-ai';
 
 const together = new Together();
 

examples/image.ts

@@ -2,7 +2,7 @@
 
 //An example to generate an image and save to a file
 
-import Together from 'together';
+import Together from 'together-ai';
 import fs from 'fs';
 
 const together = new Together();

examples/models.ts

@@ -2,7 +2,7 @@
 
 //An example to request a list of models and print them.
 
-import Together from 'together';
+import Together from 'together-ai';
 
 const together = new Together();
 

examples/streaming.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S npm run tsn -T
 
-import Together from 'together';
+import Together from 'together-ai';
 
 const together = new Together();
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "together-ai",
-  "version": "0.6.0-alpha.4",
+  "version": "0.6.0-alpha.5",
   "description": "The official TypeScript library for the Together API",
   "author": "Together <[email protected]>",
   "types": "dist/index.d.ts",
@@ -21,7 +21,7 @@
     "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build; fi",
     "tsn": "ts-node -r tsconfig-paths/register",
     "lint": "./scripts/lint",
-    "fix": "eslint --fix --ext ts,js ."
+    "fix": "./scripts/format"
   },
   "dependencies": {
     "@types/node": "^18.11.18",
@@ -30,8 +30,7 @@
     "agentkeepalive": "^4.2.1",
     "form-data-encoder": "1.7.2",
     "formdata-node": "^4.3.2",
-    "node-fetch": "^2.6.7",
-    "web-streams-polyfill": "^3.2.1"
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
     "@swc/core": "^1.3.102",

scripts/format

@@ -5,4 +5,4 @@ set -e
 cd "$(dirname "$0")/.."
 
 echo "==> Running eslint --fix"
-./node_modules/.bin/eslint --fix --ext ts,js .
+ESLINT_USE_FLAT_CONFIG="false" ./node_modules/.bin/eslint --fix --ext ts,js .

scripts/lint

@@ -5,4 +5,4 @@ set -e
 cd "$(dirname "$0")/.."
 
 echo "==> Running eslint"
-./node_modules/.bin/eslint --ext ts,js .
+ESLINT_USE_FLAT_CONFIG="false" ./node_modules/.bin/eslint --ext ts,js .

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stoplight/prism-cli@~5.8 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/[email protected].5 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec  --package=@stoplight/prism-cli@~5.8 -- prism mock "$URL"
+  npm exec --package=@stainless-api/[email protected].5 -- prism mock "$URL"
 fi

src/_shims/node-runtime.ts

@@ -13,9 +13,7 @@ import { Readable } from 'node:stream';
 import { type RequestOptions } from '../core';
 import { MultipartBody } from './MultipartBody';
 import { type Shims } from './registry';
-
-// @ts-ignore (this package does not have proper export maps for this export)
-import { ReadableStream } from 'web-streams-polyfill/dist/ponyfill.es2018.js';
+import { ReadableStream } from 'node:stream/web';
 
 type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 

src/index.ts

@@ -143,6 +143,7 @@ export class Together extends Core.APIClient {
   }
 
   static Together = this;
+  static DEFAULT_TIMEOUT = 60000; // 1 minute
 
   static TogetherError = Errors.TogetherError;
   static APIError = Errors.APIError;