OpenAIChatHelper
The chat helper allow to keep a list of messages in memory and make consecutive prompt.
Properties
| Property Name | Type | Default Value | Description |
|---|---|---|---|
chat | OpenAIChatAPI | - | The chat API instance used for communication with OpenAI. |
systemPrompt | OpenAIMessage | - | The system prompt message that guides the chat assistant's responses. |
numberOfMessages | Integer | 5 | The maximum number of messages to retain in the chat history. |
parameters | OpenAIChatCompletionsParameters | - | The parameters for the OpenAI chat completion request. |
messages | Collection of OpenAIMessage | [] | The collection of messages exchanged in the chat session. |
Functions
prompt()
prompt(prompt : Text) : OpenAIChatCompletionsResult
| Parameter | Type | Description |
|---|---|---|
| prompt | Text | The text prompt to send to OpenAI chat. |
| Function result | OpenAIChatCompletionsResult | The completion result returned by the chat. |
Sends a user prompt to the chat and returns the corresponding completion result.
Example Usage
var $chatHelper:=$client.chat.create("You are a helpful assistant.")
var $result:=$chatHelper.prompt("Hello, how can I help you today?")
$result:=$chatHelper.prompt("Why 42?")