Skip to content

Commit

Permalink
docs(readme): mention .withResponse() for streaming request ID (#1202)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertCraigie authored Nov 22, 2024
1 parent 6c25833 commit b6800d4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,18 @@ const completion = await client.chat.completions.create({ messages: [{ role: 'us
console.log(completion._request_id) // req_123
```

You can also access the Request ID using the `.withResponse()` method:

```ts
const { data: stream, request_id } = await openai.chat.completions
.create({
model: 'gpt-4',
messages: [{ role: 'user', content: 'Say this is a test' }],
stream: true,
})
.withResponse();
```

## Microsoft Azure OpenAI

To use this library with [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview), use the `AzureOpenAI`
Expand Down

0 comments on commit b6800d4

Please sign in to comment.