OpenAIModel class
A PromptCompletionModel for calling OpenAI and Azure OpenAI hosted models.
Constructors
| Open |
Creates a new |
Properties
| events | Events emitted by the model. |
| options | Options the client was configured with. |
Methods
| complete |
Completes a prompt using OpenAI or Azure OpenAI. |
Constructor Details
OpenAIModel(OpenAIModelOptions | AzureOpenAIModelOptions)
Creates a new OpenAIModel instance.
new OpenAIModel(options: OpenAIModelOptions | AzureOpenAIModelOptions)Parameters
- options
Options for configuring the model client.
Property Details
events
Events emitted by the model.
PromptCompletionModelEmitter eventsProperty Value
The events emitted by the model.
options
Options the client was configured with.
options: OpenAIModelOptions | AzureOpenAIModelOptionsProperty Value
Method Details
completePrompt(TurnContext, Memory, PromptFunctions, Tokenizer, PromptTemplate)
Completes a prompt using OpenAI or Azure OpenAI.
function completePrompt(context: TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate): Promise<PromptResponse<string>>Parameters
- context
-
TurnContext
Current turn context.
- memory
- Memory
An interface for accessing state values.
- functions
- PromptFunctions
Functions to use when rendering the prompt.
- tokenizer
- Tokenizer
Tokenizer to use when rendering the prompt.
- template
- PromptTemplate
Prompt template to complete.
Returns
Promise<PromptResponse<string>>
A PromptResponse with the status and message.