rename the chat method to create_chat_completion (keep alias method)

Author: leafo

README.md

@@ -52,11 +52,11 @@ Using the Chat Completions API:
 local openai = require("openai")
 local client = openai.new(os.getenv("OPENAI_API_KEY"))
 
-local status, response = client:chat({
+local status, response = client:create_chat_completion({
   {role = "system", content = "You are a Lua programmer"},
   {role = "user", content = "Write a 'Hello world' program in Lua"}
 }, {
-  model = "gpt-3.5-turbo", -- this is the default model
+  model = "gpt-3.5-turbo",
   temperature = 0.5
 })
 
@@ -140,7 +140,7 @@ Using the Chat Completions API:
 local openai = require("openai")
 local client = openai.new(os.getenv("OPENAI_API_KEY"))
 
-client:chat({
+client:create_chat_completion({
   {role = "system", content = "You work for Streak.Club, a website to track daily creative habits"},
   {role = "user", content = "Who do you work for?"}
 }, {
@@ -201,9 +201,9 @@ server-side via `previous_response_id`.
   - `tools`: Array of tool definitions
   - `previous_response_id`: Resume from a previous response
 
-##### `client:chat(messages, opts, chunk_callback)`
+##### `client:create_chat_completion(messages, opts, chunk_callback)`
 
-Sends a request to the `/chat/completions` endpoint.
+Sends a request to the `/chat/completions` endpoint. Also available as `client:chat(...)` for backward compatibility.
 
 - `messages`: An array of message objects.
 - `opts`: Additional options for the chat, passed directly to the API (eg. model, temperature, etc.) https://platform.openai.com/docs/api-reference/chat

openai/chat_completions.lua

@@ -159,7 +159,7 @@ do
       if stream_callback == nil then
         stream_callback = nil
       end
-      local status, response = self.client:chat(self.messages, {
+      local status, response = self.client:create_chat_completion(self.messages, {
         function_call = self.opts.function_call,
         functions = self.functions,
         model = self.opts.model,

openai/chat_completions.moon

@@ -186,7 +186,7 @@ class ChatSession
   -- append_response: should the response be appended to the chat history
   -- stream_callback: provide a function to enable streaming output. function will receive each chunk as it's generated
   generate_response: (append_response=true, stream_callback=nil) =>
-    status, response = @client\chat @messages, {
+    status, response = @client\create_chat_completion @messages, {
       function_call: @opts.function_call -- override the default function call behavior
       functions: @functions
       model: @opts.model

openai/init.lua

@@ -24,7 +24,7 @@ do
       ResponsesChatSession = require("openai.responses").ResponsesChatSession
       return ResponsesChatSession(self, ...)
     end,
-    chat = function(self, messages, opts, chunk_callback)
+    create_chat_completion = function(self, messages, opts, chunk_callback)
       if chunk_callback == nil then
         chunk_callback = nil
       end
@@ -50,6 +50,9 @@ do
       end
       return self:_request("POST", "/chat/completions", payload, nil, stream_filter)
     end,
+    chat = function(self, ...)
+      return self:create_chat_completion(...)
+    end,
     completion = function(self, prompt, opts)
       local payload = {
         model = "text-davinci-003",

openai/init.moon

@@ -37,7 +37,7 @@ class OpenAI
   -- call /chat/completions
   -- opts: additional parameters as described in https://platform.openai.com/docs/api-reference/chat, eg. model, temperature, etc.
   -- completion_callback: function to be called for parsed streaming output when stream = true is passed to opts
-  chat: (messages, opts, chunk_callback=nil) =>
+  create_chat_completion: (messages, opts, chunk_callback=nil) =>
     import test_message, create_chat_stream_filter from require "openai.chat_completions"
 
     test_messages = types.array_of test_message
@@ -57,6 +57,9 @@ class OpenAI
 
     @_request "POST", "/chat/completions", payload, nil, stream_filter
 
+  -- legacy alias for create_chat_completion (for backward compatibility)
+  chat: (...) => @create_chat_completion ...
+
   -- call /completions
   -- opts: additional parameters as described in https://platform.openai.com/docs/api-reference/completions
   completion: (prompt, opts) =>

spec/openai_spec.moon

@@ -69,7 +69,7 @@ describe "OpenAI API Client", ->
 
   it "generates chat response", ->
     client = OpenAI "test-api-key"
-    status, response = assert client\chat {
+    status, response = assert client\create_chat_completion {
       {role: "system", content: "You are an assistant that speaks like Shakespeare."}
       {role: "user", content: "tell me a joke"}
     }
@@ -94,7 +94,7 @@ describe "OpenAI API Client", ->
       client = OpenAI "test-api-key"
       chat = client\new_chat_session { temperature: .75 }
 
-      stub(client, "chat").invokes (c, messages, params) ->
+      stub(client, "create_chat_completion").invokes (c, messages, params) ->
         assert.same {
           {
             role: "user"
@@ -132,7 +132,7 @@ describe "OpenAI API Client", ->
         }
       }, chat.messages
 
-      stub(client, "chat").invokes (c, messages, params) ->
+      stub(client, "create_chat_completion").invokes (c, messages, params) ->
         assert.same {
           {
             role: "user"
@@ -170,13 +170,13 @@ describe "OpenAI API Client", ->
       chat = client\new_chat_session { model: "gpt-4" }
 
       -- bad status
-      stub(client, "chat").invokes (c, messages, params) ->
+      stub(client, "create_chat_completion").invokes (c, messages, params) ->
         400, {}
 
       assert.same {nil, "Bad status: 400", {}}, {chat\send "Hello"}
 
       -- bad status with error
-      stub(client, "chat").invokes (c, messages, params) ->
+      stub(client, "create_chat_completion").invokes (c, messages, params) ->
         400, {
           error: {
             message: "Not valid thing"
@@ -190,7 +190,7 @@ describe "OpenAI API Client", ->
       }}, {chat\send "Hello"}
 
       -- bad status with error message and code
-      stub(client, "chat").invokes (c, messages, params) ->
+      stub(client, "create_chat_completion").invokes (c, messages, params) ->
         400, {
           error: {
             message: "Not valid thing"
@@ -206,7 +206,7 @@ describe "OpenAI API Client", ->
       }}, {chat\send "Hello"}
 
       -- malformed output
-      stub(client, "chat").invokes (c, messages, params) ->
+      stub(client, "create_chat_completion").invokes (c, messages, params) ->
         200, { usage: {} }
 
       assert.same {
@@ -218,7 +218,7 @@ describe "OpenAI API Client", ->
     it "with functions", ->
       client = OpenAI "test-api-key"
 
-      stub(client, "chat").invokes (c, args, params) ->
+      stub(client, "create_chat_completion").invokes (c, args, params) ->
         assert.same {
           {
             role: "system"
@@ -298,7 +298,7 @@ describe "OpenAI API Client", ->
       }, res
 
 
-      stub(client, "chat").invokes (c, args, params) ->
+      stub(client, "create_chat_completion").invokes (c, args, params) ->
         assert.same {
           {
             role: "system"