Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/simple_openai/mod.ts>OpenAI

Simple API connection compatible with OpenAI and AzureOpenAI.
Latest
class OpenAI
import { OpenAI } from "https://deno.land/x/simple_openai@v1.3.2/mod.ts";

Provides simple interface for communication with OpenAI.

Constructors

new
OpenAI(
key: string,
version: string,
azure?: string,
)

Create instance with set API key. If you set Azure resource as 3rd argument, will connect to AzureOpenAI instead of OpenAI.

Properties

readonly
isAzure: boolean

If instance is AzureOpenAI mode.

Methods

cancelFineTune(id: string): Promise<NativeOpenAI.FineTunes.FineTune>

Please check OpenAI official document for details.

createChatCompletion(option: NativeOpenAI.Chat.ChatCompletionCreateParamsNonStreaming): Promise<NativeOpenAI.Chat.ChatCompletion>

Please check OpenAI official document for details.

createFineTune(option: NativeOpenAI.FineTunes.FineTuneCreateParams): Promise<NativeOpenAI.FineTunes.FineTune>

Please check OpenAI official document for details.

createImage(option: NativeOpenAI.Images.ImageGenerateParams): Promise<NativeOpenAI.Images.ImagesResponse>

Please check OpenAI official document for details.

deleteFile(id: string): Promise<NativeOpenAI.Files.FileDeleted>

Please check OpenAI official document for details.

deleteModel(id: string): Promise<NativeOpenAI.Models.ModelDeleted>

Please check OpenAI official document for details.

listFiles(): Promise<NativeOpenAI.Files.FileObjectsPage>

Please check OpenAI official document for details.

listFineTuneEvents(id: string): Promise<NativeOpenAI.FineTunes.FineTuneEventsListResponse>

Please check OpenAI official document for details.

listFineTunes(): Promise<NativeOpenAI.FineTunes.FineTunesPage>

Please check OpenAI official document for details.

listModels(): Promise<NativeOpenAI.Models.ModelsPage>

Please check OpenAI official document for details.

retrieveFile(id: string): Promise<NativeOpenAI.Files.FileObject>

Please check OpenAI official document for details.

retrieveFineTune(id: string): Promise<NativeOpenAI.FineTunes.FineTune>

Please check OpenAI official document for details.

retrieveModel(model: string): Promise<NativeOpenAI.Models.Model>

Please check OpenAI official document for details.