Skip to content

Clarify assistant stream helper events #1873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jaksenc wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −0
Open

Clarify assistant stream helper events #1873

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,19 @@ The assistant API provides events you can subscribe to for the following events.
This allows you to subscribe to all the possible raw events sent by the OpenAI streaming API.
In many cases it will be more convenient to subscribe to a more specific set of events for your use case.

Raw API event names such as `thread.run.completed` are available through the `event` helper event:

```ts
openai.beta.threads.runs.stream(thread.id, { assistant_id: assistant.id }).on('event', (event) => {
if (event.event === 'thread.run.completed') {
console.log('Run completed', event.data);
}
});
```

The other events in this section, such as `textDelta` and `toolCallDone`, are SDK convenience events built
from those raw API events.

More information on the types of events can be found here: [Events](https://platform.openai.com/docs/api-reference/assistants-streaming/events)

```ts
Expand Down