chore(internal): codegen related update (#32)

.github/workflows/release-doctor.yml

@@ -1,6 +1,8 @@
 name: Release Doctor
 on:
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:

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',

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[@]}

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"

package.json

@@ -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/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].4 -- 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].4 -- 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;

src/resources/chat/completions.ts

@@ -114,20 +114,20 @@ export namespace ChatCompletionChunk {
 
     index: number;
 
-    logprobs?: CompletionsAPI.LogProbs;
+    logprobs?: number | null;
   }
 
   export namespace Choice {
     export interface Delta {
+      role: 'system' | 'user' | 'assistant' | 'function' | 'tool';
+
       content?: string | null;
 
       /**
        * @deprecated
        */
       function_call?: Delta.FunctionCall | null;
 
-      role?: 'system' | 'user' | 'assistant' | 'function' | 'tool';
-
       token_id?: number;
 
       tool_calls?: Array<CompletionsAPI.ToolChoice>;
@@ -282,7 +282,7 @@ export interface CompletionCreateParamsBase {
   max_tokens?: number;
 
   /**
-   * A number between 0 and 1 that can be used as an alternative to temperature.
+   * A number between 0 and 1 that can be used as an alternative to top_p and top-k.
    */
   min_p?: number;
 

src/resources/completions.ts

@@ -163,7 +163,7 @@ export interface CompletionCreateParamsBase {
   max_tokens?: number;
 
   /**
-   * A number between 0 and 1 that can be used as an alternative to temperature.
+   * A number between 0 and 1 that can be used as an alternative to top-p and top-k.
    */
   min_p?: number;
 

tests/api-resources/chat/completions.test.ts

@@ -3,18 +3,18 @@
 import Together from 'together-ai';
 import { Response } from 'node-fetch';
 
-const together = new Together({
+const client = new Together({
   apiKey: 'My API Key',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource completions', () => {
   test('create: only required params', async () => {
-    const responsePromise = together.chat.completions.create({
+    const responsePromise = client.chat.completions.create({
       messages: [
-        { role: 'system', content: 'string' },
-        { role: 'system', content: 'string' },
-        { role: 'system', content: 'string' },
+        { role: 'system', content: 'content' },
+        { role: 'system', content: 'content' },
+        { role: 'system', content: 'content' },
       ],
       model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
     });
@@ -28,11 +28,11 @@ describe('resource completions', () => {
   });
 
   test('create: required and optional params', async () => {
-    const response = await together.chat.completions.create({
+    const response = await client.chat.completions.create({
       messages: [
-        { role: 'system', content: 'string' },
-        { role: 'system', content: 'string' },
-        { role: 'system', content: 'string' },
+        { role: 'system', content: 'content' },
+        { role: 'system', content: 'content' },
+        { role: 'system', content: 'content' },
       ],
       model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
       echo: true,

tests/api-resources/completions.test.ts

@@ -3,14 +3,14 @@
 import Together from 'together-ai';
 import { Response } from 'node-fetch';
 
-const together = new Together({
+const client = new Together({
   apiKey: 'My API Key',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource completions', () => {
   test('create: only required params', async () => {
-    const responsePromise = together.completions.create({
+    const responsePromise = client.completions.create({
       model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
       prompt: '<s>[INST] What is the capital of France? [/INST]',
     });
@@ -24,7 +24,7 @@ describe('resource completions', () => {
   });
 
   test('create: required and optional params', async () => {
-    const response = await together.completions.create({
+    const response = await client.completions.create({
       model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
       prompt: '<s>[INST] What is the capital of France? [/INST]',
       echo: true,

tests/api-resources/embeddings.test.ts

@@ -3,14 +3,14 @@
 import Together from 'together-ai';
 import { Response } from 'node-fetch';
 
-const together = new Together({
+const client = new Together({
   apiKey: 'My API Key',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource embeddings', () => {
   test('create: only required params', async () => {
-    const responsePromise = together.embeddings.create({
+    const responsePromise = client.embeddings.create({
       input: 'Our solar system orbits the Milky Way galaxy at about 515,000 mph',
       model: 'togethercomputer/m2-bert-80M-8k-retrieval',
     });
@@ -24,7 +24,7 @@ describe('resource embeddings', () => {
   });
 
   test('create: required and optional params', async () => {
-    const response = await together.embeddings.create({
+    const response = await client.embeddings.create({
       input: 'Our solar system orbits the Milky Way galaxy at about 515,000 mph',
       model: 'togethercomputer/m2-bert-80M-8k-retrieval',
     });