wkok.openai-clojure.api

Public Variable	Short Description
cancel-fine-tuning-job (clj)	Immediately cancel a fine-tuning job.
cancel-run (clj)	Returns a list of run steps belonging to a run.
create-assistant (clj)	Create an assistant with a model and instructions.
create-chat-completion (clj)	Creates a completion for the chat message Example: ``` (create-chat-completion {:model "gpt-3.5-turbo" :messages [{:role "system" :content "You are a helpful assistant."} {:role "user" :content "Who won the world series in 2020?"} {:role "assistant" :content "The Los Angeles Dodgers won the World Series in 2020."} {:role "user" :content "Where was it played?"}]}) ``` For Azure OpenAI pass `{:impl :azure}` for the `options` argument Streaming of token events is supported via the `:stream` param, see [Streaming Tokens](/doc/03-streaming.md) Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/chat/create) / [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions) documentation.
create-completion (clj)	Creates a completion for the provided prompt and parameters Example: ``` (create-completion {:model "text-davinci-003" :prompt "Say this is a test" :max_tokens 7 :temperature 0}) ``` For Azure OpenAI pass `{:impl :azure}` for the `options` argument Streaming of token events is supported via the `:stream` param, see [Streaming Tokens](/doc/03-streaming.md) Also see the [OpenAI](https://platform.openai.com/docs/api-reference/completions/create) / [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#completions) documentation.
create-embedding (clj)	Creates an embedding vector representing the input text.
create-file (clj)	Upload a file that contains document(s) to be used across various endpoints/features.
create-fine-tuning-job (clj)	Creates a job that fine-tunes a specified model from a given dataset.
create-image (clj)	Creates an image given a prompt.
create-image-edit (clj)	Creates an edited or extended image given an original image and a prompt.
create-image-variation (clj)	Creates a variation of a given image.
create-message (clj)	Create a message.
create-moderation (clj)	Classifies if text violates OpenAI's Content Policy Example: ``` (create-moderation {:input "I want to kill them"}) ``` Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/moderations/create).
create-run (clj)	Create a run.
create-speech (clj)	Creates audio from text.
create-thread (clj)	Create a thread.
create-thread-and-run (clj)	Create a thread and run it in one request.
create-transcription (clj)	Transcribes audio into the input language.
create-translation (clj)	Translates audio into English.
create-vector-store (clj)	Create a vector store.
delete-assistant (clj)	Delete an assistant.
delete-file (clj)	Delete a file.
delete-model (clj)	Delete a fine-tuned model.
delete-thread (clj)	Delete a thread.
delete-vector-store (clj)	Deletes a vector store.
download-file (clj)	Returns the contents of the specified file Example: ``` (download-file {:file-id "file-wefuhweof"}) ``` Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/files/retrieve-content).
list-assistants (clj)	Returns a list of assistants.
list-files (clj)	Returns a list of files that belong to the user's organization.
list-fine-tuning-events (clj)	Get status updates for a fine-tuning job.
list-fine-tuning-jobs (clj)	List your organization's fine-tuning jobs Example: ``` (list-fine-tuning-jobs) ``` Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/fine-tuning/list).
list-messages (clj)	Returns a list of messages for a given thread.
list-models (clj)	Lists the currently available models, and provides basic information about each one such as the owner and availability.
list-run-steps (clj)	Returns a list of run steps belonging to a run.
list-runs (clj)	Returns a list of runs belonging to a thread.
list-vector-stores (clj)	Returns a list of vector stores.
modify-assistant (clj)	Modifies an assistant.
modify-message (clj)	Modify a message.
modify-run (clj)	Modifies a run.
modify-thread (clj)	Modifies a thread.
modify-vector-store (clj)	Modifies a vector store.
retrieve-assistant (clj)	Retrieves an assistant.
retrieve-file (clj)	Returns information about a specific file.
retrieve-fine-tuning-job (clj)	Gets info about a fine-tuning job.
retrieve-message (clj)	Retrieve a message.
retrieve-model (clj)	Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
retrieve-run (clj)	Retrieves a run.
retrieve-run-step (clj)	Retrieves a run step.
retrieve-thread (clj)	Retrieves a thread.
retrieve-vector-store (clj)	Retrieves a vector store.
submit-tool-outputs-to-run (clj)	When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

