wkok.openai-clojure.api — net.clojars.wkok/openai-clojure 0.12.0

cancel-fine-tune clj deprecated

(cancel-fine-tune params)

(cancel-fine-tune params options)

(Deprecated) Immediately cancel a fine-tune job.

Example:

(cancel-fine-tune {:fine_tune_id "ft-1wefweub"})

Also see the OpenAI documentation

cancel-fine-tuning-job clj

(cancel-fine-tuning-job params)

(cancel-fine-tuning-job params options)

Immediately cancel a fine-tuning job.

Example:

(cancel-fine-tuning-job {:fine_tuning_job_id "ft-1wefweub"})

Also see the OpenAI documentation

cancel-run clj

(cancel-run params)

(cancel-run params options)

Returns a list of run steps belonging to a run.

Example:

(cancel-run {:thread_id    "----id----"
             :run_id       "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/cancelRun

create-assistant clj

(create-assistant params)

(create-assistant params options)

Create an assistant with a model and instructions.

Example:

(create-assistant {:name "My PDF Assistant"
                   :model "gpt-4-1106-preview"
                   :instructions "You are my personal PDF assistant. You modify
                                   and extract pages from the file."
                   :tools [{:type "code_interpreter"}]}

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/createAssistant

create-assistant-file clj

(create-assistant-file params)

(create-assistant-file params options)

Create an assistant file by attaching a File to an assistant.

Example:

(create-assistant-file {:assistant_id "----id----"
                        :file_id "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/createAssistantFile

create-chat-completion clj

(create-chat-completion params)

(create-chat-completion params options)

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

Also see the OpenAI documentation / Azure OpenAI documentation

create-completion clj

(create-completion params)

(create-completion params options)

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

Also see the OpenAI / Azure OpenAI documentation

create-edit clj

(create-edit params)

(create-edit params options)

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

Example:

(create-edit {:model "text-davinci-edit-001"
              :input "What day of the wek is it?"
              :instruction "Fix the spelling mistakes"})

Also see the OpenAI documentation

create-embedding clj

(create-embedding params)

(create-embedding params options)

Creates an embedding vector representing the input text.

Example:

(create-embedding {:model "text-embedding-ada-002"
                   :input "The food was delicious and the waiter..."})

For Azure OpenAI pass {:impl :azure} for the options argument

Also see the OpenAI / Azure OpenAI documentation

create-file clj

(create-file params)

(create-file params options)

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.

Example:

(create-file {:purpose "fine-tune"
              :file (clojure.java.io/file "path/to/fine-tune.jsonl")})

Also see the OpenAI documentation

create-fine-tune clj deprecated

(create-fine-tune params)

(create-fine-tune params options)

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

Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

Example:

(create-fine-tune {:training_file "file-xuhfiwuefb"})

Also see the OpenAI documentation

create-fine-tuning-job clj

(create-fine-tuning-job params)

(create-fine-tuning-job params options)

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

Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

Example:

(create-fine-tuning-job {:training_file "file-xuhfiwuefb"
                         :model "gpt-3.5-turbo"})

Also see the OpenAI documentation

create-image clj

(create-image params)

(create-image params options)

Creates an image given a prompt.

Example:

(create-image {:prompt "A cute baby sea otter"
               :n 2
               :size "1024x1024"})

Also see the OpenAI documentation

create-image-edit clj

(create-image-edit params)

(create-image-edit params options)

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

Example:

(create-image-edit {:image (clojure.java.io/file "path/to/otter.png")
                    :mask (clojure.java.io/file "path/to/mask.png")
                    :prompt "A cute baby sea otter wearing a beret"
                    :n 2
                    :size "1024x1024"})

Also see the OpenAI documentation

create-image-variation clj

(create-image-variation params)

(create-image-variation params options)

Creates a variation of a given image.

Example:

(create-image-variation {:image (clojure.java.io/file "path/to/otter.png")
                         :n 2
                         :size "1024x1024"})

Also see the OpenAI documentation

create-message clj

(create-message params)

(create-message params options)

Create a message.

Example:

(create-message {:thread_id "----id----"
                 :role      "user"
                 :content   "How does AI work"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/messages/createMessage

create-moderation clj

(create-moderation params)

(create-moderation params options)

Classifies if text violates OpenAI's Content Policy

Example:

(create-moderation {:input "I want to kill them"})

Also see the OpenAI documentation

create-run clj

(create-run params)

(create-run params options)

Create a run.

Example:

(create-run {:thread_id   "----id----"
             :assistant_id   "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/createRun

create-thread clj

(create-thread)

(create-thread params)

(create-thread params options)

Create a thread.

Example:

(create-thread) or
(create-thread {:messages [{:role    "user"
                            :content "Hello, what is AI?"}
                           {:role    "user"
                            :content "How does AI work? Explain it in simple terms."}]})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/threads/createThread

create-thread-and-run clj

(create-thread-and-run params)

(create-thread-and-run params options)

Create a thread and run it in one request.

Example:

(create-thread-and-run {:assistant_id    "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/createThreadAndRun

create-transcription clj

(create-transcription params)

(create-transcription params options)

Transcribes audio into the input language.

Example:

(create-transcription {:file (clojure.java.io/file "path/to/audio.mp3")
                       :model "whisper-1"})

Also see the OpenAI documentation

create-translation clj

(create-translation params)

(create-translation params options)

Translates audio into English.

Example:

(create-translation {:file (clojure.java.io/file "path/to/file/german.m4a")
                     :model "whisper-1"})

Also see the OpenAI documentation

delete-assistant clj

(delete-assistant params)

(delete-assistant params options)

Delete an assistant.

Example:

(delete-assistant {:assistant_id "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/deleteAssistant

delete-assistant-file clj

(delete-assistant-file params)

(delete-assistant-file params options)

Delete an assistant file.

Example:

(delete-assistant-file {:assistant_id "----id----"
                        :file_id "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile

delete-file clj

(delete-file params)

(delete-file params options)

Delete a file.

Example:

(delete-file {:file-id "file-wefuhweof"})

Also see the OpenAI documentation

delete-model clj

(delete-model params)

(delete-model params options)

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

Example:

(delete-model {:model "fine-tune"})

Also see the OpenAI documentation

delete-thread clj

(delete-thread params)

(delete-thread params options)

Delete a thread.

Example:

(delete-thread {:thread_id "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/threads/deleteThread

download-file clj

(download-file params)

(download-file params options)

Returns the contents of the specified file

Example:

(download-file {:file-id "file-wefuhweof"})

Also see the OpenAI documentation

list-assistant-files clj

(list-assistant-files params)

(list-assistant-files params options)

Returns a list of assistant files.

Example:

(list-assistant-files {:assistant_id "----id----"
                       :limit 5})

:assistant_id param required

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles

list-assistants clj

(list-assistants)

(list-assistants params)

(list-assistants params options)

Returns a list of assistants.

Example:

(list-assistants {:limit 3})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/listAssistants

list-files clj

(list-files)

(list-files options)

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

Example:

(list-files)

Also see the OpenAI documentation

list-fine-tune-events clj deprecated

(list-fine-tune-events params)

(list-fine-tune-events params options)

(Deprecated) Get fine-grained status updates for a fine-tune job.

Example:

(list-fine-tune-events {:fine_tune_id "ft-1wefweub"})

Also see the OpenAI documentation

list-fine-tunes clj deprecated

(list-fine-tunes)

(list-fine-tunes options)

(Deprecated) List your organization's fine-tuning jobs

Example:

(list-fine-tunes)

Also see the OpenAI documentation

list-fine-tuning-events clj

(list-fine-tuning-events params)

(list-fine-tuning-events params options)

Get status updates for a fine-tuning job.

Example:

(list-fine-tuning-events {:fine_tuning_job_id "ft-1wefweub"})

Also see the OpenAI documentation

list-fine-tuning-jobs clj

(list-fine-tuning-jobs)

(list-fine-tuning-jobs options)

List your organization's fine-tuning jobs

Example:

(list-fine-tuning-jobs)

Also see the OpenAI documentation

list-message-files clj

(list-message-files params)

(list-message-files params options)

Returns a list of message files.

Example:

(list-message-files {:thread_id   "----id----"
                     :message_id  "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/messages/listMessageFiles

list-messages clj

(list-messages params)

(list-messages params options)

Returns a list of messages for a given thread.

Example:

(list-messages {:thread_id ",,,"
                :limit      20})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/messages/listMessages

list-models clj

(list-models)

(list-models options)

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

Example:

(list-models)

Also see the OpenAI documentation

list-run-steps clj

(list-run-steps params)

(list-run-steps params options)

Returns a list of run steps belonging to a run.

Example:

(list-run-steps {:thread_id    "----id----"
                 :run_id       "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/listRunSteps

list-runs clj

(list-runs params)

(list-runs params options)

Returns a list of runs belonging to a thread.

Example:

(list-runs {:thread_id   "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/listRuns

modify-assistant clj

(modify-assistant params)

(modify-assistant params options)

Modifies an assistant.

Example:

(modify-assistant {:assistant_id "id"
                   :name "assistant-name"
                   :model "gpt4.. "
                   :description " update the assistant "})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/modifyAssistant

modify-message clj

(modify-message params)

(modify-message params options)

Modify a message.

Example:

(modify-message {:thread_id   "----id----"
                 :message_id  "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/messages/getMessage

modify-run clj

(modify-run params)

(modify-run params options)

Modifies a run.

Example:

(modify-run {:thread_id   "----id----"
             :run_id      "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/modifyRun

modify-thread clj

(modify-thread params)

(modify-thread params options)

Modifies a thread.

Example:

(modify-thread {:thread_id "----id----"
                :metadata {}})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/threads/modifyThread

retrieve-assistant clj

(retrieve-assistant params)

(retrieve-assistant params options)

Retrieves an assistant.

Example:

(retrieve-assistant {:assistant_id "----id----"})

:assistant_id param required :model too (but not in spec)

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/getAssistant

retrieve-assistant-file clj

(retrieve-assistant-file params)

(retrieve-assistant-file params options)

Retrieves an AssistantFile.

Example:

(retrieve-assistant-file {:assistant_id "----id----"
                          :file_id "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/assistants/getAssistantFile

retrieve-file clj

(retrieve-file params)

(retrieve-file params options)

Returns information about a specific file.

Example:

(retrieve-file {:file-id "file-wefuhweof"})

Also see the OpenAI documentation

retrieve-fine-tune clj deprecated

(retrieve-fine-tune params)

(retrieve-fine-tune params options)

(Deprecated) Gets info about the fine-tune job.

Example:

(retrieve-fine-tune {:fine_tune_id "ft-1wefweub"})

Also see the OpenAI documentation

retrieve-fine-tuning-job clj

(retrieve-fine-tuning-job params)

(retrieve-fine-tuning-job params options)

Gets info about a fine-tuning job.

Example:

(retrieve-fine-tuning-job {:fine_tuning_job_id "ft-1wefweub"})

Also see the OpenAI documentation

retrieve-message clj

(retrieve-message params)

(retrieve-message params options)

Retrieve a message.

Example:

(retrieve-message {:thread_id   "----id----"
                   :message_id  "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/messages/getMessage

retrieve-message-file clj

(retrieve-message-file params)

(retrieve-message-file params options)

Retrieves a message file.

Example:

(retrieve-message-file {:thread_id   "----id----"
                        :message_id  "----id----"
                        :file_id  "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/messages/getMessageFile

retrieve-model clj

(retrieve-model params)

(retrieve-model params options)

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

Example:

(retrieve-model {:model "text-davinci-003"})

Also see the OpenAI documentation

retrieve-run clj

(retrieve-run params)

(retrieve-run params options)

Retrieves a run.

Example:

(retrieve-run {:thread_id   "----id----"
               :run_id      "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/getRun

retrieve-run-step clj

(retrieve-run-step params)

(retrieve-run-step params options)

Retrieves a run step.

Example:

(retrieve-run-step {:thread_id    "----id----"
                    :run_id       "----id----"
                    :step_id      "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/getRun

retrieve-thread clj

(retrieve-thread params)

(retrieve-thread params options)

Retrieves a thread.

Example:

(retrieve-thread {:thread_id "----id----"})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/threads/getThread

submit-tool-outputs-to-run clj

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

(submit-tool-outputs-to-run params options)

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. All outputs must be submitted in a single request.

Example:

(submit-tool-outputs-to-run {:thread_id    "----id----"
                             :run_id       "----id----"
                             :tool_outputs  [{:tool_call_id  "call_wwg3TXXXF0SCT7UTTvqxjZc"
                                              :output        "Budapest, Hungary"}]})

Also see the [OpenAI documentation]https://platform.openai.com/docs/api-reference/runs/submitToolOutputs