release: 0.4.0

.devcontainer/Dockerfile

@@ -7,6 +7,10 @@ RUN apt-get update && apt-get install -y \
   yarnpkg \
   && apt-get clean autoclean
 
+# Ensure UTF-8 encoding
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
 # Yarn
 RUN ln -sf /usr/bin/yarnpkg /usr/bin/yarn
 

.github/workflows/ci.yml

@@ -22,9 +22,25 @@ jobs:
           node-version: '18'
 
       - name: Install dependencies
-        run: |
-          yarn install
+        run: yarn install
 
       - name: Check types
-        run: |
-          yarn build
+        run: ./scripts/lint
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Run tests
+        run: ./scripts/test
+

.github/workflows/publish-npm.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Node
         uses: actions/setup-node@v3

.github/workflows/release-doctor.yml

@@ -10,7 +10,7 @@ jobs:
     if: github.repository == 'groq/groq-typescript' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Check release environment
         run: |

.gitignore

@@ -1,7 +1,9 @@
 node_modules
 yarn-error.log
 codegen.log
+Brewfile.lock.json
 dist
 /deno
 /*.tgz
 .idea/
+

.prettierignore

@@ -1,5 +1,5 @@
 CHANGELOG.md
-/ecosystem-tests
+/ecosystem-tests/*/**
 /node_modules
 /deno
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.3.3"
+  ".": "0.4.0"
 }

.stats.yml

@@ -1 +1,2 @@
-configured_endpoints: 6
+configured_endpoints: 7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/groqcloud%2Fgroqcloud-0f93f9ac6d4ad16dacaddd7608e104374c83f3bd9d0b9ed4c0273eb27ed998b7.yml

Brewfile

