Skip to content

Fixed turn_detection examples in readme #67

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed turn_detection examples in readme #67

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const client = new RealtimeClient({ apiKey: process.env.OPENAI_API_KEY });
client.updateSession({ instructions: 'You are a great, upbeat friend.' });
client.updateSession({ voice: 'alloy' });
client.updateSession({
turn_detection: { type: 'none' }, // or 'server_vad'
turn_detection: null, // or { type: 'server_vad' }
input_audio_transcription: { model: 'whisper-1' },
});

Expand Down Expand Up @@ -130,7 +130,7 @@ client.sendUserMessageContent([

## Sending streaming audio

To send streaming audio, use the `.appendInputAudio()` method. If you're in `turn_detection: 'disabled'` mode,
To send streaming audio, use the `.appendInputAudio()` method. If you're in `turn_detection: null` mode,
then you need to use `.createResponse()` to tell the model to respond.

```javascript
Expand Down Expand Up @@ -257,7 +257,7 @@ client.on('conversation.item.completed', ({ item }) => {

## Interrupting the model

You may want to manually interrupt the model, especially in `turn_detection: 'disabled'` mode.
You may want to manually interrupt the model, especially in `turn_detection: null` mode.
To do this, we can use:

```javascript
Expand Down