Skip to content

Commit 13ba080

Browse files
MiriamScharnkeccreutzi
authored andcommitted
Document new models "o1-preview" and "o1-mini"
1 parent fae9042 commit 13ba080

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

doc/functions/openAIChat.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,12 @@ To connect to the OpenAI API, you need a valid API key. For information on how t
4242
character vector | string scalar
4343

4444

45-
Specify the system prompt and set the `SystemPrompt` property. The system prompt is a natural language description that provides the framework in which a large language model generates its responses. The system prompt can include instructions about tone, communications style, language, etc.
45+
Specify the system prompt and set the `SystemPrompt` property. The system prompt is a natural language description that provides the framework in which a large language model generates its responses. The system prompt can include instructions about tone, communications style, language, etc.
4646

47+
Specifying a system prompt is not supported for these models:
48+
49+
- `ModelName="o1-preview"`
50+
- `ModelName="o1-mini"`
4751

4852
**Example**: `"You are a helpful assistant who provides answers to user queries in iambic pentameter."`
4953

@@ -94,10 +98,10 @@ Optionally specify these properties at construction using name\-value arguments.
9498

9599
### `ModelName` — Model name
96100

97-
`"gpt-4o-mini"` (default) | `"gpt-4"` | `"gpt-3.5-turbo"` | `"dall-e-2"` | ...
101+
`"gpt-4o-mini"` (default) | `"gpt-4"` | `"o1-mini"` | `"gpt-3.5-turbo"` | ...
98102

99103

100-
Name of the OpenAI model to use for text or image generation.
104+
Name of the OpenAI model to use for text generation.
101105

102106

103107
For information about currently supported models, see [OpenAI API](../OpenAI.md).
@@ -197,6 +201,10 @@ The system prompt is a natural\-language description that provides the framework
197201

198202
To set the `SystemPrompt` property at construction, specify the `systemPrompt` input argument.
199203

204+
Specifying a system prompt is not supported for these models:
205+
206+
- `ModelName="o1-preview"`
207+
- `ModelName="o1-mini"`
200208

201209
**Example**: `"You are a helpful assistant who provides answers to user queries in iambic pentameter."`
202210

0 commit comments

Comments
 (0)