Skip to content

docs: clarify assistant stream event names #1860

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
HenryLee789 wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −1
Open

docs: clarify assistant stream event names #1860

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: 12 additions & 1 deletion helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,17 @@ In many cases it will be more convenient to subscribe to a more specific set of

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

Raw API event names, such as `thread.run.completed`, are exposed through the `event` listener. The
SDK-specific convenience listeners below use names such as `messageDone`, `runStepDone`, and `end`.

```ts
run.on('event', (event) => {
if (event.event === 'thread.run.completed') {
console.log('run completed', event.data);
}
});
```

```ts
.on('runStepCreated', (runStep: RunStep) => ...)
.on('runStepDelta', (delta: RunStepDelta, snapshot: RunStep) => ...)
Expand Down Expand Up @@ -251,7 +262,7 @@ More information on tools can be found here [Tools](https://platform.openai.com/
.on('end', () => ...)
```

The last event send when a stream ends.
The last event sent when a stream ends.

### Assistant Methods

Expand Down