release: 0.20.0 (#220)

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -12,8 +12,6 @@ jobs:
   lint:
     name: lint
     runs-on: ubuntu-latest
-    
-
     steps:
       - uses: actions/checkout@v4
 
@@ -31,8 +29,9 @@ jobs:
   build:
     name: build
     runs-on: ubuntu-latest
-    
-
+    permissions:
+      contents: read
+      id-token: write
     steps:
       - uses: actions/checkout@v4
 
@@ -46,10 +45,24 @@ jobs:
 
       - name: Check build
         run: ./scripts/build
+
+      - name: Get GitHub OIDC Token
+        if: github.repository == 'stainless-sdks/groqcloud-node'
+        id: github-oidc
+        uses: actions/github-script@v6
+        with:
+          script: core.setOutput('github_token', await core.getIDToken());
+
+      - name: Upload tarball
+        if: github.repository == 'stainless-sdks/groqcloud-node'
+        env:
+          URL: https://pkg.stainless.com/s
+          AUTH: ${{ steps.github-oidc.outputs.github_token }}
+          SHA: ${{ github.sha }}
+        run: ./scripts/utils/upload-artifact.sh
   test:
     name: test
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.19.0"
+  ".": "0.20.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 17
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/groqcloud%2Fgroqcloud-8d531e091886f4bb814247a78a6323f6f12351881269a4e8cf68223b9245c64f.yml
-openapi_spec_hash: 418d99cedb3b70fbd0615eed3ceb2872
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/groqcloud%2Fgroqcloud-37498d19ece87c6866fe2460cef019b42d73c598d3489925375484812ce9b5a5.yml
+openapi_spec_hash: 009dde3080daf9a27d5165245e4ad11d
 config_hash: 6b1c374dcc1ffa3165dd22f52a77ff89

CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.20.0 (2025-04-22)
+
+Full Changelog: [v0.19.0...v0.20.0](https://github.com/groq/groq-typescript/compare/v0.19.0...v0.20.0)
+
+### Features
+
+* **api:** api update ([00b8a36](https://github.com/groq/groq-typescript/commit/00b8a36b9101235badc0a5cf3b19287aaa9e38e3))
+* **api:** api update ([b728dc4](https://github.com/groq/groq-typescript/commit/b728dc48b6a7686982dab67238d746276f223602))
+* **api:** api update ([055b41b](https://github.com/groq/groq-typescript/commit/055b41bb1ca5e9d64833a3bc54c3afa1f0f16faa))
+* **api:** api update ([74fea29](https://github.com/groq/groq-typescript/commit/74fea29aca74cf761a20d0cb4c51b522624a491b))
+* **api:** api update ([970e970](https://github.com/groq/groq-typescript/commit/970e970e959ce756dd5194b9f758c10bed4b0485))
+* **api:** api update ([cc72162](https://github.com/groq/groq-typescript/commit/cc72162da8f83deb1b8f5d65743c91b5f2fbd7d7))
+* **api:** api update ([a945491](https://github.com/groq/groq-typescript/commit/a945491da14e55416dee482f1aac26f1daecfb01))
+
+
+### Bug Fixes
+
+* **api:** improve type resolution when importing as a package ([#222](https://github.com/groq/groq-typescript/issues/222)) ([45bea8e](https://github.com/groq/groq-typescript/commit/45bea8e84f6dfe75e599aec2b4a5268497914923))
+* **client:** send `X-Stainless-Timeout` in seconds ([#219](https://github.com/groq/groq-typescript/issues/219)) ([49bc9d2](https://github.com/groq/groq-typescript/commit/49bc9d2621ff8fe5261c7f22d2283c67ff2883be))
+* **mcp:** remove unused tools.ts ([#223](https://github.com/groq/groq-typescript/issues/223)) ([ac43270](https://github.com/groq/groq-typescript/commit/ac43270a148a19cce434c3c3fe7602fbf1b4eccc))
+
+
+### Chores
+
+* **client:** minor internal fixes ([bfebc04](https://github.com/groq/groq-typescript/commit/bfebc041673e0d23d287601cd694b572aa662b64))
+* GitHub Terraform: Create/Update .github/workflows/stale.yaml [skip ci] ([1543aeb](https://github.com/groq/groq-typescript/commit/1543aeb885e0938b5289e477b34fb962754fffa0))
+* **internal:** add aliases for Record and Array ([#221](https://github.com/groq/groq-typescript/issues/221)) ([b4d3b51](https://github.com/groq/groq-typescript/commit/b4d3b5143d4cfa6cffd6b2424797feacac3e9229))
+* **internal:** reduce CI branch coverage ([48fbdca](https://github.com/groq/groq-typescript/commit/48fbdca40c7127697544df18d6e91bdd52d2ebc9))
+* **internal:** upload builds and expand CI branch coverage ([4bbba67](https://github.com/groq/groq-typescript/commit/4bbba6700d7dc0bd03dfa67940e0cc4b293a0213))
+* **tests:** improve enum examples ([#224](https://github.com/groq/groq-typescript/issues/224)) ([3639c3b](https://github.com/groq/groq-typescript/commit/3639c3b255fa6e7f97c7a8d747297bc06e58f3f6))
+
 ## 0.19.0 (2025-04-02)
 
 Full Changelog: [v0.18.0...v0.19.0](https://github.com/groq/groq-typescript/compare/v0.18.0...v0.19.0)

api.md

@@ -118,13 +118,12 @@ Types:
 - <code><a href="./src/resources/files.ts">FileCreateResponse</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">FileContentResponse</a></code>
 - <code><a href="./src/resources/files.ts">FileInfoResponse</a></code>
 
 Methods:
 
 - <code title="post /openai/v1/files">client.files.<a href="./src/resources/files.ts">create</a>({ ...params }) -> FileCreateResponse</code>
 - <code title="get /openai/v1/files">client.files.<a href="./src/resources/files.ts">list</a>() -> FileListResponse</code>
 - <code title="delete /openai/v1/files/{file_id}">client.files.<a href="./src/resources/files.ts">delete</a>(fileId) -> FileDeleteResponse</code>
-- <code title="get /openai/v1/files/{file_id}/content">client.files.<a href="./src/resources/files.ts">content</a>(fileId) -> string</code>
+- <code title="get /openai/v1/files/{file_id}/content">client.files.<a href="./src/resources/files.ts">content</a>(fileId) -> Response</code>
 - <code title="get /openai/v1/files/{file_id}">client.files.<a href="./src/resources/files.ts">info</a>(fileId) -> FileInfoResponse</code>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "groq-sdk",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "The official TypeScript library for the Groq API",
   "author": "Groq <[email protected]>",
   "types": "dist/index.d.ts",

scripts/utils/upload-artifact.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -exuo pipefail
+
+RESPONSE=$(curl -X POST "$URL" \
+  -H "Authorization: Bearer $AUTH" \
+  -H "Content-Type: application/json")
+
+SIGNED_URL=$(echo "$RESPONSE" | jq -r '.url')
+
+if [[ "$SIGNED_URL" == "null" ]]; then
+  echo -e "\033[31mFailed to get signed URL.\033[0m"
+  exit 1
+fi
+
+UPLOAD_RESPONSE=$(tar -cz dist | curl -v -X PUT \
+  -H "Content-Type: application/gzip" \
+  --data-binary @- "$SIGNED_URL" 2>&1)
+
+if echo "$UPLOAD_RESPONSE" | grep -q "HTTP/[0-9.]* 200"; then
+  echo -e "\033[32mUploaded build to Stainless storage.\033[0m"
+  echo -e "\033[32mInstallation: npm install 'https://pkg.stainless.com/s/groqcloud-node/$SHA'\033[0m"
+else
+  echo -e "\033[31mFailed to upload artifact.\033[0m"
+  exit 1
+fi

src/core.ts

@@ -34,6 +34,20 @@ export {
 
 export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
 
+/**
+ * An alias to the builtin `Array` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Array<T> = Array<T>;
+
+/**
+ * An alias to the builtin `Record` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Record<K extends keyof any, T> = Record<K, T>;
+
+export type { _Array as Array, _Record as Record };
+
 type PromiseOrValue<T> = T | Promise<T>;
 
 type APIResponseProps = {
@@ -296,10 +310,10 @@ export abstract class APIClient {
   }
 
   buildRequest<Req>(
-    options: FinalRequestOptions<Req>,
+    inputOptions: FinalRequestOptions<Req>,
     { retryCount = 0 }: { retryCount?: number } = {},
   ): { req: RequestInit; url: string; timeout: number } {
-    options = { ...options };
+    const options = { ...inputOptions };
     const { method, path, query, headers: headers = {} } = options;
 
     const body =
@@ -327,8 +341,8 @@ export abstract class APIClient {
     }
 
     if (this.idempotencyHeader && method !== 'get') {
-      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
-      headers[this.idempotencyHeader] = options.idempotencyKey;
+      if (!inputOptions.idempotencyKey) inputOptions.idempotencyKey = this.defaultIdempotencyKey();
+      headers[this.idempotencyHeader] = inputOptions.idempotencyKey;
     }
 
     const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
@@ -385,7 +399,7 @@ export abstract class APIClient {
       getHeader(headers, 'x-stainless-timeout') === undefined &&
       options.timeout
     ) {
-      reqHeaders['x-stainless-timeout'] = String(options.timeout);
+      reqHeaders['x-stainless-timeout'] = String(Math.trunc(options.timeout / 1000));
     }
 
     this.validateHeaders(reqHeaders, headers);

src/index.ts

@@ -20,7 +20,6 @@ import {
   Embeddings,
 } from './resources/embeddings';
 import {
-  FileContentResponse,
   FileCreateParams,
   FileCreateResponse,
   FileDeleteResponse,
@@ -245,7 +244,6 @@ export declare namespace Groq {
     type FileCreateResponse as FileCreateResponse,
     type FileListResponse as FileListResponse,
     type FileDeleteResponse as FileDeleteResponse,
-    type FileContentResponse as FileContentResponse,
     type FileInfoResponse as FileInfoResponse,
     type FileCreateParams as FileCreateParams,
   };

src/resources/audio/speech.ts

@@ -12,7 +12,7 @@ export class Speech extends APIResource {
     return this._client.post('/openai/v1/audio/speech', {
       body,
       ...options,
-      headers: { Accept: 'application/octet-stream', ...options?.headers },
+      headers: { Accept: 'audio/wav', ...options?.headers },
       __binaryResponse: true,
     });
   }
@@ -25,19 +25,20 @@ export interface SpeechCreateParams {
   input: string;
 
   /**
-   * One of the available TTS models
+   * One of the [available TTS models](/docs/text-to-speech).
    */
   model: string;
 
   /**
-   * The voice to use when generating the audio.
+   * The voice to use when generating the audio. List of voices can be found
+   * [here](/docs/text-to-speech).
    */
   voice: string;
 
   /**
-   * The format to audio in. Supported formats are `wav`.
+   * The format to audio in. Supported formats are `wav, mp3`.
    */
-  response_format?: 'wav';
+  response_format?: 'wav' | 'mp3';
 
   /**
    * The speed of the generated audio. 1.0 is the only supported value.

src/resources/batches.ts

@@ -5,7 +5,8 @@ import * as Core from '../core';
 
 export class Batches extends APIResource {
   /**
-   * Creates and executes a batch from an uploaded file of requests
+   * Creates and executes a batch from an uploaded file of requests.
+   * [Learn more](/docs/batch).
    */
   create(body: BatchCreateParams, options?: Core.RequestOptions): Core.APIPromise<BatchCreateResponse> {
     return this._client.post('/openai/v1/batches', { body, ...options });
@@ -683,10 +684,10 @@ export namespace BatchCancelResponse {
 
 export interface BatchCreateParams {
   /**
-   * The time frame within which the batch should be processed. Currently only `24h`
-   * is supported.
+   * The time frame within which the batch should be processed. Durations from `24h`
+   * to `7d` are supported.
    */
-  completion_window: '24h';
+  completion_window: string;
 
   /**
    * The endpoint to be used for all requests in the batch. Currently

src/resources/chat/completions.ts

@@ -256,7 +256,7 @@ export namespace ChatCompletionChunk {
      * number of tokens specified in the request was reached, `tool_calls` if the model
      * called a tool, or `function_call` (deprecated) if the model called a function.
      */
-    finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call' | null;
+    finish_reason: 'stop' | 'length' | 'tool_calls' | 'function_call' | null;
 
     /**
      * The index of the choice in the list of choices.
@@ -804,9 +804,16 @@ export interface ChatCompletionCreateParamsBase {
 
   /**
    * ID of the model to use. For details on which models are compatible with the Chat
-   * API, see available [models](/docs/models)
+   * API, see available [models](https://console.groq.com/docs/models)
    */
-  model: (string & {}) | 'gemma-7b-it' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768';
+  model:
+    | (string & {})
+    | 'gemma2-9b-it'
+    | 'llama-3.3-70b-versatile'
+    | 'llama-3.1-8b-instant'
+    | 'llama-guard-3-8b'
+    | 'llama3-70b-8192'
+    | 'llama3-8b-8192';
 
   /**
    * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
@@ -863,6 +870,11 @@ export interface ChatCompletionCreateParamsBase {
    */
   max_tokens?: number | null;
 
+  /**
+   * This parameter is not currently supported.
+   */
+  metadata?: Record<string, string> | null;
+
   /**
    * How many chat completion choices to generate for each input message. Note that
    * the current moment, only n=1 is supported. Other values will result in a 400
@@ -921,6 +933,11 @@ export interface ChatCompletionCreateParamsBase {
    */
   stop?: string | null | Array<string>;
 
+  /**
+   * This parameter is not currently supported.
+   */
+  store?: boolean | null;
+
   /**
    * If set, partial message deltas will be sent. Tokens will be sent as data-only
    * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
@@ -933,7 +950,7 @@ export interface ChatCompletionCreateParamsBase {
    * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
    * make the output more random, while lower values like 0.2 will make it more
    * focused and deterministic. We generally recommend altering this or top_p but not
-   * both
+   * both.
    */
   temperature?: number | null;
 

src/resources/files.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
+import { type Response } from '../_shims/index';
 
 export class Files extends APIResource {
   /**
@@ -33,8 +34,12 @@ export class Files extends APIResource {
   /**
    * Returns the contents of the specified file.
    */
-  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<string> {
-    return this._client.get(`/openai/v1/files/${fileId}/content`, options);
+  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<Response> {
+    return this._client.get(`/openai/v1/files/${fileId}/content`, {
+      ...options,
+      headers: { Accept: 'application/octet-stream', ...options?.headers },
+      __binaryResponse: true,
+    });
   }
 
   /**
@@ -133,8 +138,6 @@ export interface FileDeleteResponse {
   object: 'file';
 }
 
-export type FileContentResponse = string;
-
 /**
  * The `File` object represents a document that has been uploaded.
  */
@@ -189,7 +192,6 @@ export declare namespace Files {
     type FileCreateResponse as FileCreateResponse,
     type FileListResponse as FileListResponse,
     type FileDeleteResponse as FileDeleteResponse,
-    type FileContentResponse as FileContentResponse,
     type FileInfoResponse as FileInfoResponse,
     type FileCreateParams as FileCreateParams,
   };

src/resources/index.ts

@@ -23,7 +23,6 @@ export {
   type FileCreateResponse,
   type FileListResponse,
   type FileDeleteResponse,
-  type FileContentResponse,
   type FileInfoResponse,
   type FileCreateParams,
 } from './files';

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.19.0'; // x-release-please-version
+export const VERSION = '0.20.0'; // x-release-please-version