merge upstream and resolve conflicts

Author: phelps-sg

.scalafix.conf

@@ -0,0 +1,10 @@
+rules = [
+  DisableSyntax,
+  ExplicitResultTypes,
+  LeakingImplicitClassVal,
+  NoAutoTupling,
+  NoValInForComprehension,
+  ProcedureSyntax,
+  RedundantSyntax,
+  RemoveUnused
+]

.scalafmt.conf

@@ -0,0 +1,2 @@
+version = 3.7.4
+runner.dialect = scala213

README.md

@@ -1,11 +1,11 @@
 # 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: 
 
 * **Models**: [listModels](https://platform.openai.com/docs/api-reference/models/list), and [retrieveModel](https://platform.openai.com/docs/api-reference/models/retrieve)
 * **Completions**: [createCompletion](https://platform.openai.com/docs/api-reference/completions/create)
-* **Chat Completions**: [createChatCompletion](https://platform.openai.com/docs/api-reference/chat/create)
+* **Chat Completions**: [createChatCompletion](https://platform.openai.com/docs/api-reference/chat/create), and [createChatFunCompletion](https://platform.openai.com/docs/api-reference/chat/create) **(🔥 new)**
 * **Edits**: [createEdit](https://platform.openai.com/docs/api-reference/edits/create)
 * **Images**: [createImage](https://platform.openai.com/docs/api-reference/images/create), [createImageEdit](https://platform.openai.com/docs/api-reference/images/create-edit), and [createImageVariation](https://platform.openai.com/docs/api-reference/images/create-variation)
 * **Embeddings**: [createEmbeddings](https://platform.openai.com/docs/api-reference/embeddings/create)
@@ -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 ⚙️
 
@@ -170,7 +170,7 @@ Examples:
     println(completion.choices.head.text)
   ).runWith(Sink.ignore)
 ```
-(For this to work you need to use `OpenAIServiceStreamedFactory` from `openai-scala-client-stream` lib)
+For this to work you need to use `OpenAIServiceStreamedFactory` from `openai-scala-client-stream` lib.
 
 - Create chat completion 
 
@@ -194,23 +194,70 @@ Examples:
   }
 ```
 
+- Create chat completion for functions (🔥 new) 
+
+```scala
+  val messages = Seq(
+    FunMessageSpec(role = ChatRole.User, content = Some("What's the weather like in Boston?")),
+  )
+
+  // as a param type we can use "number", "string", "boolean", "object", "array", and "null"
+  val functions = Seq(
+    FunctionSpec(
+      name = "get_current_weather",
+      description = Some("Get the current weather in a given location"),
+      parameters = Map(
+        "type" -> "object",
+        "properties" -> Map(
+          "location" -> Map(
+            "type" -> "string",
+            "description" -> "The city and state, e.g. San Francisco, CA",
+          ),
+          "unit" -> Map(
+            "type" -> "string",
+            "enum" -> Seq("celsius", "fahrenheit")
+          )
+        ),
+        "required" -> Seq("location"),
+      )
+    )
+  )
+
+  // if we want to force the model to use the above function as a response
+  // we can do so by passing: responseFunctionName = Some("get_current_weather")`
+  service.createChatFunCompletion(
+    messages = messages,
+    functions = functions,
+    responseFunctionName = None
+  ).map { response =>
+    val chatFunCompletionMessage = response.choices.head.message
+    val functionCall = chatFunCompletionMessage.function_call
+
+    println("function call name      : " + functionCall.map(_.name).getOrElse("N/A"))
+    println("function call arguments : " + functionCall.map(_.arguments).getOrElse("N/A"))
+  }
+```
+Note that instead of `MessageSpec`, the `function_call` version of the chat completion uses the `FunMessageSpec` class to define messages - both as part of the request and the response.
+This extension of the standard chat completion is currently supported by the following `0613` models, all conveniently available in `ModelId` object:
+- `gpt-3.5-turbo-0613` (default), `gpt-3.5-turbo-16k-0613`, `gpt-4-0613`, and `gpt-4-32k-0613`.
+
 
 **✔️ Important Note**: After you are done using the service, you should close it by calling (🔥 new) `service.close`. Otherwise, the underlying resources/threads won't be released.
 
 **III. Using multiple services (🔥 new)**
 
-- Load distribution with `OpenAIMultiServiceAdapter` - _rotation type_ aka "round robin"
+- Load distribution with `OpenAIMultiServiceAdapter` - _round robin_ (_rotation_) type
 
 ```scala
   val service1 = OpenAIServiceFactory("your-api-key1")
   val service2 = OpenAIServiceFactory("your-api-key2")
   val service3 = OpenAIServiceFactory("your-api-key3")
 
-  val service = OpenAIMultiServiceAdapter.ofRotationType(service1, service2, service3)
+  val service = OpenAIMultiServiceAdapter.ofRoundRobinType(service1, service2, service3)
 
   service.listModels.map { models =>
     models.foreach(println)
-    service.close
+    service.close()
   }
 ```
 
@@ -221,11 +268,11 @@ Examples:
   val service2 = OpenAIServiceFactory("your-api-key2")
   val service3 = OpenAIServiceFactory("your-api-key3")
 
-  val service = OpenAIMultiServiceAdapter.ofRandomAccessType(service1, service2, service3)
+  val service = OpenAIMultiServiceAdapter.ofRandomOrderType(service1, service2, service3)
 
   service.listModels.map { models =>
     models.foreach(println)
-    service.close
+    service.close()
   }
 ```
 

build.sbt

@@ -1,14 +1,14 @@
 import sbt.Keys.test
 
 // Supported versions
-val scala212 = "2.12.15"
-val scala213 = "2.13.10"
+val scala212 = "2.12.18"
+val scala213 = "2.13.11"
 val scala3 = "3.2.2"
 val AkkaVersion = "2.6.1"
 
 ThisBuild / organization := "io.cequence"
 ThisBuild / scalaVersion := scala212
-ThisBuild / version := "0.3.3"
+ThisBuild / version := "0.4.0"
 ThisBuild / isSnapshot := false
 
 lazy val commonSettings = Seq(
@@ -36,16 +36,27 @@ lazy val guice = (project in file("openai-guice"))
   .dependsOn(client)
   .aggregate(client_stream)
 
-
 // POM settings for Sonatype
-ThisBuild / homepage := Some(url("https://github.com/cequence-io/openai-scala-client"))
+ThisBuild / homepage := Some(
+  url("https://github.com/cequence-io/openai-scala-client")
+)
 
 ThisBuild / sonatypeProfileName := "io.cequence"
 
-ThisBuild / scmInfo := Some(ScmInfo(url("https://github.com/cequence-io/openai-scala-client"), "scm:[email protected]:cequence-io/openai-scala-client.git"))
+ThisBuild / scmInfo := Some(
+  ScmInfo(
+    url("https://github.com/cequence-io/openai-scala-client"),
+    "scm:[email protected]:cequence-io/openai-scala-client.git"
+  )
+)
 
 ThisBuild / developers := List(
-  Developer("bnd", "Peter Banda", "[email protected]", url("https://peterbanda.net"))
+  Developer(
+    "bnd",
+    "Peter Banda",
+    "[email protected]",
+    url("https://peterbanda.net")
+  )
 )
 
 ThisBuild / licenses += "MIT" -> url("https://opensource.org/licenses/MIT")
@@ -57,3 +68,42 @@ ThisBuild / sonatypeCredentialHost := "s01.oss.sonatype.org"
 ThisBuild / sonatypeRepository := "https://s01.oss.sonatype.org/service/local"
 
 ThisBuild / publishTo := sonatypePublishToBundle.value
+
+addCommandAlias(
+  "validateCode",
+  List(
+    "scalafix",
+    "scalafmtSbtCheck",
+    "scalafmtCheckAll",
+    "test:scalafix",
+    "test:scalafmtCheckAll"
+  ).mkString(";")
+)
+
+addCommandAlias(
+  "formatCode",
+  List(
+    "scalafmt",
+    "scalafmtSbt",
+    "Test/scalafmt"
+  ).mkString(";")
+)
+
+addCommandAlias(
+  "testWithCoverage",
+  List(
+    "coverage",
+    "test",
+    "coverageReport"
+  ).mkString(";")
+)
+
+
+inThisBuild(
+  List(
+    scalacOptions += "-Ywarn-unused",
+    scalaVersion := "2.12.15",
+    semanticdbEnabled := true,
+    semanticdbVersion := scalafixSemanticdb.revision
+  )
+)

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-stream/src/main/scala/io/cequence/openaiscala/service/OpenAIServiceStreamedExtra.scala

@@ -2,7 +2,7 @@ package io.cequence.openaiscala.service
 
 import akka.NotUsed
 import akka.stream.scaladsl.Source
-import io.cequence.openaiscala.domain.MessageSpec
+import io.cequence.openaiscala.domain.{FunctionSpec, MessageSpec}
 import io.cequence.openaiscala.domain.response.{ChatCompletionChunkResponse, ChatCompletionResponse, FineTuneEvent, TextCompletionResponse}
 import io.cequence.openaiscala.domain.settings.{CreateChatCompletionSettings, CreateCompletionSettings}
 
@@ -29,7 +29,7 @@ trait OpenAIServiceStreamedExtra extends OpenAIServiceConsts {
   /**
    * Creates a completion for the chat message(s) with streamed results.
    *
-   * @param messages The messages to generate chat completions.
+   * @param messages A list of messages comprising the conversation so far.
    * @param settings
    * @return chat completion response
    *

openai-client-stream/src/main/scala/io/cequence/openaiscala/service/OpenAIServiceStreamedImpl.scala

@@ -15,12 +15,7 @@ import play.api.libs.json.{JsValue, Json}
 import scala.concurrent.ExecutionContext
 
 /**
- * Private impl. class of [[OpenAIService]].
- *
- * @param apiKey
- * @param orgId
- * @param ec
- * @param materializer
+ * Private impl. class of [[OpenAIServiceStreamedExtra]] which offers extra functions with streaming support.
  *
  * @since Jan 2023
  */
@@ -32,7 +27,7 @@ private trait OpenAIServiceStreamedExtraImpl extends OpenAIServiceStreamedExtra
     settings: CreateCompletionSettings
   ): Source[TextCompletionResponse, NotUsed] =
     execJsonStreamAux(
-      Command.completions,
+      EndPoint.completions,
       "POST",
       bodyParams = createBodyParamsForCompletion(prompt, settings, stream = true)
     ).map { (json: JsValue) =>
@@ -48,7 +43,7 @@ private trait OpenAIServiceStreamedExtraImpl extends OpenAIServiceStreamedExtra
     settings: CreateChatCompletionSettings = DefaultSettings.CreateChatCompletion
   ): Source[ChatCompletionChunkResponse, NotUsed] =
     execJsonStreamAux(
-      Command.chat_completions,
+      EndPoint.chat_completions,
       "POST",
       bodyParams = createBodyParamsForChatCompletion(messages, settings, stream = true)
     ).map { (json: JsValue) =>
@@ -63,11 +58,11 @@ private trait OpenAIServiceStreamedExtraImpl extends OpenAIServiceStreamedExtra
     fineTuneId: String
   ): Source[FineTuneEvent, NotUsed] =
     execJsonStreamAux(
-      Command.fine_tunes,
+      EndPoint.fine_tunes,
       "GET",
       endPointParam = Some(s"$fineTuneId/events"),
       params = Seq(
-        Tag.stream -> Some(true)
+        Param.stream -> Some(true)
       )
     ).map { json =>
       (json \ "error").toOption.map { error =>

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-client/build.sbt

@@ -6,8 +6,8 @@ lazy val playWsVersion = settingKey[String]("Play WS version to use")
 
 playWsVersion := {
   scalaVersion.value match {
-    case "2.12.15" => "2.1.10"
-    case "2.13.10" => "2.2.0-M3"
+    case "2.12.18" => "2.1.10"
+    case "2.13.11" => "2.2.0-M3"
     case "3.2.2" => "2.2.0-M2" // Version "2.2.0-M3" was produced by an unstable release: Scala 3.3.0-RC3
     case _ => "2.1.10"
   }