improve method names to better match official API

Author: CJCrafter

build.gradle.kts

@@ -1,7 +1,7 @@
 import com.github.breadmoirai.githubreleaseplugin.GithubReleaseTask
 
 group = "com.cjcrafter"
-version = "1.2.1"
+version = "1.2.2"
 
 plugins {
     `java-library`

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

@@ -65,12 +65,12 @@ class OpenAI @JvmOverloads constructor(
      * @throws IllegalArgumentException If the input arguments are invalid.
      */
     @Throws(IOException::class)
-    fun generateResponse(request: ChatRequest): ChatResponse {
+    fun createChatCompletion(request: ChatRequest): ChatResponse {
         request.stream = false // use streamResponse for stream=true
         val httpRequest = buildRequest(request)
 
         // Save the JsonObject to check for errors
-        var rootObject: JsonObject? = null
+        var rootObject: JsonObject?
         try {
             client.newCall(httpRequest).execute().use { response ->
 
@@ -86,7 +86,7 @@ class OpenAI @JvmOverloads constructor(
     }
 
     /**
-     * This is a helper method that calls [streamResponse], which lets you use
+     * This is a helper method that calls [streamChatCompletion], which lets you use
      * the generated tokens in real time (As ChatGPT generates them).
      *
      * This method does not block the thread. Method calls to [onResponse] are
@@ -112,8 +112,8 @@ class OpenAI @JvmOverloads constructor(
      * @param onResponse The method to call for each chunk.
      * @since 1.2.0
      */
-    fun streamResponseKotlin(request: ChatRequest, onResponse: ChatResponseChunk.() -> Unit) {
-        streamResponse(request, { it.onResponse() })
+    fun streamChatCompletionKotlin(request: ChatRequest, onResponse: ChatResponseChunk.() -> Unit) {
+        streamChatCompletion(request, { it.onResponse() })
     }
 
     /**
@@ -122,7 +122,7 @@ class OpenAI @JvmOverloads constructor(
      * to update the user without long delays between their input and OpenAI's
      * response.
      *
-     * For *"simpler"* calls, you can use [generateResponse] which will block
+     * For *"simpler"* calls, you can use [createChatCompletion] which will block
      * the thread until the entire response is generated.
      *
      * Instead of using the [ChatResponse], this method uses [ChatResponseChunk].
@@ -137,16 +137,17 @@ class OpenAI @JvmOverloads constructor(
      * @param onResponse The method to call for each chunk.
      * @param onFailure  The method to call if the HTTP fails. This method will
      *                   not be called if OpenAI returns an error.
-     * @see generateResponse
-     * @see streamResponseKotlin
+     * @see createChatCompletion
+     * @see streamChatCompletionKotlin
      * @since 1.2.0
      */
     @JvmOverloads
-    fun streamResponse(
+    fun streamChatCompletion(
         request: ChatRequest,
         onResponse: Consumer<ChatResponseChunk>, // use Consumer instead of Kotlin for better Java syntax
         onFailure: Consumer<IOException> = Consumer { it.printStackTrace() }
     ) {
+        @Suppress("DEPRECATION")
         request.stream = true // use requestResponse for stream=false
         val httpRequest = buildRequest(request)
 

src/test/java/JavaChatStreamTest.java

@@ -1,3 +1,4 @@
+import com.cjcrafter.openai.OpenAI;
 import com.cjcrafter.openai.chat.*;
 import io.github.cdimascio.dotenv.Dotenv;
 
@@ -15,15 +16,15 @@ public static void main(String[] args) {
         String initialPrompt = "You are a customer support chat-bot. Write brief summaries of the user's questions so that agents can easily find the answer in a database.";
         List<ChatMessage> messages = new ArrayList<>(List.of(new ChatMessage(ChatUser.SYSTEM, initialPrompt)));
         ChatRequest request = new ChatRequest("gpt-3.5-turbo", messages);
-        ChatBot bot = new ChatBot(key);
+        OpenAI openai = new OpenAI(key);
 
         while (true) {
             System.out.println("Enter text below:\n\n");
             String input = scan.nextLine();
 
             // Generate a response, and print it to the user.
             messages.add(new ChatMessage(ChatUser.USER, input));
-            bot.streamResponse(request, message -> {
+            openai.streamChatCompletion(request, message -> {
                 System.out.print(message.get(0).getDelta());
 
                 if (message.get(0).getFinishReason() != null) {

src/test/java/JavaChatTest.java

@@ -1,3 +1,4 @@
+import com.cjcrafter.openai.OpenAI;
 import com.cjcrafter.openai.chat.*;
 import io.github.cdimascio.dotenv.Dotenv;
 
@@ -16,15 +17,15 @@ public static void main(String[] args) throws IOException {
         String initialPrompt = "You are a customer support chat-bot. Write brief summaries of the user's questions so that agents can easily find the answer in a database.";
         List<ChatMessage> messages = new ArrayList<>(List.of(new ChatMessage(ChatUser.SYSTEM, initialPrompt)));
         ChatRequest request = new ChatRequest("gpt-3.5-turbo", messages);
-        ChatBot bot = new ChatBot(key);
+        OpenAI openai = new OpenAI(key);
 
         while (true) {
             System.out.println("Enter text below:\n\n");
             String input = scan.nextLine();
 
             // Generate a response, and print it to the user.
             messages.add(new ChatMessage(ChatUser.USER, input));
-            ChatResponse response = bot.generateResponse(request);
+            ChatResponse response = openai.createChatCompletion(request);
             System.out.println("\n" + response.get(0).getMessage().getContent());
 
             // Save the generated message to the bot's conversational memory

src/test/kotlin/KotlinChatStreamTest.kt

@@ -1,4 +1,4 @@
-import com.cjcrafter.openai.chat.ChatBot
+import com.cjcrafter.openai.OpenAI
 import com.cjcrafter.openai.chat.ChatMessage.Companion.toSystemMessage
 import com.cjcrafter.openai.chat.ChatMessage.Companion.toUserMessage
 import com.cjcrafter.openai.chat.ChatRequest
@@ -13,15 +13,15 @@ fun main(args: Array<String>) {
     val initialPrompt = "Follow the users instructions"
     val messages = mutableListOf(initialPrompt.toSystemMessage())
     val request = ChatRequest("gpt-3.5-turbo", messages)
-    val bot = ChatBot(key)
+    val openai = OpenAI(key)
 
     while (true) {
         println("Enter text below:\n")
         val input = scan.nextLine()
 
         // Generate a response, and print it to the user.
         messages.add(input.toUserMessage())
-        bot.streamResponseKotlin(request) {
+        openai.streamChatCompletionKotlin(request) {
             print(choices[0].delta)
 
             if (choices[0].finishReason != null) {

src/test/kotlin/KotlinChatTest.kt

@@ -1,4 +1,4 @@
-import com.cjcrafter.openai.chat.ChatBot
+import com.cjcrafter.openai.OpenAI
 import com.cjcrafter.openai.chat.ChatMessage.Companion.toSystemMessage
 import com.cjcrafter.openai.chat.ChatMessage.Companion.toUserMessage
 import com.cjcrafter.openai.chat.ChatRequest
@@ -13,15 +13,15 @@ fun main(args: Array<String>) {
     val initialPrompt = "You are a customer support chat-bot. Write brief summaries of the user's questions so that agents can easily find the answer in a database."
     val messages = mutableListOf(initialPrompt.toSystemMessage())
     val request = ChatRequest("gpt-3.5-turbo", messages)
-    val bot = ChatBot(key)
+    val openai = OpenAI(key)
 
     while (true) {
         println("Enter text below:\n")
         val input = scan.nextLine()
 
         // Generate a response, and print it to the user.
         messages.add(input.toUserMessage())
-        val response = bot.generateResponse(request)
+        val response = openai.createChatCompletion(request)
         println("\n${response[0].message.content}\n")
 
         // Save the generated message to the bot's conversational memory