Prepare v0.18.0

wkok · Jun 10, 2024 · f921f70 · f921f70
1 parent 3ed200c
commit f921f70
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 241 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
 # Change Log
 
+## 0.18.0 - 2024-06-10
+### Supported API versions
+- OpenAI v2.0.0
+- Azure OpenAI v2023-12-01-preview
+### Changes
+- Updated to latest OpenAI spec commit 4e97768 from 2024-06-07
+- Removed deprecated functions
+  - list-assistant-files
+  - create-assistant-file
+  - retrieve-assistant-file
+  - delete-assistant-file
+  - list-message-files
+  - retrieve-message-file
+  - submit-tool-outputs-to-run
+
 ## 0.17.0 - 2024-05-19
 ### Supported API versions
 - OpenAI v2.0.0

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ tools and applications which can work with both variants.
 * [Usage - OpenAI](/doc/01-usage-openai.md)
 * [Usage - Azure OpenAI](/doc/02-usage-azure.md)
 * [Streaming Tokens](/doc/03-streaming.md)
-* [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api)
+* [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api)
 
 ## Supported APIs
 
@@ -46,13 +46,13 @@ Add the `openai-clojure` dependency
 ### deps.edn
 
 ```
-net.clojars.wkok/openai-clojure {:mvn/version "0.17.0"}
+net.clojars.wkok/openai-clojure {:mvn/version "0.18.0"}
 ```
 
 ### Leiningen project.clj
 
 ```
-[net.clojars.wkok/openai-clojure "0.17.0"]
+[net.clojars.wkok/openai-clojure "0.18.0"]
 ```
 
 ## Java
@@ -81,7 +81,7 @@ See: [Authentication - Azure OpenAI](/doc/02-usage-azure.md#authentication)
 
 ## Quickstart
 
-See the full [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api) for examples of all the supported OpenAI APIs.
+See the full [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api) for examples of all the supported OpenAI APIs.
 
 Require the `api` namespace
 

diff --git a/build.clj b/build.clj
@@ -3,7 +3,7 @@
   (:require [org.corfield.build :as bb]))
 
 (def lib 'net.clojars.wkok/openai-clojure)
-(def version "0.17.0")
+(def version "0.18.0")
 
 (defn test "Run the tests." [opts]
   (bb/run-tests opts))

diff --git a/deps.edn b/deps.edn
@@ -11,4 +11,7 @@
          :extra-deps {org.clojure/test.check {:mvn/version "1.1.1"}
                       io.github.cognitect-labs/test-runner
                       {:git/tag "v0.5.0" :git/sha "48c3c67"}}
-         :main-opts ["-e" "(set! *warn-on-reflection* true)"]}}}
+
+         ;; Commented out PR 48 as it causes tests not to run
+         ;; https://github.com/wkok/openai-clojure/pull/48/files
+         #_#_:main-opts ["-e" "(set! *warn-on-reflection* true)"]}}}
diff --git a/doc/01-usage-openai.md b/doc/01-usage-openai.md
@@ -9,13 +9,13 @@ Add the `openai-clojure` dependency
 ### deps.edn
 
 ```
-net.clojars.wkok/openai-clojure {:mvn/version "0.17.0"}
+net.clojars.wkok/openai-clojure {:mvn/version "0.18.0"}
 ```
 
 ### Leiningen project.clj
 
 ```
-[net.clojars.wkok/openai-clojure "0.17.0"]
+[net.clojars.wkok/openai-clojure "0.18.0"]
 ```
 
 ## Authentication
@@ -48,7 +48,7 @@ Alternatively the `api-key` and/or `organization` and/or `api-endpoint` can be p
 
 ## Quickstart
 
-See the full [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api) api documentation for examples of all the supported OpenAI APIs.
+See the full [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api) api documentation for examples of all the supported OpenAI APIs.
 
 Require the `api` namespace
 
@@ -104,70 +104,70 @@ Any of these [supported request options](https://github.com/gnarroway/hato#reque
 
 ### Models
 
-* [list-models](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#list-models)
-* [retrieve-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#retrieve-model)
+* [list-models](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#list-models)
+* [retrieve-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#retrieve-model)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/models)
 
 ### Completions
 
-* [create-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-completion)
+* [create-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-completion)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/completions)
 
 ### Chat
 
-* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-chat-completion)
+* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-chat-completion)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/chat)
 
 ### Images
 
-* [create-image](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-image)
-* [create-image-edit](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-image-edit)
-* [create-image-variation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-image-variation)
+* [create-image](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-image)
+* [create-image-edit](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-image-edit)
+* [create-image-variation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-image-variation)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/images)
 
 ### Embeddings
 
-* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-embedding)
+* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-embedding)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/embeddings)
 
 ### Audio
 
-* [create-transcription](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-transcription)
-* [create-translation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-translation)
+* [create-transcription](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-transcription)
+* [create-translation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-translation)
 
-* [create-speech](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-speech)
+* [create-speech](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-speech)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/audio)
 
 ### Files
 
