Skip to content

Commit

Permalink
Cosmetic changes for openAIChat reference page
Browse files Browse the repository at this point in the history
  • Loading branch information
MiriamScharnke committed Aug 1, 2024
1 parent b272344 commit ae46982
Showing 1 changed file with 0 additions and 17 deletions.
17 changes: 0 additions & 17 deletions doc/functions/openAIChat.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Connect to OpenAI™ Chat Completion API

`chat = openAIChat(___,Name=Value)`

---

## Description

Expand All @@ -41,12 +40,8 @@ To connect to the OpenAI API, you need a valid API key. For information on how t

`chat = openAIChat(___,PropertyName=PropertyValue)` specifies properties that are settable at construction using one or more name\-value arguments.

---

## Input Arguments

---

### `systemPrompt` – System prompt

character vector | string scalar
Expand All @@ -57,12 +52,8 @@ Specify the system prompt and set the `SystemPrompt` property. The system prompt

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

---

## Name\-Value Arguments

---

### `APIKey` – OpenAI API key

character vector | string scalar
Expand All @@ -84,13 +75,9 @@ Custom functions used by the model to collect or generate additional data.

For an example, see [Analyze Scientific Papers Using ChatGPT Function Calls](../../examples/AnalyzeScientificPapersUsingFunctionCalls.md).

---

## Properties Settable at Construction
Optionally specify these properties at construction using name-value arguments. Specify `PropertyName1=PropertyValue1,...,PropertyNameN=PropertyValueN`, where `PropertyName` is the property name and `PropertyValue` is the corresponding value.

---

### `ModelName` – Model name

`"gpt-4o-mini"` (default) | `"gpt-4"` | `"gpt-3.5-turbo"` | `"dall-e-2"` | ...
Expand Down Expand Up @@ -212,8 +199,6 @@ The JSON response format is not supported for these models:

## Other Properties

---

### `SystemPrompt` – System prompt

character vector | string scalar
Expand Down Expand Up @@ -253,8 +238,6 @@ modelName = "gpt-4o-mini";
chat = openAIChat("You are a helpful assistant awaiting further instructions.",ModelName=modelName);
```

---

## Generate and Stream Text
```matlab
sf = @(x) fprintf("%s",x);
Expand Down

0 comments on commit ae46982

Please sign in to comment.