api.md

Completions

Types:

• Completion
• CompletionChoice
• CompletionUsage

Methods:

• client.completions.create({ ...params }) -> Completion

Chat

Completions

Types:

• ChatCompletion
• ChatCompletionChunk
• ChatCompletionMessage
• ChatCompletionMessageParam
• ChatCompletionRole
• CreateChatCompletionRequestMessage

Methods:

• client.chat.completions.create({ ...params }) -> ChatCompletion

Edits

Types:

• Edit

Methods:

• client.edits.create({ ...params }) -> Edit

Embeddings

Types:

• CreateEmbeddingResponse
• Embedding

Methods:

• client.embeddings.create({ ...params }) -> CreateEmbeddingResponse

Files

Types:

• FileContent
• FileDeleted
• FileObject

Methods:

• client.files.create({ ...params }) -> FileObject
• client.files.retrieve(fileId) -> FileObject
• client.files.list() -> FileObjectsPage
• client.files.del(fileId) -> FileDeleted
• client.files.retrieveContent(fileId) -> string
• client.files.waitForProcessing(id, { pollInterval = 5000, maxWait = 30 _ 60 _ 1000 }) -> Promise<FileObject>

Images

Types:

• Image
• ImagesResponse

Methods:

• client.images.createVariation({ ...params }) -> ImagesResponse
• client.images.edit({ ...params }) -> ImagesResponse
• client.images.generate({ ...params }) -> ImagesResponse

Audio

Transcriptions

Types:

• Transcription

Methods:

• client.audio.transcriptions.create({ ...params }) -> Transcription

Translations

Types:

• Translation

Methods:

• client.audio.translations.create({ ...params }) -> Translation

Moderations

Types:

• Moderation
• ModerationCreateResponse

Methods:

• client.moderations.create({ ...params }) -> ModerationCreateResponse

Models

Types:

• Model
• ModelDeleted

Methods:

• client.models.retrieve(model) -> Model
• client.models.list() -> ModelsPage
• client.models.del(model) -> ModelDeleted

FineTuning

Jobs

Types:

• FineTuningJob
• FineTuningJobEvent

Methods:

• client.fineTuning.jobs.create({ ...params }) -> FineTuningJob
• client.fineTuning.jobs.retrieve(fineTuningJobId) -> FineTuningJob
• client.fineTuning.jobs.list({ ...params }) -> FineTuningJobsPage
• client.fineTuning.jobs.cancel(fineTuningJobId) -> FineTuningJob
• client.fineTuning.jobs.listEvents(fineTuningJobId, { ...params }) -> FineTuningJobEventsPage

FineTunes

Types:

• FineTune
• FineTuneEvent
• FineTuneEventsListResponse

Methods:

• client.fineTunes.create({ ...params }) -> FineTune
• client.fineTunes.retrieve(fineTuneId) -> FineTune
• client.fineTunes.list() -> FineTunesPage
• client.fineTunes.cancel(fineTuneId) -> FineTune
• client.fineTunes.listEvents(fineTuneId, { ...params }) -> FineTuneEventsListResponse