Immediately cancel a fine-tuning job.

Returns a list of run steps belonging to a run.

Create an assistant with a model and instructions.

Creates a completion for the chat message Example: ``` (create-chat-completion {:model "gpt-3.5-turbo" :messages [{:role "system" :content "You are a helpful assistant."} {:role "user" :content "Who won the world series in 2020?"} {:role "assistant" :content "The Los Angeles Dodgers won the World Series in 2020."} {:role "user" :content "Where was it played?"}]}) ``` For Azure OpenAI pass `{:impl :azure}` for the `options` argument Streaming of token events is supported via the `:stream` param, see [Streaming Tokens](/doc/03-streaming.md) Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/chat/create) / [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions) documentation.

create-completion (clj)

Creates a completion for the provided prompt and parameters Example: ``` (create-completion {:model "text-davinci-003" :prompt "Say this is a test" :max_tokens 7 :temperature 0}) ``` For Azure OpenAI pass `{:impl :azure}` for the `options` argument Streaming of token events is supported via the `:stream` param, see [Streaming Tokens](/doc/03-streaming.md) Also see the [OpenAI](https://platform.openai.com/docs/api-reference/completions/create) / [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#completions) documentation.

create-embedding (clj)

Creates an embedding vector representing the input text.

create-file (clj)

Upload a file that contains document(s) to be used across various endpoints/features.

create-fine-tuning-job (clj)

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

create-image (clj)

Creates an image given a prompt.

create-image-edit (clj)

Creates an edited or extended image given an original image and a prompt.

create-image-variation (clj)

Creates a variation of a given image.

create-message (clj)

Create a message.

create-moderation (clj)

Classifies if text violates OpenAI's Content Policy Example: ``` (create-moderation {:input "I want to kill them"}) ``` Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/moderations/create).

create-run (clj)

Create a run.

create-speech (clj)

Creates audio from text.

create-thread (clj)

Create a thread.

create-thread-and-run (clj)

Create a thread and run it in one request.

create-transcription (clj)

Transcribes audio into the input language.

create-translation (clj)

Translates audio into English.

create-vector-store (clj)

Create a vector store.

delete-assistant (clj)

Delete an assistant.

delete-file (clj)

Delete a file.

delete-model (clj)

Delete a fine-tuned model.

delete-thread (clj)

Delete a thread.

delete-vector-store (clj)

Deletes a vector store.

download-file (clj)

Returns the contents of the specified file Example: ``` (download-file {:file-id "file-wefuhweof"}) ``` Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/files/retrieve-content).

list-assistants (clj)

Returns a list of assistants.

list-files (clj)

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

list-fine-tuning-events (clj)

Get status updates for a fine-tuning job.

list-fine-tuning-jobs (clj)

List your organization's fine-tuning jobs Example: ``` (list-fine-tuning-jobs) ``` Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/fine-tuning/list).

list-messages (clj)

Returns a list of messages for a given thread.

list-models (clj)

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

list-run-steps (clj)

Returns a list of run steps belonging to a run.

list-runs (clj)

Returns a list of runs belonging to a thread.

list-vector-stores (clj)

Returns a list of vector stores.

modify-assistant (clj)

Modifies an assistant.

modify-message (clj)

Modify a message.

modify-run (clj)

Modifies a run.

modify-thread (clj)

Modifies a thread.

modify-vector-store (clj)

Modifies a vector store.

retrieve-assistant (clj)

Retrieves an assistant.

retrieve-file (clj)

Returns information about a specific file.

retrieve-fine-tuning-job (clj)

Gets info about a fine-tuning job.

retrieve-message (clj)

Retrieve a message.

retrieve-model (clj)

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

retrieve-run (clj)

Retrieves a run.

retrieve-run-step (clj)

Retrieves a run step.

retrieve-thread (clj)

Retrieves a thread.

retrieve-vector-store (clj)

Retrieves a vector store.

submit-tool-outputs-to-run (clj)

When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed.