Prepare release 0.21.0

Author: wkok

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.21.0 - 2024-09-03
+### Supported API versions
+- OpenAI v2.3.0
+- Azure OpenAI v2024-06-01
+### Changes
+- Added support for a `:stream/close?` parameter to ensure `core.async` channel gets closed. See [this PR](https://github.com/wkok/openai-clojure/pull/63)
+
 ## 0.20.0 - 2024-08-28
 ### Supported API versions
 - OpenAI v2.3.0

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.20.0/api/wkok.openai-clojure.api)
+* [API Reference](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0"}
+net.clojars.wkok/openai-clojure {:mvn/version "0.21.0"}
 ```
 
 ### Leiningen project.clj
 
 ```
-[net.clojars.wkok/openai-clojure "0.20.0"]
+[net.clojars.wkok/openai-clojure "0.21.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.20.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.21.0/api/wkok.openai-clojure.api) for examples of all the supported OpenAI APIs.
 
 Require the `api` namespace
 

build.clj

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

doc/01-usage-openai.md

@@ -9,13 +9,13 @@ Add the `openai-clojure` dependency
 ### deps.edn
 
 ```
-net.clojars.wkok/openai-clojure {:mvn/version "0.20.0"}
+net.clojars.wkok/openai-clojure {:mvn/version "0.21.0"}
 ```
 
 ### Leiningen project.clj
 
 ```
-[net.clojars.wkok/openai-clojure "0.20.0"]
+[net.clojars.wkok/openai-clojure "0.21.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.20.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.21.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.20.0/api/wkok.openai-clojure.api#list-models)
-* [retrieve-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#retrieve-model)
+* [list-models](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#list-models)
+* [retrieve-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-completion)
+* [create-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-chat-completion)
+* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-image)
-* [create-image-edit](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-image-edit)
-* [create-image-variation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-image-variation)
+* [create-image](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-image)
+* [create-image-edit](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-image-edit)
+* [create-image-variation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-embedding)
+* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-transcription)
-* [create-translation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-translation)
+* [create-transcription](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-transcription)
+* [create-translation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-translation)
 
-* [create-speech](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-speech)
+* [create-speech](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#list-files)
-* [create-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-file)
-* [delete-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#delete-file)
-* [retrieve-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#retrieve-file)
-* [download-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#download-file)
+* [list-files](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#list-files)
+* [create-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-file)
+* [delete-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#delete-file)
+* [retrieve-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#retrieve-file)
+* [download-file](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-fine-tuning-job)
-* [list-fine-tuning-jobs](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#list-fine-tuning-jobs)
-* [retrieve-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#retrieve-fine-tuning-job)
-* [cancel-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#cancel-fine-tuning-job)
-* [list-fine-tuning-events](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#list-fine-tuning-events)
-* [delete-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#delete-model)
+* [create-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-fine-tuning-job)
+* [list-fine-tuning-jobs](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#list-fine-tuning-jobs)
+* [retrieve-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#retrieve-fine-tuning-job)
+* [cancel-fine-tuning-job](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#cancel-fine-tuning-job)
+* [list-fine-tuning-events](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#list-fine-tuning-events)
+* [delete-model](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.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.20.0/api/wkok.openai-clojure.api#create-moderation)
+* [create-moderation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-moderation)
 
 ### Assistants
 

doc/02-usage-azure.md

@@ -9,13 +9,13 @@ Add the `openai-clojure` dependency
 ### deps.edn
 
 ```
-net.clojars.wkok/openai-clojure {:mvn/version "0.20.0"}
+net.clojars.wkok/openai-clojure {:mvn/version "0.21.0"}
 ```
 
 ### Leiningen project.clj
 
 ```
-[net.clojars.wkok/openai-clojure "0.20.0"]
+[net.clojars.wkok/openai-clojure "0.21.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.20.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.21.0/api/wkok.openai-clojure.api) api documentation for examples of all the supported OpenAI APIs.
 
 Require the `api` namespace
 
@@ -102,36 +102,36 @@ 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.20.0/api/wkok.openai-clojure.api#create-completion)
+* [create-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-completion)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#completions)
 
 ### Chat
 
-* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-chat-completion)
+* [create-chat-completion](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-chat-completion)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions)
 
 ### Embeddings
 
-* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-embedding)
+* [create-embedding](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-embedding)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#embeddings)
 
 ### Transcriptions
 
-* [create-transcription](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-transcription)
+* [create-transcription](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-transcription)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#transcriptions)
 
 ### Translations
 
-* [create-translation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-translation)
+* [create-translation](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-translation)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#translations)
 
 ### Images
 
-* [create-image](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.20.0/api/wkok.openai-clojure.api#create-image)
+* [create-image](https://cljdoc.org/d/net.clojars.wkok/openai-clojure/0.21.0/api/wkok.openai-clojure.api#create-image)
 
 Also see the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#image-generation)