@@ -0,0 +1 @@
+brew "node"

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.4.0 (2024-05-23)
+
+Full Changelog: [v0.3.3...v0.4.0](https://github.com/groq/groq-typescript/compare/v0.3.3...v0.4.0)
+
+### Features
+
+* **api:** Add embeddings endpoint ([cf59ec3](https://github.com/groq/groq-typescript/commit/cf59ec37bff37cb923eb389126f17931fcf97e2e))
+* **api:** Add support for image_url in chat user messages ([a8f7743](https://github.com/groq/groq-typescript/commit/a8f7743e3663de628247df3a655938b3ed53231a))
+* **api:** Define OpenAI-compatible models ([29fe116](https://github.com/groq/groq-typescript/commit/29fe116c88ad0d3c28562581f0929090833861ad))
+* **api:** Improve types ([c879cb2](https://github.com/groq/groq-typescript/commit/c879cb29871aa247a60b984874ffca40a9ae924c))
+
+
+### Bug Fixes
+
+* patch streaming ([80b1255](https://github.com/groq/groq-typescript/commit/80b12555fcffd58bfd760b993e8bc3dcebfdbe6b))
+
+
+### Chores
+
+* **api:** add response objects for translations and transcriptions ([ceba2a3](https://github.com/groq/groq-typescript/commit/ceba2a3c7a398c25cd47f6cc42f655822877c53a))
+* **api:** Internal SDK changes ([e1a6688](https://github.com/groq/groq-typescript/commit/e1a66880ec8843f5b9e62526ed31fbe34345a293))
+
 ## 0.3.3 (2024-04-29)
 
 Full Changelog: [v0.3.2...v0.3.3](https://github.com/groq/groq-typescript/compare/v0.3.2...v0.3.3)

CONTRIBUTING.md

@@ -68,7 +68,7 @@ pnpm link -—global groq-sdk
 Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
 
 ```bash
-npx prism path/to/your/openapi.yml
+npx prism mock path/to/your/openapi.yml
 ```
 
 ```bash

README.md

@@ -6,6 +6,8 @@ This library provides convenient access to the Groq REST API from server-side Ty
 
 The REST API documentation can be found [on console.groq.com](https://console.groq.com/docs). The full API of this library can be found in [api.md](api.md).
 
+It is generated with [Stainless](https://www.stainlessapi.com/).
+
 ## Installation
 
 ```sh
@@ -47,7 +49,7 @@ const groq = new Groq();
 async function main() {
   const params: Groq.Chat.CompletionCreateParams = {
     messages: [
-      { role: 'system', content: 'You are a helpful assisstant.' },
+      { role: 'system', content: 'You are a helpful assistant.' },
       { role: 'user', content: 'Explain the importance of low latency LLMs' },
     ],
     model: 'mixtral-8x7b-32768',
@@ -72,7 +74,7 @@ async function main() {
   const chatCompletion = await groq.chat.completions
     .create({
       messages: [
-        { role: 'system', content: 'You are a helpful assisstant.' },
+        { role: 'system', content: 'You are a helpful assistant.' },
         { role: 'user', content: 'Explain the importance of low latency LLMs' },
       ],
       model: 'mixtral-8x7b-32768',
@@ -120,7 +122,7 @@ const groq = new Groq({
 });
 
 // Or, configure per-request:
-await groq.chat.completions.create({ messages: [{ role: 'system', content: 'You are a helpful assisstant.' }, { role: 'user', content: 'Explain the importance of low latency LLMs' }], model: 'mixtral-8x7b-32768' }, {
+await groq.chat.completions.create({ messages: [{ role: 'system', content: 'You are a helpful assistant.' }, { role: 'user', content: 'Explain the importance of low latency LLMs' }], model: 'mixtral-8x7b-32768' }, {
   maxRetries: 5,
 });
 ```
@@ -137,7 +139,7 @@ const groq = new Groq({
 });
 
 // Override per-request:
-await groq.chat.completions.create({ messages: [{ role: 'system', content: 'You are a helpful assisstant.' }, { role: 'user', content: 'Explain the importance of low latency LLMs' }], model: 'mixtral-8x7b-32768' }, {
+await groq.chat.completions.create({ messages: [{ role: 'system', content: 'You are a helpful assistant.' }, { role: 'user', content: 'Explain the importance of low latency LLMs' }], model: 'mixtral-8x7b-32768' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -161,7 +163,7 @@ const groq = new Groq();
 const response = await groq.chat.completions
   .create({
     messages: [
-      { role: 'system', content: 'You are a helpful assisstant.' },
+      { role: 'system', content: 'You are a helpful assistant.' },
       { role: 'user', content: 'Explain the importance of low latency LLMs' },
     ],
     model: 'mixtral-8x7b-32768',
@@ -173,7 +175,7 @@ console.log(response.statusText); // access the underlying Response object
 const { data: chatCompletion, response: raw } = await groq.chat.completions
   .create({
     messages: [
-      { role: 'system', content: 'You are a helpful assisstant.' },
+      { role: 'system', content: 'You are a helpful assistant.' },
       { role: 'user', content: 'Explain the importance of low latency LLMs' },
     ],
     model: 'mixtral-8x7b-32768',
@@ -183,7 +185,51 @@ console.log(raw.headers.get('X-My-Header'));
 console.log(chatCompletion.id);
 ```
 
-## Customizing the fetch client
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API. If you need to access undocumented
+endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
+Options on the client, such as retries, will be respected when making these requests.
+
+```ts
+await client.post('/some/path', {
+  body: { some_prop: 'foo' },
+  query: { some_query_arg: 'bar' },
+});
+```
+
+#### Undocumented request params
+
+To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
+parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
+send will be sent as-is.
+
+```ts
+client.foo.create({
+  foo: 'my_param',
+  bar: 12,
+  // @ts-expect-error baz is not yet public
+  baz: 'undocumented option',
+});
+```
+
+For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
+extra param in the body.
+
+If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
+the response object, or cast the response object to the requisite type. Like the request params, we do not
+validate or strip extra properties from the response from the API.
+
+### Customizing the fetch client
 
 By default, this library uses `node-fetch` in Node, and expects a global `fetch` function in other environments.
 
@@ -201,6 +247,8 @@ import Groq from 'groq-sdk';
 To do the inverse, add `import "groq-sdk/shims/node"` (which does import polyfills).
 This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/groq/groq-typescript/tree/main/src/_shims#readme)).
 
+### Logging and middleware
+
 You may also provide a custom `fetch` function when instantiating the client,
 which can be used to inspect or alter the `Request` or `Response` before/after each request:
 
@@ -221,7 +269,7 @@ const client = new Groq({
 Note that if given a `DEBUG=true` environment variable, this library will log all requests and responses automatically.
 This is intended for debugging purposes only and may change in the future without notice.
 
-## Configuring an HTTP(S) Agent (e.g., for proxies)
+### Configuring an HTTP(S) Agent (e.g., for proxies)
 
 By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
 
@@ -241,7 +289,7 @@ const groq = new Groq({
 await groq.chat.completions.create(
   {
     messages: [
-      { role: 'system', content: 'You are a helpful assisstant.' },
+      { role: 'system', content: 'You are a helpful assistant.' },
       { role: 'user', content: 'Explain the importance of low latency LLMs' },
     ],
     model: 'mixtral-8x7b-32768',
@@ -252,7 +300,7 @@ await groq.chat.completions.create(
 );
 ```
 
-## Semantic Versioning
+## Semantic versioning
 
 This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
 

SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainlessapi.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainlessapi.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+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 Groq please follow the respective company's security reporting guidelines.
+
+### Groq Terms and Policies
+
+Please contact support@groq.com for any questions or concerns regarding security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.