Version 0.4.0

Author: peterbanda

README.md

@@ -1,5 +1,5 @@
 # OpenAI Scala Client 🤖
-[![version](https://img.shields.io/badge/version-0.3.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/openai-scala-client?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
+[![version](https://img.shields.io/badge/version-0.4.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/openai-scala-client?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
 
 This is a no-nonsense async Scala client for OpenAI API supporting all the available endpoints and params **including streaming**, the newest **ChatGPT completion**, and **voice routines** (as defined [here](https://beta.openai.com/docs/api-reference)), provided in a single, convenient service called [OpenAIService](./openai-core/src/main/scala/io/cequence/openaiscala/service/OpenAIService.scala). The supported calls are: 
 
@@ -30,7 +30,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "openai-scala-client" % "0.3.3"
+"io.cequence" %% "openai-scala-client" % "0.4.0"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -39,11 +39,11 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>openai-scala-client_2.12</artifactId>
-    <version>0.3.3</version>
+    <version>0.4.0</version>
 </dependency>
 ```
 
-If you want a streaming support use `"io.cequence" %% "openai-scala-client-stream" % "0.3.3"` instead.
+If you want a streaming support use `"io.cequence" %% "openai-scala-client-stream" % "0.4.0"` instead.
 
 ## Config ⚙️
 
@@ -224,7 +224,7 @@ For this to work you need to use `OpenAIServiceStreamedFactory` from `openai-sca
   )
 
   // if we want to force the model to use the above function as a response
-  // we can do so by passing: responseFunctionName = Some("set_current_location")`
+  // we can do so by passing: responseFunctionName = Some("get_current_weather")`
   service.createChatFunCompletion(
     messages = messages,
     functions = functions,
@@ -257,7 +257,7 @@ This extension of the standard chat completion is currently supported by the fol
 
   service.listModels.map { models =>
     models.foreach(println)
-    service.close
+    service.close()
   }
 ```
 
@@ -272,7 +272,7 @@ This extension of the standard chat completion is currently supported by the fol
 
   service.listModels.map { models =>
     models.foreach(println)
-    service.close
+    service.close()
   }
 ```
 

build.sbt

@@ -7,7 +7,7 @@ val scala3 = "3.2.2"
 
 ThisBuild / organization := "io.cequence"
 ThisBuild / scalaVersion := scala212
-ThisBuild / version := "0.3.3"
+ThisBuild / version := "0.4.0"
 ThisBuild / isSnapshot := false
 
 lazy val core = (project in file("openai-core"))

openai-client-stream/README.md

@@ -1,4 +1,4 @@
-# OpenAI Scala Client - Stream Support [![version](https://img.shields.io/badge/version-0.3.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
+# OpenAI Scala Client - Stream Support [![version](https://img.shields.io/badge/version-0.4.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
 
 This module provides streaming support for the client. Note that the full project documentation can be found [here](../README.md).
 
@@ -9,7 +9,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "openai-scala-client-stream" % "0.3.3"
+"io.cequence" %% "openai-scala-client-stream" % "0.4.0"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -18,6 +18,6 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>openai-scala-client-stream_2.12</artifactId>
-    <version>0.3.3</version>
+    <version>0.4.0</version>
 </dependency>
 ```

openai-client/README.md

@@ -1,4 +1,4 @@
-# OpenAI Scala Client - Client [![version](https://img.shields.io/badge/version-0.3.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
+# OpenAI Scala Client - Client [![version](https://img.shields.io/badge/version-0.4.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
 
 This module provides the actual meat, i.e. WS client implementation ([OpenAIServiceImpl and OpenAIServiceFactory](./src/main/scala/io/cequence/openaiscala/service/OpenAIServiceImpl.scala)).
 Note that the full project documentation can be found [here](../README.md).
@@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "openai-scala-client" % "0.3.3"
+"io.cequence" %% "openai-scala-client" % "0.4.0"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>openai-scala-client_2.12</artifactId>
-    <version>0.3.3</version>
+    <version>0.4.0</version>
 </dependency>
 ```

openai-core/README.md

@@ -1,4 +1,4 @@
-# OpenAI Scala Client - Core [![version](https://img.shields.io/badge/version-0.3.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
+# OpenAI Scala Client - Core [![version](https://img.shields.io/badge/version-0.4.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
 
 This is the core module, which contains mostly domain classes and the [OpenAIService](./src/main/scala/io/cequence/openaiscala/service/OpenAIService.scala) definition.
 Note that the full project documentation can be found [here](../README.md).
@@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "openai-scala-core" % "0.3.3"
+"io.cequence" %% "openai-scala-core" % "0.4.0"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>openai-scala-core_2.12</artifactId>
-    <version>0.3.3</version>
+    <version>0.4.0</version>
 </dependency>
 ```

openai-guice/README.md

@@ -1,4 +1,4 @@
-# OpenAI Scala Client - Guice [![version](https://img.shields.io/badge/version-0.3.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
+# OpenAI Scala Client - Guice [![version](https://img.shields.io/badge/version-0.4.0-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT)
 
 This module provides dependency injection for the OpenAI Scala client with a help of `Guice` library.
 Note that the full project documentation can be found [here](../README.md).
@@ -10,7 +10,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "openai-scala-guice" % "0.3.3"
+"io.cequence" %% "openai-scala-guice" % "0.4.0"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -19,6 +19,6 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>openai-scala-guice_2.12</artifactId>
-    <version>0.3.3</version>
+    <version>0.4.0</version>
 </dependency>
 ```