Merge pull request #11 from CJCrafter/gson-serialization

Gson serialization

Author: CJCrafter

src/main/kotlin/com/cjcrafter/openai/FinishReason.kt

@@ -1,5 +1,7 @@
 package com.cjcrafter.openai
 
+import com.cjcrafter.openai.gson.FinishReasonAdapter
+
 /**
  * [FinishReason] wraps the possible reasons that a generation model may stop
  * generating tokens. For most **PROPER** use cases (see [best practices](https://platform.openai.com/docs/guides/chat/introduction)),
@@ -27,5 +29,19 @@ enum class FinishReason {
      * This occurrence is rare, and usually only happens when you blatantly
      * misuse/violate OpenAI's terms.
      */
-    CONTENT_FILTER
+    CONTENT_FILTER;
+
+    companion object {
+
+        /**
+         * Returns the google gson adapter for serializing this enum to a json
+         * file. Whe
+         *
+         * @return
+         */
+        @JvmStatic
+        fun adapter() : FinishReasonAdapter {
+            return FinishReasonAdapter()
+        }
+    }
 }

src/main/kotlin/com/cjcrafter/openai/OpenAI.kt

@@ -1,21 +1,19 @@
 package com.cjcrafter.openai
 
-import com.cjcrafter.openai.chat.ChatRequest
-import com.cjcrafter.openai.chat.ChatResponse
-import com.cjcrafter.openai.chat.ChatResponseChunk
-import com.cjcrafter.openai.chat.ChatUser
+import com.cjcrafter.openai.gson.ChatChoiceChunkAdapter
+import com.cjcrafter.openai.chat.*
 import com.cjcrafter.openai.exception.OpenAIError
 import com.cjcrafter.openai.exception.WrappedIOError
+import com.cjcrafter.openai.gson.ChatUserAdapter
+import com.cjcrafter.openai.gson.FinishReasonAdapter
 import com.google.gson.Gson
 import com.google.gson.GsonBuilder
 import com.google.gson.JsonObject
 import com.google.gson.JsonParser
-import com.google.gson.JsonSerializer
 import okhttp3.*
 import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.RequestBody.Companion.toRequestBody
 import java.io.IOException
-import java.lang.IllegalArgumentException
 import java.util.function.Consumer
 
 /**
@@ -39,10 +37,8 @@ class OpenAI @JvmOverloads constructor(
     private val client: OkHttpClient = OkHttpClient()
 ) {
 
-    private val mediaType: MediaType = "application/json; charset=utf-8".toMediaType()
-    private val gson: Gson = GsonBuilder()
-        .registerTypeAdapter(ChatUser::class.java, JsonSerializer<ChatUser> { src, _, context -> context!!.serialize(src!!.name.lowercase())!! })
-        .create()
+    private val mediaType = "application/json; charset=utf-8".toMediaType()
+    private val gson = createGson()
 
     private fun buildRequest(request: Any): Request {
         val json = gson.toJson(request)
@@ -67,6 +63,7 @@ class OpenAI @JvmOverloads constructor(
      */
     @Throws(OpenAIError::class)
     fun createChatCompletion(request: ChatRequest): ChatResponse {
+        @Suppress("DEPRECATION")
         request.stream = false // use streamResponse for stream=true
         val httpRequest = buildRequest(request)
 
@@ -80,7 +77,9 @@ class OpenAI @JvmOverloads constructor(
                 rootObject = JsonParser.parseString(response.body!!.string()).asJsonObject
                 if (rootObject!!.has("error"))
                     throw OpenAIError.fromJson(rootObject!!.get("error").asJsonObject)
-                return ChatResponse(rootObject!!)
+
+                return gson.fromJson(rootObject, ChatResponse::class.java)
+                //return ChatResponse(rootObject!!)
             }
         } catch (ex: IOException) {
             throw WrappedIOError(ex)
@@ -175,7 +174,7 @@ class OpenAI @JvmOverloads constructor(
 
                         val rootObject = JsonParser.parseString(jsonResponse).asJsonObject
                         if (cache == null)
-                            cache = ChatResponseChunk(rootObject)
+                            cache = gson.fromJson(rootObject, ChatResponseChunk::class.java)
                         else
                             cache!!.update(rootObject)
 
@@ -185,4 +184,16 @@ class OpenAI @JvmOverloads constructor(
             }
         })
     }
