Function spec (name, description, params) and new attributes for Message holder - name and function_call - introduced

Author: peterbanda

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

@@ -0,0 +1,14 @@
+package io.cequence.openaiscala.domain
+
+case class FunctionSpec(
+  // The name of the function to be called.
+  // Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+  name: String,
+
+  // The description of what the function does.
+  description: Option[String] = None,
+
+  // The parameters the functions accepts, described as a JSON Schema object.
+  // See the guide for examples, and the JSON Schema reference for documentation about the format.
+  parameters: Map[String, Any]
+)

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

@@ -1,11 +1,32 @@
 package io.cequence.openaiscala.domain
 
-case class MessageSpec(role: ChatRole, content: String)
+case class MessageSpec(
+  // The role of the messages author. One of system, user, assistant, or function.
+  role: ChatRole,
+
+  // The contents of the message. Content is required for all messages except assistant messages with function calls.
+  content: Option[String],
+
+  // The name of the author of this message. name is required if role is function, and
+  // it should be the name of the function whose response is in the content.
+  // May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.
+  name: Option[String] = None,
+
+  // The name and arguments of a function that should be called, as generated by the model.
+  function_call: Option[FunctionCallSpec] = None
+)
 
 sealed trait ChatRole
 
 object ChatRole {
   case object User extends ChatRole
   case object System extends ChatRole
   case object Assistant extends ChatRole
+
+  case object Function extends ChatRole
 }
+
+case class FunctionCallSpec(
+  name: String,
+  arguments: String
+)

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

@@ -18,11 +18,6 @@ case class ChatCompletionChoiceInfo(
   finish_reason: Option[String]
 )
 
-case class ChatMessage(
-  role: ChatRole,
-  content: String
-)
-
 // chunk - streamed
 case class ChatCompletionChunkResponse(
   id: String,

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

@@ -0,0 +1,11 @@
+package io.cequence.openaiscala.domain.response
+
+import io.cequence.openaiscala.domain.{ChatRole, FunctionCallSpec}
+
+@Deprecated // to be replaced by MessageSpec in the next release
+case class ChatMessage(
+  role: ChatRole,
+  content: Option[String],
+  name: Option[String] = None,
+  function_call: Option[FunctionCallSpec] = None
+)