Skip to content

Commit

Permalink
feat (docs): add note on developer messages (#4173)
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrammel authored Dec 20, 2024
1 parent 0b62487 commit 7370e41
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions content/providers/01-ai-sdk-providers/01-openai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -390,10 +390,17 @@ console.log('Usage:', {
```

<Note type="warning">
Reasoning models like `o1`, `o1-preview`, and `o1-mini` require additional
runtime inference to complete their reasoning phase before generating a
response. You can use the `reasoningEffort` model setting to influence the
inference time.
Reasoning models like `o1-mini` and `o1-preview` require additional runtime
inference to complete their reasoning phase before generating a response. This
introduces longer latency compared to other models, with `o1-preview`
exhibiting significantly more inference time than `o1-mini`.
</Note>

<Note>
OpenAI has introduced a new `developer` message type for reasoning models.
However, `system` messages are automatically converted to `developer` messages
by OpenAI. You can pass `system` messages to reasoning models and set the
`system` instruction as usual.
</Note>

#### Prompt Caching
Expand Down Expand Up @@ -551,7 +558,7 @@ using the `.embedding()` factory method.
const model = openai.embedding('text-embedding-3-large');
```

OpenAI embedding models support several aditional settings.
OpenAI embedding models support several additional settings.
You can pass them as an options argument:

```ts
Expand Down

0 comments on commit 7370e41

Please sign in to comment.