New OpenAIService function/endpoint - createChatCompletion (impl, settings, response, json formatting)

Author: peterbanda

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

@@ -1,5 +1,8 @@
 package io.cequence.openaiscala
 
+import io.cequence.openaiscala.JsonUtil.JsonOps
+import io.cequence.openaiscala.domain.ChatRole
+
 import java.{util => ju}
 import io.cequence.openaiscala.domain.response._
 import play.api.libs.functional.syntax._
@@ -20,6 +23,29 @@ object JsonFormats {
   implicit val textCompletionChoiceInfoFormat: Format[TextCompletionChoiceInfo] = Json.format[TextCompletionChoiceInfo]
   implicit val textCompletionFormat: Format[TextCompletionResponse] = Json.format[TextCompletionResponse]
 
+  implicit object ChatRoleFormat extends Format[ChatRole] {
+    override def reads(json: JsValue): JsResult[ChatRole] = {
+      json.asSafe[String] match {
+        case "user" => JsSuccess(ChatRole.User)
+        case "assistant" => JsSuccess(ChatRole.Assistant)
+        case "system" => JsSuccess(ChatRole.System)
+        case x => JsError(s"$x is not a valid message role.")
+      }
+    }
+
+    override def writes(o: ChatRole): JsValue = {
+      JsString(o.toString.toLowerCase())
+    }
+  }
+
+  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 chatCompletionChoiceChunkInfoFormat: Format[ChatCompletionChoiceChunkInfo] = Json.format[ChatCompletionChoiceChunkInfo]
+  implicit val chatCompletionChunkResponseFormat: Format[ChatCompletionChunkResponse] = Json.format[ChatCompletionChunkResponse]
+
   implicit val textEditChoiceInfoFormat: Format[TextEditChoiceInfo] = Json.format[TextEditChoiceInfo]
   implicit val textEditFormat: Format[TextEditResponse] = Json.format[TextEditResponse]
 

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

@@ -3,6 +3,7 @@ package io.cequence.openaiscala.service
 object Command extends Enumeration {
   val models = Value
   val completions = Value
+  val chat_completions = Value("chat/completions")
   val edits = Value
   val images_generations = Value("images/generations")
   val images_edits = Value("images/edits")
@@ -18,7 +19,7 @@ object Command extends Enumeration {
 
 object Tag extends Enumeration {
   val model, prompt, suffix, max_tokens, temperature, top_p, n, stream, logprobs, echo, stop,
-  presence_penalty, frequency_penalty, best_of, logit_bias, user,
+  presence_penalty, frequency_penalty, best_of, logit_bias, user, messages,
   input, image, mask, instruction, size, response_format, file, purpose, file_id,
   training_file, validation_file, n_epochs, batch_size, learning_rate_multiplier, prompt_loss_weight,
   compute_classification_metrics, classification_n_classes, classification_positive_class,

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

@@ -9,6 +9,7 @@ import io.cequence.openaiscala.OpenAIScalaClientException
 import io.cequence.openaiscala.domain.settings._
 import io.cequence.openaiscala.domain.response._
 import io.cequence.openaiscala.ConfigImplicits._
+import io.cequence.openaiscala.domain.MessageSpec
 import io.cequence.openaiscala.service.ws.{Timeouts, WSRequestHelper}
 
 import java.io.File
@@ -118,6 +119,52 @@ private class OpenAIServiceImpl(
       Tag.user -> settings.user
     )
 
+  override def createChatCompletion(
+    messages: Seq[MessageSpec],
+    settings: CreateChatCompletionSettings
+  ): Future[ChatCompletionResponse] =
+    execPOST(
+      Command.chat_completions,
+      bodyParams = createBodyParamsForChatCompletion(messages, settings, stream = false)
+    ).map(
+      _.asSafe[ChatCompletionResponse]
+    )
+
+  protected def createBodyParamsForChatCompletion(
+    messages: Seq[MessageSpec],
+    settings: CreateChatCompletionSettings,
+    stream: Boolean
+  ) = {
+    assert(messages.nonEmpty, "At least one message expected.")
+
+    val messageJsons = messages.map { case MessageSpec(role, content) =>
+      Json.obj("role" -> role.toString.toLowerCase, "content" -> content)
+    }
+
+    jsonBodyParams(
+      Tag.messages -> Some(JsArray(messageJsons)),
+      Tag.model -> Some(settings.model),
+      Tag.temperature -> settings.temperature,
+      Tag.top_p -> settings.top_p,
+      Tag.n -> settings.n,
+      Tag.stream -> Some(stream),
+      Tag.stop -> {
+        settings.stop.size match {
+          case 0 => None
+          case 1 => Some(settings.stop.head)
+          case _ => Some(settings.stop)
+        }
+      },
+      Tag.max_tokens -> settings.max_tokens,
+      Tag.presence_penalty -> settings.presence_penalty,
+      Tag.frequency_penalty -> settings.frequency_penalty,
+      Tag.logit_bias -> {
+        if (settings.logit_bias.isEmpty) None else Some(settings.logit_bias)
+      },
+      Tag.user -> settings.user
+    )
+  }
+
   override def createEdit(
     input: String,
     instruction: String,