ChatFunCompletionResponse used for createChatFunCompletion function where the actual messages are of FunMessageSpec type instead of MessageSpec. To harmonize (redundant) response classes ChatMessage was replaced by identical MessageSpec.

Author: peterbanda

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
  */

openai-client/src/main/scala/io/cequence/openaiscala/JsonFormats.scala

@@ -49,11 +49,13 @@ object JsonFormats {
     Json.format[FunctionSpec]
   }
 
-  implicit val chatMessageFormat: Format[ChatMessage] = Json.format[ChatMessage]
   implicit val chatCompletionChoiceInfoFormat: Format[ChatCompletionChoiceInfo] = Json.format[ChatCompletionChoiceInfo]
   implicit val chatCompletionResponseFormat: Format[ChatCompletionResponse] = Json.format[ChatCompletionResponse]
 
-  implicit val chatChunkMessageFormat: Format[ChatChunkMessage] = Json.format[ChatChunkMessage]
+  implicit val chatFunCompletionChoiceInfoFormat: Format[ChatFunCompletionChoiceInfo] = Json.format[ChatFunCompletionChoiceInfo]
+  implicit val chatFunCompletionResponseFormat: Format[ChatFunCompletionResponse] = Json.format[ChatFunCompletionResponse]
+
+  implicit val chatChunkMessageFormat: Format[ChunkMessageSpec] = Json.format[ChunkMessageSpec]
   implicit val chatCompletionChoiceChunkInfoFormat: Format[ChatCompletionChoiceChunkInfo] = Json.format[ChatCompletionChoiceChunkInfo]
   implicit val chatCompletionChunkResponseFormat: Format[ChatCompletionChunkResponse] = Json.format[ChatCompletionChunkResponse]
 

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

@@ -121,7 +121,7 @@ private class OpenAIServiceImpl(
     functions: Seq[FunctionSpec],
     responseFunctionName: Option[String],
     settings: CreateChatCompletionSettings
-  ): Future[ChatCompletionResponse] = {
+  ): Future[ChatFunCompletionResponse] = {
     val coreParams = createBodyParamsForChatCompletion(messages, settings, stream = false)
 
     val extraParams = jsonBodyParams(
@@ -133,7 +133,7 @@ private class OpenAIServiceImpl(
       EndPoint.chat_completions,
       bodyParams = coreParams ++ extraParams
     ).map(
-      _.asSafe[ChatCompletionResponse]
+      _.asSafe[ChatFunCompletionResponse]
     )
   }
 

openai-core/src/main/scala/io/cequence/openaiscala/domain/response/ChatCompletionResponse.scala

@@ -1,22 +1,50 @@
 package io.cequence.openaiscala.domain.response
 
-import io.cequence.openaiscala.domain.ChatRole
+import io.cequence.openaiscala.domain.{BaseMessageSpec, ChatRole, FunMessageSpec, MessageSpec}
 
 import java.{util => ju}
 
+sealed trait BaseChatCompletionResponse[M <: BaseMessageSpec, C <: BaseChatCompletionChoiceInfo[M]] {
+  val id: String
+  val created: ju.Date
+  val model: String
+  val choices: Seq[C]
+  val usage: Option[UsageInfo]
+}
+
 case class ChatCompletionResponse(
   id: String,
   created: ju.Date,
   model: String,
   choices: Seq[ChatCompletionChoiceInfo],
   usage: Option[UsageInfo]
-)
+) extends BaseChatCompletionResponse[MessageSpec, ChatCompletionChoiceInfo]
+
+case class ChatFunCompletionResponse(
+  id: String,
+  created: ju.Date,
+  model: String,
+  choices: Seq[ChatFunCompletionChoiceInfo],
+  usage: Option[UsageInfo]
+) extends BaseChatCompletionResponse[FunMessageSpec, ChatFunCompletionChoiceInfo]
+
+sealed trait BaseChatCompletionChoiceInfo[M <: BaseMessageSpec] {
+  val message: M
+  val index: Int
+  val finish_reason: Option[String]
+}
 
 case class ChatCompletionChoiceInfo(
-  message: ChatMessage,
+  message: MessageSpec,
   index: Int,
   finish_reason: Option[String]
-)
+) extends BaseChatCompletionChoiceInfo[MessageSpec]
+
+case class ChatFunCompletionChoiceInfo(
+  message: FunMessageSpec,
+  index: Int,
+  finish_reason: Option[String]
+) extends BaseChatCompletionChoiceInfo[FunMessageSpec]
 
 // chunk - streamed
 case class ChatCompletionChunkResponse(
@@ -28,12 +56,13 @@ case class ChatCompletionChunkResponse(
 )
 
 case class ChatCompletionChoiceChunkInfo(
-  delta: ChatChunkMessage,
+  delta: ChunkMessageSpec,
   index: Int,
   finish_reason: Option[String]
 )
 
-case class ChatChunkMessage(
+// we should incorporate this into the MessageSpec hierarchy (but the role is optional)
+case class ChunkMessageSpec(
   role: Option[ChatRole],
   content: Option[String]
 )

openai-core/src/main/scala/io/cequence/openaiscala/domain/response/ChatMessage.scala

@@ -89,7 +89,7 @@ trait OpenAIService extends OpenAIServiceConsts {
     functions: Seq[FunctionSpec],
     responseFunctionName: Option[String] = None,
     settings: CreateChatCompletionSettings = DefaultSettings.CreateChatFunCompletion
-  ): Future[ChatCompletionResponse]
+  ): Future[ChatFunCompletionResponse]
 
   /**
    * Creates a new edit for the provided input, instruction, and parameters.

openai-core/src/main/scala/io/cequence/openaiscala/service/OpenAIService.scala

@@ -16,6 +16,7 @@ trait GuiceContainer {
 
   protected lazy val config = instance[Config]
 
+  // TODO: for Scala3 this function has to be "inlined"
   protected def instance[T: Manifest] = injector.instance[T]
 
   protected def result[T](future: Future[T]) =