Skip to content

Commit c603ec7

Browse files
MiriamScharnkeccreutzi
authored andcommitted
Miscellaneous doc fixes
* Remove git clone from README * Remove gpt-3.5 and gpt-4 from azureChat.md * More helpful link in openAIChat.md For information about supported models, link directly to OpenAI doc instead of linking to our OpenAI.md which then links to the OpenAI doc. * fixed "ReponseFormat" typo
1 parent becf0a5 commit c603ec7

File tree

3 files changed

+4
-18
lines changed

3 files changed

+4
-18
lines changed

README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,7 @@ The recommended way of using the add-on on an installed version of MATLAB is to
4040
1. In MATLAB, go to the **Home** tab, and in the **Environment** section, click the **Add\-Ons** icon.
4141
2. In the Add\-On Explorer, search for "Large Language Models (LLMs) with MATLAB".
4242
3. Select **Install**.
43-
## Install by Cloning GitHub Repository
4443

45-
Alternatively, to use the add-on on an installed version of MATLAB, you can clone the GitHub repository. In the MATLAB Command Window, run this command:
46-
47-
```
48-
>> !git clone https://github.com/matlab-deep-learning/llms-with-matlab.git
49-
```
50-
51-
To run code from the add-on outside of the installation directory, if you install the add-on by cloning the GitHub repository, then you must add the path to the installation directory.
52-
53-
```
54-
>> addpath("path/to/llms-with-matlab")
55-
```
5644
# Get Started with External APIs
5745

5846
For more information about how to connect to the different APIs from MATLAB, including installation requirements, see:

doc/functions/azureChat.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ The deployment ID, also known as deployment name, specifies the Azure OpenAI dep
113113

114114
Instead of using the `DeploymentID` name\-value argument, you can also set the environment variable AZURE\_OPENAI\_DEPLOYMENT. For more information, see [Azure OpenAI Services API](../Azure.md).
115115

116-
**Example**: `"my-gpt-35-turbo-deployment"`
116+
**Example**: `"my-gpt-4o-mini-deployment"`
117117

118118
### `APIVersion` — API Version
119119

@@ -207,14 +207,12 @@ To configure the format of the generated JSON file, describe the format using na
207207

208208
The JSON response format is not supported for these models:
209209

210-
- `"gpt-4"`
211-
- `"gpt-4-0613"`
212210
- `"o1-mini"`
213211

214212
#### Structured Output
215213

216214

217-
To ensure that the model follows the required format, use structured output. To do this, set `ReponseFormat` to:
215+
To ensure that the model follows the required format, use structured output. To do this, set `ResponseFormat` to:
218216

219217
- A string scalar containing a valid JSON Schema.
220218
- A structure array containing an example that adheres to the required format, for example: `ResponseFormat=struct("Name","Rudolph","NoseColor",[255 0 0])`
@@ -281,5 +279,5 @@ ans = "The question "Why is a raven like a writing desk?" is a famous nonsensica
281279
[`generate`](generate.md) | [`openAIChat`](openAIChat.md) | [`ollamaChat`](ollamaChat.md)
282280

283281

284-
*Copyright 2024 The MathWorks, Inc.*
282+
*Copyright 2024-2025 The MathWorks, Inc.*
285283

doc/functions/openAIChat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Optionally specify these properties at construction using name\-value arguments.
101101
Name of the OpenAI model to use for text generation.
102102

103103

104-
For information about currently supported models, see [OpenAI API](../OpenAI.md).
104+
For information about currently supported models, see the OpenAI documentation at [https://platform.openai.com/docs/overview](https://platform.openai.com/docs/overview).
105105

106106
### `Temperature` — Temperature
107107

0 commit comments

Comments
 (0)