OpenAI | /mod.ts | openai@v4.69.0

namespace OpenAI

import { OpenAI } from "https://deno.land/x/openai@v4.69.0/mod.ts";

Type Aliases

T OpenAI.AudioModel
T OpenAI.AudioResponseFormat
T OpenAI.Batch
T OpenAI.BatchCreateParams
T OpenAI.BatchError
T OpenAI.BatchListParams
T OpenAI.BatchRequestCounts
T OpenAI.ChatCompletion
T OpenAI.ChatCompletionAssistantMessageParam
T OpenAI.ChatCompletionAudio
T OpenAI.ChatCompletionAudioParam
T OpenAI.ChatCompletionChunk
T OpenAI.ChatCompletionContentPart
T OpenAI.ChatCompletionContentPartImage
T OpenAI.ChatCompletionContentPartInputAudio
T OpenAI.ChatCompletionContentPartRefusal
T OpenAI.ChatCompletionContentPartText
T OpenAI.ChatCompletionCreateParams
T OpenAI.ChatCompletionCreateParamsNonStreaming
T OpenAI.ChatCompletionCreateParamsStreaming
T OpenAI.ChatCompletionFunctionCallOption
T OpenAI.ChatCompletionFunctionMessageParam
T OpenAI.ChatCompletionMessage
T OpenAI.ChatCompletionMessageParam
T OpenAI.ChatCompletionMessageToolCall
T OpenAI.ChatCompletionModality
T OpenAI.ChatCompletionNamedToolChoice
T OpenAI.ChatCompletionRole
T OpenAI.ChatCompletionStreamOptions
T OpenAI.ChatCompletionSystemMessageParam
T OpenAI.ChatCompletionTokenLogprob
T OpenAI.ChatCompletionTool
T OpenAI.ChatCompletionToolChoiceOption
T OpenAI.ChatCompletionToolMessageParam
T OpenAI.ChatCompletionUserMessageParam
T OpenAI.ChatModel
T OpenAI.Completion
T OpenAI.CompletionChoice
T OpenAI.CompletionCreateParams
T OpenAI.CompletionCreateParamsNonStreaming
T OpenAI.CompletionCreateParamsStreaming
T OpenAI.CompletionUsage
T OpenAI.CreateEmbeddingResponse
T OpenAI.CursorPageParams
T OpenAI.CursorPageResponse
T OpenAI.Embedding
T OpenAI.EmbeddingCreateParams
T OpenAI.EmbeddingModel
T OpenAI.ErrorObject
T OpenAI.FileContent
T OpenAI.FileCreateParams
T OpenAI.FileDeleted
T OpenAI.FileListParams
T OpenAI.FileObject
T OpenAI.FilePurpose
T OpenAI.FunctionDefinition
T OpenAI.FunctionParameters
T OpenAI.Image
T OpenAI.ImageCreateVariationParams
T OpenAI.ImageEditParams
T OpenAI.ImageGenerateParams
T OpenAI.ImageModel
T OpenAI.ImagesResponse
T OpenAI.Model
T OpenAI.ModelDeleted
T OpenAI.Moderation
T OpenAI.ModerationCreateParams
T OpenAI.ModerationCreateResponse
T OpenAI.ModerationImageURLInput
T OpenAI.ModerationModel
T OpenAI.ModerationMultiModalInput
T OpenAI.ModerationTextInput
T OpenAI.PageResponse
T OpenAI.RequestOptions
T OpenAI.ResponseFormatJSONObject
T OpenAI.ResponseFormatJSONSchema
T OpenAI.ResponseFormatText
T OpenAI.Upload
T OpenAI.UploadCompleteParams
T OpenAI.UploadCreateParams

class OpenAI

import { OpenAI } from "https://deno.land/x/openai@v4.69.0/mod.ts";

API Client for interfacing with the OpenAI API.

Constructors

new

OpenAI(unnamed 0?: ClientOptions)

API Client for interfacing with the OpenAI API.

Properties

private

_options: ClientOptions

apiKey: string

audio: API.Audio

batches: API.Batches

beta: API.Beta

chat: API.Chat

completions: API.Completions

embeddings: API.Embeddings

files: API.Files

fineTuning: API.FineTuning

images: API.Images

models: API.Models

moderations: API.Moderations

organization: string | null

project: string | null

uploads: API.Uploads

Methods

protected

authHeaders(opts: Core.FinalRequestOptions): Core.Headers

protected

defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers

protected

defaultQuery(): Core.DefaultQuery | undefined

protected

stringifyQuery(query: Record<string, unknown>): string

Static Properties

APIConnectionError

APIConnectionTimeoutError

APIError

APIUserAbortError

AuthenticationError

BadRequestError

ConflictError

DEFAULT_TIMEOUT: number

fileFromPath

InternalServerError

NotFoundError

OpenAI

OpenAIError

PermissionDeniedError

RateLimitError

toFile

UnprocessableEntityError