use data classes

Author: CJCrafter

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

@@ -19,7 +19,7 @@ import com.google.gson.JsonObject
  * @constructor Create a new chat choice, for internal usage.
  * @see FinishReason
  */
-class ChatChoice(val index: Int, val message: ChatMessage, val finishReason: FinishReason?) {
+data class ChatChoice(val index: Int, val message: ChatMessage, val finishReason: FinishReason?) {
 
     /**
      * JSON constructor for internal usage.

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

@@ -36,7 +36,8 @@ import com.google.gson.annotations.SerializedName
  * @property user             Who sent this request (for moderation).
  * @constructor Create a chat request
  * @see ChatBot.generateResponse
- * @see <a href="https://platform.openai.com/docs/api-reference/completions/create">OpenAI Wiki</a>
+ * @see <a href="https://platform.openai.com/docs/api-reference/completions/create">Chat API Reference</a>
+ * @see <a href="https://platform.openai.com/docs/guides/chat">Chat User Reference</a>
  */
 data class ChatRequest @JvmOverloads constructor(
     var model: String,

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

@@ -13,8 +13,9 @@ import com.google.gson.JsonObject
  * @param promptTokens     How many tokens the input used.
  * @param completionTokens How many tokens the output used.
  * @param totalTokens      How many tokens in total.
+ * @see <a href="https://platform.openai.com/docs/guides/chat/managing-tokens">Managing Tokens Guide</a>
  */
-class ChatUsage(val promptTokens: Int, val completionTokens: Int, val totalTokens: Int) {
+data class ChatUsage(val promptTokens: Int, val completionTokens: Int, val totalTokens: Int) {
 
     /**
      * JSON constructor for internal usage.

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

@@ -2,7 +2,7 @@ package com.cjcrafter.openai.chat
 
 /**
  * [FinishReason] wraps the possible reasons that a generation model may stop
- * generating tokens. For most **PROPER** use cases (see [best practices]()),
+ * generating tokens. For most **PROPER** use cases (see [best practices](https://platform.openai.com/docs/guides/chat/introduction)),
  * the finish reason will be [STOP]. When working with streams, finish reason
  * will be `null` since it has not completed the message yet.
  */