Functions

Link copied to clipboard
abstract suspend fun assistant(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Retrieves an assistant.

abstract suspend fun assistant(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create an assistant with a model and instructions.

abstract suspend fun assistant(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Update an assistant.

Link copied to clipboard
abstract suspend fun assistants(limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of assistants.

Link copied to clipboard
abstract suspend fun batch(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Batch?

Retrieves a batch.

abstract suspend fun batch(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Batch

Creates and executes a batch from an uploaded file of requests.

Link copied to clipboard
abstract suspend fun batches(after: <Error class: unknown class>? = null, limit: Int? = null, requestOptions: <Error class: unknown class>? = null): List<Batch>

List your organization's batches.

Link copied to clipboard
abstract suspend fun cancel(fineTuneId: <Error class: unknown class>): <Error class: unknown class>?
abstract suspend fun cancel(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Immediately cancel a fine-tune job.

abstract suspend fun cancel(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Cancels a run that is Status.InProgress.

Link copied to clipboard
abstract suspend fun chatCompletion(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Creates a completion for the chat message.

Link copied to clipboard
abstract fun chatCompletions(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

Stream variant of chatCompletion.

Link copied to clipboard
abstract suspend fun completion(request: <Error class: unknown class>): <Error class: unknown class>

This is the main endpoint of the API. Returns the predicted completion for the given prompt, and can also return the probabilities of alternative tokens at each position if requested.

Link copied to clipboard
abstract fun completions(request: <Error class: unknown class>): Flow<<Error class: unknown class>>

Stream variant of completion.

Link copied to clipboard
abstract suspend fun createRun(threadId: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a run.

Link copied to clipboard
abstract suspend fun createStreamingRun(threadId: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

Create a run with event streaming.

Link copied to clipboard
abstract suspend fun createStreamingThreadRun(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

Create a thread and run it in one request with event streaming.

Link copied to clipboard
abstract suspend fun createThreadRun(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a thread and run it in one request.

Link copied to clipboard
abstract suspend fun createVectorStore(request: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a new vector store.

Link copied to clipboard
abstract suspend fun createVectorStoreFile(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a vector store file by attaching a File to a vector store.

Link copied to clipboard
abstract suspend fun createVectorStoreFilesBatch(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a batch of vector store files.

Link copied to clipboard
abstract suspend fun delete(fileId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Boolean

Delete a file. Only owners of organizations can delete files currently.

abstract suspend fun delete(fineTuneModel: <Error class: unknown class>): Boolean

Delete a fine-tuned model. You must have the Owner role in your organization.

abstract suspend fun delete(id: <Error class: unknown class>, fileId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Boolean

Delete a vector store file. This will remove the file from the vector store, but the file itself will not be deleted. To delete the file, OpenAI.delete(fileId).

Link copied to clipboard
abstract suspend fun download(fileId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): ByteArray

Returns the contents of the specified fileId.

Link copied to clipboard
abstract suspend fun edit(request: <Error class: unknown class>): <Error class: unknown class>

Creates a new edit for the provided input, instruction, and parameters.

Link copied to clipboard
abstract suspend fun embeddings(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Creates an embedding vector representing the input text.

Link copied to clipboard
abstract suspend fun file(fileId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Returns information about a specific file.

abstract suspend fun file(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB.

Link copied to clipboard
abstract suspend fun files(requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of files that belong to the user's organization.

Link copied to clipboard
abstract suspend fun fineTune(fineTuneId: <Error class: unknown class>): <Error class: unknown class>?

Gets info about to fine-tune job.

abstract suspend fun fineTune(request: <Error class: unknown class>): <Error class: unknown class>

Creates a job that fine-tunes a specified model from a given dataset.

Link copied to clipboard
abstract suspend fun fineTuneEvents(fineTuneId: <Error class: unknown class>): List<<Error class: unknown class>>

Get fine-grained status updates for fine-tune job.

Link copied to clipboard
abstract fun fineTuneEventsFlow(fineTuneId: <Error class: unknown class>): Flow<<Error class: unknown class>>

Get fine-grained status updates for fine-tune job.

Link copied to clipboard
abstract suspend fun fineTunes(): List<<Error class: unknown class>>

List your organization's fine-tuning jobs.

Link copied to clipboard
abstract suspend fun fineTuningEvents(id: <Error class: unknown class>, after: String? = null, limit: Int? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class><<Error class: unknown class>>

Get status updates for a fine-tuning job.

Link copied to clipboard
abstract suspend fun fineTuningJob(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Get info about a fine-tuning job.

abstract suspend fun fineTuningJob(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Creates a job that fine-tunes a specified model from a given dataset.

Link copied to clipboard
abstract suspend fun fineTuningJobs(after: String? = null, limit: Int? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

List your organization's fine-tuning jobs.

Link copied to clipboard
abstract suspend fun getRun(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Retrieves a run.

Link copied to clipboard
abstract suspend fun imageJSON(creation: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Creates an image given a prompt. Get images as base 64 JSON.

abstract suspend fun imageJSON(edit: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Creates an edited or extended image given an original image and a prompt. Get images as base 64 JSON.

abstract suspend fun imageJSON(variation: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Creates a variation of a given image. Get images as base 64 JSON.

Link copied to clipboard
abstract suspend fun imageURL(creation: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Creates an image given a prompt. Get images as URLs.

abstract suspend fun imageURL(edit: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Creates an edited or extended image given an original image and a prompt. Get images as URLs.

abstract suspend fun imageURL(variation: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Creates a variation of a given image. Get images as URLs.

Link copied to clipboard
abstract suspend fun message(threadId: <Error class: unknown class>, messageId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Retrieve a message.

abstract suspend fun message(threadId: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a message.

abstract suspend fun message(threadId: <Error class: unknown class>, messageId: <Error class: unknown class>, metadata: Map<String, String>? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Modify a message.

Link copied to clipboard
abstract suspend fun messages(threadId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of messages for a given thread.

Link copied to clipboard
abstract suspend fun model(modelId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Retrieves a model instance, providing basic information about the model such as the owner and permission.

Link copied to clipboard
abstract suspend fun models(requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Lists the currently available models, and provides basic information about each one such as the owner and availability.

Link copied to clipboard
abstract suspend fun moderations(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Classifies if a text violates OpenAI's Content Policy.

Link copied to clipboard
abstract suspend fun runs(threadId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of runs belonging to a thread.

Link copied to clipboard
abstract suspend fun runStep(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, stepId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Retrieves a run step.

Link copied to clipboard
abstract suspend fun runSteps(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Retrieves a run step.

Link copied to clipboard
abstract suspend fun speech(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): ByteArray

Generates audio from the input text.

Link copied to clipboard
abstract suspend fun submitStreamingToolOutput(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, output: List<<Error class: unknown class>>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

When a run has the status: Status.RequiresAction and required action is RequiredAction.SubmitToolOutputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request using event streaming.

Link copied to clipboard
abstract suspend fun submitToolOutput(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, output: List<<Error class: unknown class>>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

When a run has the status: Status.RequiresAction and required action is RequiredAction.SubmitToolOutputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.

Link copied to clipboard
abstract suspend fun thread(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Retrieve a thread.

abstract suspend fun thread(request: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a thread.

abstract suspend fun thread(id: <Error class: unknown class>, metadata: Map<String, String>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Modify a thread.

Link copied to clipboard
abstract suspend fun transcription(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Transcribes audio into the input language.

Link copied to clipboard
abstract suspend fun translation(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Translates audio into English.

Link copied to clipboard
abstract suspend fun updateRun(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, metadata: Map<String, String>? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Modifies a run.

Link copied to clipboard
abstract suspend fun updateVectorStore(id: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Update a vector store.

Link copied to clipboard
abstract suspend fun vectorStore(id: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Retrieve a vector store.

Link copied to clipboard
abstract suspend fun vectorStoreFileBatch(vectorStoreId: <Error class: unknown class>, batchId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>?

Retrieves a vector store file batch.

Link copied to clipboard
abstract suspend fun vectorStoreFiles(id: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, filter: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of vector store files.

Link copied to clipboard
abstract suspend fun vectorStoreFilesBatches(vectorStoreId: <Error class: unknown class>, batchId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, filter: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of vector store files in a batch.

Link copied to clipboard
abstract suspend fun vectorStores(limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

List all vector stores.