Skip to content

Commit

Permalink
docs(README): fix helpers section links (#1224)
Browse files Browse the repository at this point in the history
  • Loading branch information
guspan-tanadi authored and stainless-app[bot] committed Dec 13, 2024
1 parent 28649f8 commit 3a6bfe4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ main();
```

Streaming with `openai.beta.chat.completions.stream({…})` exposes
[various helpers for your convenience](helpers.md#events) including event handlers and promises.
[various helpers for your convenience](helpers.md#chat-events) including event handlers and promises.

Alternatively, you can use `openai.chat.completions.create({ stream: true, … })`
which only returns an async iterable of the chunks in the stream and thus uses less memory
Expand Down Expand Up @@ -285,12 +285,12 @@ main();
// Final content: "It's looking cold and rainy - you might want to wear a jacket!"
```

Like with `.stream()`, we provide a variety of [helpers and events](helpers.md#events).
Like with `.stream()`, we provide a variety of [helpers and events](helpers.md#chat-events).

Note that `runFunctions` was previously available as well, but has been deprecated in favor of `runTools`.

Read more about various examples such as with integrating with [zod](helpers.md#integrate-with-zod),
[next.js](helpers.md#integrate-wtih-next-js), and [proxying a stream to the browser](helpers.md#proxy-streaming-to-a-browser).
[next.js](helpers.md#integrate-with-nextjs), and [proxying a stream to the browser](helpers.md#proxy-streaming-to-a-browser).

## File uploads

Expand Down

0 comments on commit 3a6bfe4

Please sign in to comment.