Skip to content

Latest commit

 

History

History
158 lines (96 loc) · 6.69 KB

api.md

File metadata and controls

158 lines (96 loc) · 6.69 KB

Completions

Types:

Methods:

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

Chat

Completions

Types:

Methods:

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

Edits

Types:

Methods:

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

Embeddings

Types:

Methods:

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

Files

Types:

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:

Methods:

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

Audio

Transcriptions

Types:

Methods:

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

Translations

Types:

Methods:

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

Moderations

Types:

Methods:

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

Models

Types:

Methods:

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

FineTuning

Jobs

Types:

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:

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