+
+    companion object {
+
+        @JvmStatic
+        fun createGson(): Gson {
+            return GsonBuilder()
+                .registerTypeAdapter(ChatUser::class.java, ChatUserAdapter())
+                .registerTypeAdapter(FinishReason::class.java, FinishReasonAdapter())
+                .registerTypeAdapter(ChatChoiceChunk::class.java, ChatChoiceChunkAdapter())
+                .create()
+        }
+    }
 }

src/main/kotlin/com/cjcrafter/openai/chat/ChatBot.kt

@@ -79,7 +79,7 @@ class ChatBot @JvmOverloads constructor(
                 if (rootObject!!.has("error"))
                     throw OpenAIError.fromJson(rootObject!!["error"].asJsonObject)
 
-                return ChatResponse(rootObject!!)
+                return gson.fromJson(rootObject, ChatResponse::class.java)
             }
         } catch (ex: Throwable) {
             println(rootObject)
@@ -174,7 +174,7 @@ class ChatBot @JvmOverloads constructor(
 
                         val rootObject = JsonParser.parseString(jsonResponse).asJsonObject
                         if (cache == null)
-                            cache = ChatResponseChunk(rootObject)
+                            cache = gson.fromJson(rootObject, ChatResponseChunk::class.java)
                         else
                             cache!!.update(rootObject)
 

src/main/kotlin/com/cjcrafter/openai/chat/ChatChoice.kt

@@ -2,6 +2,7 @@ package com.cjcrafter.openai.chat
 
 import com.cjcrafter.openai.FinishReason
 import com.google.gson.JsonObject
+import com.google.gson.annotations.SerializedName
 
 /**
  * The OpenAI API returns a list of [ChatChoice]. Each chat choice has a
@@ -20,14 +21,8 @@ import com.google.gson.JsonObject
  * @constructor Create a new chat choice, for internal usage.
  * @see FinishReason
  */
-data class ChatChoice(val index: Int, val message: ChatMessage, val finishReason: FinishReason) {
-
-    /**
-     * JSON constructor for internal usage.
-     */
-    constructor(json: JsonObject) : this(
-        json["index"].asInt,
-        ChatMessage(json["message"].asJsonObject),
-        FinishReason.valueOf(json["finish_reason"].asString.uppercase())
-    )
-}
+data class ChatChoice(
+    val index: Int,
+    val message: ChatMessage,
+    @field:SerializedName("finish_reason") val finishReason: FinishReason
+)

src/main/kotlin/com/cjcrafter/openai/chat/ChatChoiceChunk.kt

@@ -2,6 +2,7 @@ package com.cjcrafter.openai.chat
 
 import com.cjcrafter.openai.FinishReason
 import com.google.gson.JsonObject
+import com.google.gson.annotations.SerializedName
 
 /**
  *
@@ -23,21 +24,12 @@ import com.google.gson.JsonObject
  * @see ChatChoice
  * @since 1.2.0
  */
-data class ChatChoiceChunk(val index: Int, val message: ChatMessage, var delta: String, var finishReason: FinishReason?) {
-
-    /**
-     * JSON constructor for internal usage.
-     */
-    constructor(json: JsonObject) : this(
-
-        // The first message from ChatGPT looks like this:
-        // data: {"id":"chatcmpl-6xUB4Vi8jEG8u4hMBTMeO8KXgA87z","object":"chat.completion.chunk","created":1679635374,"model":"gpt-3.5-turbo-0301","choices":[{"delta":{"role":"assistant"},"index":0,"finish_reason":null}]}
-        // So the only data we have so far is that ChatGPT will be responding.
-        json["index"].asInt,
-        ChatMessage(ChatUser.ASSISTANT, ""),
-        "",
-        null
-    )
+data class ChatChoiceChunk(
+    val index: Int,
+    val message: ChatMessage,
+    var delta: String,
+    @field:SerializedName("finish_reason") var finishReason: FinishReason?
+) {
 
     internal fun update(json: JsonObject)  {
         val deltaJson = json["delta"].asJsonObject

src/main/kotlin/com/cjcrafter/openai/chat/ChatMessage.kt

@@ -1,25 +1,16 @@
 package com.cjcrafter.openai.chat
 
-import com.google.gson.JsonObject
-
 /**
  * ChatGPT's biggest innovation is its conversation memory. To remember the
  * conversation, we need to map each message to who sent it. This data class
  * wraps a message with the user who sent the message.
  *
- * Note that
- *
  * @property role The user who sent this message.
  * @property content The string content of the message.
  * @see ChatUser
  */
 data class ChatMessage(var role: ChatUser, var content: String) {
 
-    /**
-     * JSON constructor for internal usage.
-     */
-    constructor(json: JsonObject) : this(ChatUser.valueOf(json["role"].asString.uppercase()), json["content"].asString)
-
     companion object {
 
         /**
@@ -43,7 +34,7 @@ data class ChatMessage(var role: ChatUser, var content: String) {
          */
         @JvmStatic
         fun String.toAssistantMessage(): ChatMessage {
-            return ChatMessage(ChatUser.SYSTEM, this)
+            return ChatMessage(ChatUser.ASSISTANT, this)
         }
     }
 }

src/main/kotlin/com/cjcrafter/openai/chat/ChatResponse.kt

@@ -24,16 +24,6 @@ data class ChatResponse(
     val usage: ChatUsage
 ) {
 
-    /**
-     * JSON constructor for internal usage.
-     */
-    constructor(json: JsonObject) : this(
-        json["id"].asString,
-        json["created"].asLong,
-        json["choices"].asJsonArray.map { ChatChoice(it.asJsonObject) },
-        ChatUsage(json["usage"].asJsonObject)
-    )
-
     /**
      * Returns the [Instant] time that the OpenAI Chat API sent this response.
      * The time is measured as a unix timestamp (measured in seconds since

src/main/kotlin/com/cjcrafter/openai/chat/ChatResponseChunk.kt

@@ -27,15 +27,6 @@ data class ChatResponseChunk(
     val choices: List<ChatChoiceChunk>,
 ) {
 
-    /**
-     * JSON constructor for internal usage.
-     */
-    constructor(json: JsonObject) : this(
-        json["id"].asString,
-        json["created"].asLong,
-        json["choices"].asJsonArray.map { ChatChoiceChunk(it.asJsonObject) },
-    )
-
     internal fun update(json: JsonObject) {
         json["choices"].asJsonArray.forEachIndexed { index, jsonElement ->
             choices[index].update(jsonElement.asJsonObject)

src/main/kotlin/com/cjcrafter/openai/chat/ChatUsage.kt

@@ -1,6 +1,6 @@
 package com.cjcrafter.openai.chat
 
-import com.google.gson.JsonObject
+import com.google.gson.annotations.SerializedName
 
 /**
  * Holds how many tokens that were used by your API request. Use these
@@ -15,14 +15,8 @@ import com.google.gson.JsonObject
  * @param totalTokens      How many tokens in total.
  * @see <a href="https://platform.openai.com/docs/guides/chat/managing-tokens">Managing Tokens Guide</a>
  */
-data class ChatUsage(val promptTokens: Int, val completionTokens: Int, val totalTokens: Int) {
-
-    /**
-     * JSON constructor for internal usage.
-     */
-    constructor(json: JsonObject) : this(
-        json["prompt_tokens"].asInt,
-        json["completion_tokens"].asInt,
-        json["total_tokens"].asInt
-    )
-}
+data class ChatUsage(
+    @field:SerializedName("prompt_tokens") val promptTokens: Int,
+    @field:SerializedName("completion_tokens") val completionTokens: Int,
+    @field:SerializedName("total_tokens") val totalTokens: Int
+)

src/main/kotlin/com/cjcrafter/openai/chat/ChatUser.kt

@@ -1,5 +1,7 @@
 package com.cjcrafter.openai.chat
 
+import com.cjcrafter.openai.gson.ChatUserAdapter
+
 /**
  * ChatGPT's biggest innovation is its conversational memory. To remember the
  * conversation, we need to map each message to who sent it. This enum stores
@@ -31,5 +33,18 @@ enum class ChatUser {
     /**
      * [ASSISTANT] is the AI that generates responses.
      */
-    ASSISTANT
+    ASSISTANT;
+
+    companion object {
+
+        /**
+         * Adapter
+         *
+         * @return
+         */
+        @JvmStatic
+        fun adapter() : ChatUserAdapter {
+            return ChatUserAdapter()
+        }
+    }
 }