Merge pull request #177 from togethercomputer/release-please--branches--main--changes--next--components--together-ai

release: 0.17.0

Author: Nutlope

.github/workflows/ci.yml

@@ -7,12 +7,17 @@ on:
       - 'integrated/**'
       - 'stl-preview-head/**'
       - 'stl-preview-base/**'
+  pull_request:
+    branches-ignore:
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:
     timeout-minutes: 10
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/togetherai-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 
@@ -31,6 +36,7 @@ jobs:
     timeout-minutes: 5
     name: build
     runs-on: ${{ github.repository == 'stainless-sdks/togetherai-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     permissions:
       contents: read
       id-token: write
@@ -66,13 +72,14 @@ jobs:
     timeout-minutes: 10
     name: test
     runs-on: ${{ github.repository == 'stainless-sdks/togetherai-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: '20'
 
       - name: Bootstrap
         run: ./scripts/bootstrap

.github/workflows/publish-npm.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: '20'
 
       - name: Install dependencies
         run: |

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.16.0"
+  ".": "0.17.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 28
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-c949fc43297a5155ea4c433179ee6f0822e25a351f180a5539871687daead7ad.yml
-openapi_spec_hash: ca24d10b37e987becfd16b30ea342459
-config_hash: a60b100624e80dc8d9144e7bc306f5ce
+configured_endpoints: 33
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-0587b28a7ae7d241b442a774d024d83dc7d3aaea6d51ecc9bb825888f53a60ce.yml
+openapi_spec_hash: 2bccc6c37221bacda7bc3f486fc4684d
+config_hash: ae07f8cefe84a8a01ae2d0c8ddc2ef32

CHANGELOG.md

@@ -1,5 +1,65 @@
 # Changelog
 
+## 0.17.0 (2025-07-03)
+
+Full Changelog: [v0.16.0...v0.17.0](https://github.com/togethercomputer/together-typescript/compare/v0.16.0...v0.17.0)
+
+### Features
+
+* **api:** add batch api to config ([6bf62dd](https://github.com/togethercomputer/together-typescript/commit/6bf62dd3d983873c0321ca97f780b898be85f7c5))
+* **api:** Add file_type and file_purpose ([f91fb18](https://github.com/togethercomputer/together-typescript/commit/f91fb1855454afb6ddda0484ee6cd385e10097b0))
+* **api:** add files/upload apu support and switch upload_file method over to use it. ([5e60c99](https://github.com/togethercomputer/together-typescript/commit/5e60c99098e3046f9e0d540f0ae29c13eac413f7))
+* **api:** address diagnostic issues in audio api, correct openapi issue in images api, disambiguate a response in finetune api, enable automated testing on finetune and images ([9131477](https://github.com/togethercomputer/together-typescript/commit/9131477f5980d16c3d6dc1f3b9d2dcf21895358d))
+* **api:** api update ([0f63bf1](https://github.com/togethercomputer/together-typescript/commit/0f63bf166570b12a6ab71f1f6778fefb2409a5b5))
+* **api:** api update ([cc8b7a8](https://github.com/togethercomputer/together-typescript/commit/cc8b7a8971d28a5214fb1edd5ba211d9ddebdf49))
+* **api:** api update ([1df5bbe](https://github.com/togethercomputer/together-typescript/commit/1df5bbe5c565106587672364f72975bca01770a8))
+* **api:** api update ([0b81ef9](https://github.com/togethercomputer/together-typescript/commit/0b81ef9c6645a6b92513ea1ad641542d1a9cbfdd))
+* **api:** api update ([fd4611d](https://github.com/togethercomputer/together-typescript/commit/fd4611d598c597a521b4aa7114d9f6c586ed4966))
+* **api:** api update ([ea28f8f](https://github.com/togethercomputer/together-typescript/commit/ea28f8f18912118374ff7c6dbdf54301da3a64f8))
+* **api:** api update ([9d7d2f1](https://github.com/togethercomputer/together-typescript/commit/9d7d2f11e150bd3e0ec1ba9a6ccc33d27679bdc3))
+* **api:** api update ([f52b93d](https://github.com/togethercomputer/together-typescript/commit/f52b93dfe3968326efefc5624beea20549656e10))
+* **api:** api update ([ebf6451](https://github.com/togethercomputer/together-typescript/commit/ebf64513ab30e86579e8212042784c8dec1ad1c1))
+* **api:** api update ([e50cdb2](https://github.com/togethercomputer/together-typescript/commit/e50cdb2d9a23607ba1c386f3b1739d66231f4590))
+* **api:** api update ([158a5c8](https://github.com/togethercomputer/together-typescript/commit/158a5c89456605a303c55d4577d7e11d5dd847b1))
+* **api:** Formatting fixes, some lint fixes ([6b6fc13](https://github.com/togethercomputer/together-typescript/commit/6b6fc137c34f63bbf356df610b2b198aa9109bb0))
+* **api:** get test_code_interpreter passing ([b67a035](https://github.com/togethercomputer/together-typescript/commit/b67a035ebad8c3764c4a9b6919f302bfd19573cf))
+* **api:** update spec / config to remove remaining codegen warnings ([1665d1f](https://github.com/togethercomputer/together-typescript/commit/1665d1f80c707b45d204997872fdcee741517861))
+* **api:** Update spec and config to get all tests except code-interpolation an fine_tune unit tests working. ([1cb0018](https://github.com/togethercomputer/together-typescript/commit/1cb001870511f924acaee1bf67aad683abce9d22))
+* **client:** add support for endpoint-specific base URLs ([41abee6](https://github.com/togethercomputer/together-typescript/commit/41abee6d1498a6695644adc6e2c3286403612998))
+
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([38fdf05](https://github.com/togethercomputer/together-typescript/commit/38fdf059359e309e5dee1e1d627644eeb1193eff))
+* **client:** don't send `Content-Type` for bodyless methods ([4104dc3](https://github.com/togethercomputer/together-typescript/commit/4104dc3d84e838d816af11ba0309eb7cadc564af))
+* publish script — handle NPM errors correctly ([78d1a5c](https://github.com/togethercomputer/together-typescript/commit/78d1a5c718bbf5a2e2cd2cee8f850cc23cd1f690))
+* **tests:** format ([82fad3c](https://github.com/togethercomputer/together-typescript/commit/82fad3cbfffd2bf042b07e34033d03d2390a34b8))
+* **tests:** remove unused tests ([bb90a25](https://github.com/togethercomputer/together-typescript/commit/bb90a25b0433b454d19a77d45822618e46203878))
+
+
+### Chores
+
+* **api:** re-enable audio unit tests ([5ac5b53](https://github.com/togethercomputer/together-typescript/commit/5ac5b5332379c2f86bd2048edb914461cd3e76f2))
+* **ci:** bump node version for release workflows ([681d96e](https://github.com/togethercomputer/together-typescript/commit/681d96e81cbdaa50d27519377ced7496574a49cd))
+* **ci:** enable for pull requests ([b3c7e61](https://github.com/togethercomputer/together-typescript/commit/b3c7e615f530ee0acaf7554e080f8f2e97e7c3d5))
+* **ci:** only run for pushes and fork pull requests ([448b1fa](https://github.com/togethercomputer/together-typescript/commit/448b1faa36bbd70f2a608b19aeb564e28043630d))
+* **docs:** grammar improvements ([c9d78f6](https://github.com/togethercomputer/together-typescript/commit/c9d78f63e644492be7b0388acb8c5bc383f9fbf7))
+* **docs:** use top-level-await in example snippets ([815f983](https://github.com/togethercomputer/together-typescript/commit/815f983932dfcc212c2e5d1efd46318d62c8eb7b))
+* improve publish-npm script --latest tag logic ([1025321](https://github.com/togethercomputer/together-typescript/commit/102532181512dfe468208e12e64cff2961d59fca))
+* **internal:** make base APIResource abstract ([d031002](https://github.com/togethercomputer/together-typescript/commit/d03100298d3a8815c6f9804e9f5c6d58d62a4ec5))
+* mention unit type in timeout docs ([488c92c](https://github.com/togethercomputer/together-typescript/commit/488c92ca13366d7554db85e163a6504f65900cf6))
+
+
+### Documentation
+
+* add examples to tsdocs ([64cbec4](https://github.com/togethercomputer/together-typescript/commit/64cbec43bd51f4e4c9bcb41a32aad78657f9a9c3))
+* **readme:** fix typo ([0b6aea3](https://github.com/togethercomputer/together-typescript/commit/0b6aea385fe6123df3d2116f80110d37852a0575))
+
+
+### Refactors
+
+* **types:** replace Record with mapped types ([07b8800](https://github.com/togethercomputer/together-typescript/commit/07b88009b94e6654768c60e1890d1d888746ab6f))
+
 ## 0.16.0 (2025-04-28)
 
 Full Changelog: [v0.15.2...v0.16.0](https://github.com/togethercomputer/together-typescript/compare/v0.15.2...v0.16.0)

README.md

@@ -26,16 +26,12 @@ const client = new Together({
   apiKey: process.env['TOGETHER_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const chatCompletion = await client.chat.completions.create({
-    messages: [{ role: 'user', content: 'Say this is a test!' }],
-    model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
-  });
-
-  console.log(chatCompletion.choices);
-}
+const chatCompletion = await client.chat.completions.create({
+  messages: [{ role: 'user', content: 'Say this is a test!' }],
+  model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
+});
 
-main();
+console.log(chatCompletion.choices);
 ```
 
 ## Streaming responses
@@ -72,19 +68,65 @@ const client = new Together({
   apiKey: process.env['TOGETHER_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const params: Together.Chat.CompletionCreateParams = {
-    messages: [{ role: 'user', content: 'Say this is a test' }],
-    model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
-  };
-  const chatCompletion: Together.Chat.ChatCompletion = await client.chat.completions.create(params);
-}
-
-main();
+const params: Together.Chat.CompletionCreateParams = {
+  messages: [{ role: 'user', content: 'Say this is a test' }],
+  model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
+};
+const chatCompletion: Together.Chat.ChatCompletion = await client.chat.completions.create(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
 
+## File uploads
+
+Request parameters that correspond to file uploads can be passed in many different forms:
+
+- `File` (or an object with the same structure)
+- a `fetch` `Response` (or an object with the same structure)
+- an `fs.ReadStream`
+- the return value of our `toFile` helper
+
+```ts
+import fs from 'fs';
+import fetch from 'node-fetch';
+import Together, { toFile } from 'together-ai';
+
+const client = new Together();
+
+// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
+await client.files.upload({
+  file: fs.createReadStream('/path/to/file'),
+  file_name: 'dataset.csv',
+  purpose: 'fine-tune',
+});
+
+// Or if you have the web `File` API you can pass a `File` instance:
+await client.files.upload({
+  file: new File(['my bytes'], 'file'),
+  file_name: 'dataset.csv',
+  purpose: 'fine-tune',
+});
+
+// You can also pass a `fetch` `Response`:
+await client.files.upload({
+  file: await fetch('https://somesite/file'),
+  file_name: 'dataset.csv',
+  purpose: 'fine-tune',
+});
+
+// Finally, if none of the above are convenient, you can use our `toFile` helper:
+await client.files.upload({
+  file: await toFile(Buffer.from('my bytes'), 'file'),
+  file_name: 'dataset.csv',
+  purpose: 'fine-tune',
+});
+await client.files.upload({
+  file: await toFile(new Uint8Array([0, 1, 2]), 'file'),
+  file_name: 'dataset.csv',
+  purpose: 'fine-tune',
+});
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API,
@@ -93,27 +135,23 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  const chatCompletion = await client.chat.completions
-    .create({
-      messages: [{ role: 'user', content: 'Say this is a test' }],
-      model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
-    })
-    .catch(async (err) => {
-      if (err instanceof Together.APIError) {
-        console.log(err.status); // 400
-        console.log(err.name); // BadRequestError
-        console.log(err.headers); // {server: 'nginx', ...}
-      } else {
-        throw err;
-      }
-    });
-}
-
-main();
+const chatCompletion = await client.chat.completions
+  .create({
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+    model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
+  })
+  .catch(async (err) => {
+    if (err instanceof Together.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Status Code | Error Type                 |
 | ----------- | -------------------------- |

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Together please follow the respective company's security reporting guidelines.
+or products provided by Together, please follow the respective company's security reporting guidelines.
 
 ### Together Terms and Policies
 
-Please contact [email protected] for any questions or concerns regarding security of our services.
+Please contact [email protected] for any questions or concerns regarding the security of our services.
 
 ---
 

api.md

@@ -25,6 +25,7 @@ Types:
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionToolMessageParam</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionStructuredMessageImageURL</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionStructuredMessageText</a></code>
+- <code><a href="./src/resources/chat/completions.ts">ChatCompletionStructuredMessageVideoURL</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionUsage</a></code>
 - <code><a href="./src/resources/chat/completions.ts">ChatCompletionUserMessageParam</a></code>
 
@@ -37,6 +38,7 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/completions.ts">Completion</a></code>
+- <code><a href="./src/resources/completions.ts">CompletionChunk</a></code>
 - <code><a href="./src/resources/completions.ts">LogProbs</a></code>
 - <code><a href="./src/resources/completions.ts">ToolChoice</a></code>
 - <code><a href="./src/resources/completions.ts">Tools</a></code>
@@ -60,34 +62,50 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/files.ts">FileObject</a></code>
+- <code><a href="./src/resources/files.ts">FilePurpose</a></code>
+- <code><a href="./src/resources/files.ts">FileType</a></code>
 - <code><a href="./src/resources/files.ts">FileRetrieveResponse</a></code>
 - <code><a href="./src/resources/files.ts">FileListResponse</a></code>
 - <code><a href="./src/resources/files.ts">FileDeleteResponse</a></code>
+- <code><a href="./src/resources/files.ts">FileUploadResponse</a></code>
 
 Methods:
 
 - <code title="get /files/{id}">client.files.<a href="./src/resources/files.ts">retrieve</a>(id) -> FileRetrieveResponse</code>
 - <code title="get /files">client.files.<a href="./src/resources/files.ts">list</a>() -> FileListResponse</code>
 - <code title="delete /files/{id}">client.files.<a href="./src/resources/files.ts">delete</a>(id) -> FileDeleteResponse</code>
 - <code title="get /files/{id}/content">client.files.<a href="./src/resources/files.ts">content</a>(id) -> Response</code>
+- <code title="post /files/upload">client.files.<a href="./src/resources/files.ts">upload</a>({ ...params }) -> FileUploadResponse</code>
 
 # FineTune
 
 Types:
 
+- <code><a href="./src/resources/fine-tune.ts">CosineLrSchedulerArgs</a></code>
 - <code><a href="./src/resources/fine-tune.ts">FineTune</a></code>
 - <code><a href="./src/resources/fine-tune.ts">FineTuneEvent</a></code>
+- <code><a href="./src/resources/fine-tune.ts">FullTrainingType</a></code>
+- <code><a href="./src/resources/fine-tune.ts">LinearLrSchedulerArgs</a></code>
+- <code><a href="./src/resources/fine-tune.ts">LoRaTrainingType</a></code>
+- <code><a href="./src/resources/fine-tune.ts">LrScheduler</a></code>
+- <code><a href="./src/resources/fine-tune.ts">TrainingMethodDpo</a></code>
+- <code><a href="./src/resources/fine-tune.ts">TrainingMethodSft</a></code>
+- <code><a href="./src/resources/fine-tune.ts">FineTuneCreateResponse</a></code>
 - <code><a href="./src/resources/fine-tune.ts">FineTuneListResponse</a></code>
+- <code><a href="./src/resources/fine-tune.ts">FineTuneCancelResponse</a></code>
 - <code><a href="./src/resources/fine-tune.ts">FineTuneDownloadResponse</a></code>
+- <code><a href="./src/resources/fine-tune.ts">FineTuneListEventsResponse</a></code>
+- <code><a href="./src/resources/fine-tune.ts">FineTuneRetrieveCheckpointsResponse</a></code>
 
 Methods:
 
-- <code title="post /fine-tunes">client.fineTune.<a href="./src/resources/fine-tune.ts">create</a>({ ...params }) -> FineTune</code>
+- <code title="post /fine-tunes">client.fineTune.<a href="./src/resources/fine-tune.ts">create</a>({ ...params }) -> FineTuneCreateResponse</code>
 - <code title="get /fine-tunes/{id}">client.fineTune.<a href="./src/resources/fine-tune.ts">retrieve</a>(id) -> FineTune</code>
 - <code title="get /fine-tunes">client.fineTune.<a href="./src/resources/fine-tune.ts">list</a>() -> FineTuneListResponse</code>
-- <code title="post /fine-tunes/{id}/cancel">client.fineTune.<a href="./src/resources/fine-tune.ts">cancel</a>(id) -> FineTune</code>
+- <code title="post /fine-tunes/{id}/cancel">client.fineTune.<a href="./src/resources/fine-tune.ts">cancel</a>(id) -> FineTuneCancelResponse</code>
 - <code title="get /finetune/download">client.fineTune.<a href="./src/resources/fine-tune.ts">download</a>({ ...params }) -> FineTuneDownloadResponse</code>
-- <code title="get /fine-tunes/{id}/events">client.fineTune.<a href="./src/resources/fine-tune.ts">listEvents</a>(id) -> FineTuneEvent</code>
+- <code title="get /fine-tunes/{id}/events">client.fineTune.<a href="./src/resources/fine-tune.ts">listEvents</a>(id) -> FineTuneListEventsResponse</code>
+- <code title="get /fine-tunes/{id}/checkpoints">client.fineTune.<a href="./src/resources/fine-tune.ts">retrieveCheckpoints</a>(id) -> FineTuneRetrieveCheckpointsResponse</code>
 
 # CodeInterpreter
 
@@ -113,6 +131,8 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/images.ts">ImageDataB64</a></code>
+- <code><a href="./src/resources/images.ts">ImageDataURL</a></code>
 - <code><a href="./src/resources/images.ts">ImageFile</a></code>
 
 Methods:
@@ -124,6 +144,7 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/audio.ts">AudioFile</a></code>
+- <code><a href="./src/resources/audio.ts">AudioSpeechStreamChunk</a></code>
 
 Methods:
 
@@ -157,6 +178,7 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/endpoints.ts">Autoscaling</a></code>
 - <code><a href="./src/resources/endpoints.ts">EndpointCreateResponse</a></code>
 - <code><a href="./src/resources/endpoints.ts">EndpointRetrieveResponse</a></code>
 - <code><a href="./src/resources/endpoints.ts">EndpointUpdateResponse</a></code>
@@ -179,3 +201,17 @@ Types:
 Methods:
 
 - <code title="get /hardware">client.hardware.<a href="./src/resources/hardware.ts">list</a>({ ...params }) -> HardwareListResponse</code>
+
+# Batches
+
+Types:
+
+- <code><a href="./src/resources/batches.ts">BatchCreateResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchRetrieveResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchListResponse</a></code>
+
+Methods:
+
+- <code title="post /batches">client.batches.<a href="./src/resources/batches.ts">create</a>({ ...params }) -> BatchCreateResponse</code>
+- <code title="get /batches/{id}">client.batches.<a href="./src/resources/batches.ts">retrieve</a>(id) -> BatchRetrieveResponse</code>
+- <code title="get /batches">client.batches.<a href="./src/resources/batches.ts">list</a>() -> BatchListResponse</code>