-* [list-files](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#list-files)
-* [create-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-file)
-* [delete-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#delete-file)
-* [retrieve-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#retrieve-file)
-* [download-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#download-file)
+* [list-files](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#list-files)
+* [create-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-file)
+* [delete-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#delete-file)
+* [retrieve-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#retrieve-file)
+* [download-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#download-file)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/files)
 
 ### Fine-tuning
 
-* [create-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-fine-tuning-job)
-* [list-fine-tuning-jobs](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#list-fine-tuning-jobs)
-* [retrieve-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#retrieve-fine-tuning-job)
-* [cancel-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#cancel-fine-tuning-job)
-* [list-fine-tuning-events](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#list-fine-tuning-events)
-* [delete-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#delete-model)
+* [create-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-fine-tuning-job)
+* [list-fine-tuning-jobs](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#list-fine-tuning-jobs)
+* [retrieve-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#retrieve-fine-tuning-job)
+* [cancel-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#cancel-fine-tuning-job)
+* [list-fine-tuning-events](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#list-fine-tuning-events)
+* [delete-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#delete-model)
 
 Also see the [OpenAI documentation](https://platform.openai.com/docs/api-reference/fine-tuning)
 
 ### Moderations
 
-* [create-moderation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-moderation)
+* [create-moderation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-moderation)
 
 ### Assistants
 
@@ -176,10 +176,6 @@ Also see the [OpenAI documentation](https://platform.openai.com/docs/api-referen
 * [modify-assistant](https://platform.openai.com/docs/api-reference/assistants/modifyAssistant)
 * [delete-assistant](https://platform.openai.com/docs/api-reference/assistants/deleteAssistant)
 * [list-assistants](https://platform.openai.com/docs/api-reference/assistants/listAssistants)
-* [create-assistant-file](https://platform.openai.com/docs/api-reference/assistants/createAssistantFile)
-* [retrieve-assistant-file](https://platform.openai.com/docs/api-reference/assistants/getAssistantFile)
-* [delete-assistant-file](https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile)
-* [list-assistant-files](https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles)
 
 ### Threads
 
@@ -194,8 +190,6 @@ Also see the [OpenAI documentation](https://platform.openai.com/docs/api-referen
 * [retrieve-message](https://platform.openai.com/docs/api-reference/messages/getMessage)
 * [modify-message](https://platform.openai.com/docs/api-reference/messages/modifyMessage)
 * [list-messages](https://platform.openai.com/docs/api-reference/messages/listMessages)
-* [retrieve-message-file](https://platform.openai.com/docs/api-reference/messages/getMessageFile)
-* [list-message-files](https://platform.openai.com/docs/api-reference/messages/listMessageFiles)
 
 ### Runs
 
@@ -204,7 +198,6 @@ Also see the [OpenAI documentation](https://platform.openai.com/docs/api-referen
 * [modify-run](https://platform.openai.com/docs/api-reference/runs/modifyRun)
 * [list-runs](https://platform.openai.com/docs/api-reference/runs/listRuns)
 * [cancel-run](https://platform.openai.com/docs/api-reference/runs/cancelRun)
-* [submit-tool-outputs-to-run](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)
 * [retrieve-run-step](https://platform.openai.com/docs/api-reference/runs/getRunStep)
 * [create-thread-and-run](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)
 * [list-run-steps](https://platform.openai.com/docs/api-reference/runs/listRunSteps)

diff --git a/doc/02-usage-azure.md b/doc/02-usage-azure.md
@@ -9,13 +9,13 @@ Add the `openai-clojure` dependency
 ### deps.edn
 
 ```
-net.clojars.wkok/openai-clojure {:mvn/version "0.17.0"}
+net.clojars.wkok/openai-clojure {:mvn/version "0.18.0"}
 ```
 
 ### Leiningen project.clj
 
 ```
-[net.clojars.wkok/openai-clojure "0.17.0"]
+[net.clojars.wkok/openai-clojure "0.18.0"]
 ```
 
 ## Authentication
@@ -44,7 +44,7 @@ Alternatively the `api-key` and/or `api-endpoint` can be passed in the `options`
 
 ## Quickstart
 
-See the full [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api) api documentation for examples of all the supported OpenAI APIs.
+See the full [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api) api documentation for examples of all the supported OpenAI APIs.
 
 Require the `api` namespace
 
@@ -102,18 +102,18 @@ Any of these [supported request options](https://github.com/gnarroway/hato#reque
 
 ### Completions
 
-* [create-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-completion)
+* [create-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-completion)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference#completions)
 
 ### Chat
 
-* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-chat-completion)
+* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-chat-completion)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference#chat-completions)
 
 ### Embeddings
 
-* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.17.0/api/wkok.openai-clojure.api#create-embedding)
+* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.18.0/api/wkok.openai-clojure.api#create-embedding)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference#embeddings)
diff --git a/resources/openapi-README.md b/resources/openapi-README.md
@@ -2,11 +2,6 @@
 
 Some changes are required in the hosted YAML spec to make it compatible with Martian
 
-## CreateChatCompletionRequest/properties/max_tokens/default
-
-* from: `inf`
-* to: `16384`
-
 ## ChatCompletionFunctions/properties/parameters
 
 later: (#/components/schemas/FunctionParameters)