feat: PPT-1085 Add OpenAI Tool Call support (#369)

PlaceOS · Nov 29, 2023 · fe981f2 · fe981f2
1 parent 23d131a
commit fe981f2
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 45 deletions.
diff --git a/shard.lock b/shard.lock
@@ -187,7 +187,7 @@ shards:
 
   openai:
     git: https://github.com/spider-gazelle/crystal-openai.git
-    version: 0.9.0+git.commit.f5d57e6973fa52b494bb084a99253da5dae8dad8
+    version: 0.9.1+git.commit.5ff22991f74b1fa09361728bec3e99c9d9661ab8
 
   openapi-generator:
     git: https://github.com/place-labs/openapi-generator.git
@@ -263,7 +263,7 @@ shards:
 
   placeos-models:
     git: https://github.com/placeos/models.git
-    version: 9.27.0
+    version: 9.28.0
 
   placeos-resource:
     git: https://github.com/place-labs/resource.git

diff --git a/src/constants.cr b/src/constants.cr
@@ -33,7 +33,7 @@ module PlaceOS::Api
   # Open AI
   OPENAI_API_KEY    = ENV["OPENAI_API_KEY"]?
   OPENAI_API_BASE   = ENV["OPENAI_API_BASE"]? # Set this to Azure URL only if Azure OpenAI is used
-  OPENAI_API_MODEL  = ENV["OPENAI_API_MODEL"]? || "gpt-4"
+  OPENAI_API_MODEL  = ENV["OPENAI_API_MODEL"]? || "gpt-4-1106-preview"
   OPENAI_MAX_TOKENS = ENV["OPENAI_MAX_TOKENS"]?.try(&.to_i) || 8192
 
   # CHANGELOG

diff --git a/src/placeos-rest-api/controllers/chat_gpt/chat_manager.cr b/src/placeos-rest-api/controllers/chat_gpt/chat_manager.cr
@@ -79,7 +79,7 @@ module PlaceOS::Api
     private def setup(chat, chat_payload)
       client = build_client
       executor = build_executor(chat)
-      chat_completion = build_completion(build_prompt(chat, chat_payload), executor.functions)
+      chat_completion = build_completion(build_prompt(chat, chat_payload), executor.tools)
 
       {client, executor, chat_completion}
     end
@@ -99,12 +99,12 @@ module PlaceOS::Api
       OpenAI::Client.new(config)
     end
 
-    private def build_completion(messages, functions)
+    private def build_completion(messages, tools)
       OpenAI::ChatCompletionRequest.new(
         model: app.config.api_model,
         messages: messages,
-        functions: functions,
-        function_call: "auto"
+        tools: tools,
+        tool_choice: "auto"
       )
     end
 
@@ -126,7 +126,7 @@ module PlaceOS::Api
       loop do
         count += 1
         if count > 20
-          yield({chat_id: chat_id, message: "sorry, I am unable to complete that task", type: :response})
+          yield({chat_id: chat_id, message: "sorry, I am unable to complete that task.\nTry breaking the request into smaller tasks.", type: :response})
           request.messages.truncate(0..0) # leave only the prompt
           break
         end
@@ -158,45 +158,39 @@ module PlaceOS::Api
         end
         tracking_total = @total_tokens
 
-        # save relevant history
+        # track request history
         msg = resp.choices.first.message
         msg.tokens = resp.usage.completion_tokens
         request.messages << msg
-        save_history(chat_id, msg) unless msg.function_call || (msg.role.function? && msg.name != "task_complete")
 
         # perform function calls until we get a response for the user
-        if func_call = msg.function_call
+        if tool_calls = msg.tool_calls
           discardable_tokens += resp.usage.completion_tokens
-
-          # handle the AI not providing a valid function name, we want it to retry
-          func_res = begin
-            executor.execute(func_call)
-          rescue ex
-            Log.error(exception: ex) { "executing function call" }
-            reply = "Encountered error: #{ex.message}"
-            result = DriverResponse.new(reply).as(JSON::Serializable)
-            request.messages << OpenAI::ChatMessage.new(:function, result.to_pretty_json, func_call.name)
-            next
-          end
+          func_res = executor.execute(tool_calls)
 
           # process the function result
-          case func_res.name
-          when "task_complete"
-            cleanup_messages(request, discardable_tokens)
-            discardable_tokens = 0
-            summary = TaskCompleted.from_json func_call.arguments.as_s
-            yield({chat_id: chat_id, message: "condensing progress: #{summary.details}", type: :progress, function: func_res.name, usage: resp.usage, compressed_usage: @total_tokens})
-          when "list_function_schemas"
-            calculate_discard = true
-            discover = FunctionDiscovery.from_json func_call.arguments.as_s
-            yield({chat_id: chat_id, message: "checking #{discover.id} capabilities", type: :progress, function: func_res.name, usage: resp.usage})
-          when "call_function"
-            calculate_discard = true
-            execute = FunctionExecutor.from_json func_call.arguments.as_s
-            yield({chat_id: chat_id, message: "performing action: #{execute.id}.#{execute.function}(#{execute.parameters})", type: :progress, function: func_res.name, usage: resp.usage})
+          func_res.each_with_index do |res, index|
+            func_call = (tool_calls.find(tool_calls[index]) { |func| func.id == res.tool_call_id }).function
+            case res.name
+            when "task_complete"
+              cleanup_messages(request, discardable_tokens)
+              discardable_tokens = 0
+              summary = TaskCompleted.from_json func_call.arguments.as_s
+              yield({chat_id: chat_id, message: "condensing progress: #{summary.details}", type: :progress, function: func_call.name, usage: resp.usage, compressed_usage: @total_tokens})
+            when "list_function_schemas"
+              calculate_discard = true
+              discover = FunctionDiscovery.from_json func_call.arguments.as_s
+              yield({chat_id: chat_id, message: "checking #{discover.id} capabilities", type: :progress, function: func_call.name, usage: resp.usage})
+            when "call_function"
+              calculate_discard = true
+              execute = FunctionExecutor.from_json func_call.arguments.as_s
+              yield({chat_id: chat_id, message: "performing action: #{execute.id}.#{execute.function}(#{execute.parameters})", type: :progress, function: func_call.name, usage: resp.usage})
+            end
+            request.messages << res
           end
-          request.messages << func_res
           next
+        else
+          save_history(chat_id, msg)
         end
 
         cleanup_messages(request, discardable_tokens)
@@ -259,19 +253,38 @@ module PlaceOS::Api
     end
 
     private def cleanup_messages(request, discardable_tokens)
+      keep = [] of String
+      request.messages.each do |mess|
+        calls = mess.tool_calls
+        next unless calls
+        ids = calls.compact_map do |call|
+          call.id if call.function.name == "task_complete"
+        end
+        keep.concat ids
+      end
+
       # keep task summaries
-      request.messages.reject! { |mess| mess.function_call || (mess.role.function? && mess.name != "task_complete") }
+      request.messages.reject! do |mess|
+        if (tool_calls = mess.tool_calls) && !tool_calls.empty?
+          (tool_calls.map(&.id) & keep).empty?
+        elsif call_id = mess.tool_call_id
+          !keep.includes?(call_id)
+        end
+      end
 
       # a good estimate of the total tokens once the cleanup is complete
       @total_tokens = @total_tokens - discardable_tokens
     end
 
-    private def save_history(chat_id : String, role : PlaceOS::Model::ChatMessage::Role, message : String, tokens : Int32, func_name : String? = nil, func_args : JSON::Any? = nil) : Nil
-      PlaceOS::Model::ChatMessage.create!(role: role, chat_id: chat_id, content: message, tokens: tokens, function_name: func_name, function_args: func_args)
+    private def save_history(chat_id : String, role : PlaceOS::Model::ChatMessage::Role, message : String, tokens : Int32, func_name : String? = nil,
+                             func_args : JSON::Any? = nil, call_id : String? = nil) : Nil
+      PlaceOS::Model::ChatMessage.create!(role: role, chat_id: chat_id, content: message, tokens: tokens, function_name: func_name,
+        function_args: func_args, tool_call_id: call_id)
     end
 
     private def save_history(chat_id : String, msg : OpenAI::ChatMessage)
-      save_history(chat_id, PlaceOS::Model::ChatMessage::Role.parse(msg.role.to_s), msg.content || "", msg.tokens, msg.name, msg.function_call.try &.arguments)
+      save_history(chat_id, PlaceOS::Model::ChatMessage::Role.parse(msg.role.to_s), msg.content || "", msg.tokens, msg.name,
+        msg.tool_calls.try &.first.function.arguments, msg.tool_call_id)
     end
 
     private def build_prompt(chat : PlaceOS::Model::Chat, chat_payload : Payload?)
@@ -294,26 +307,30 @@ module PlaceOS::Api
             str << "my swipe card number is: #{user.card_number}\n" if user.card_number.presence
             str << "my user_id is: #{user.id}\n"
             str << "use these details in function calls as required.\n"
-            str << "perform one task at a time, making as many function calls as required to complete a task. Once a task is complete call the task_complete function with details of the progress you've made.\n"
+            str << "if you encounter an error, check the schema, check the error message and try again. An empty response is not an error, just the absence of something.\n"
+            str << "perform one task at a time, making as many function calls as required to complete a task. Once a task is complete call the task_complete function with details of the progress you've made. Use this summary information to answer the user.\n"
             str << "the chat client prepends the date-time each message was sent at in the following format YYYY-MM-DD HH:mm:ss +ZZ:ZZ:ZZ"
           }
         )
 
         messages.each { |m| save_history(chat.id.as(String), m) }
       else
         chat.messages.each do |hist|
-          func_call = nil
+          tool_calls = nil
           if hist.role.to_s == "function"
             if name = hist.function_name
               args = hist.function_args || JSON::Any.new(nil)
-              func_call = OpenAI::ChatFunctionCall.new(name, args)
+              if call_id = hist.tool_call_id
+                tool_calls = [OpenAI::ChatToolCall.new(call_id, "function", OpenAI::ChatFunctionCall.new(name, args))]
+              end
             end
           end
           messages << OpenAI::ChatMessage.new(
             role: OpenAI::ChatMessageRole.parse(hist.role.to_s),
             content: hist.content,
             name: hist.function_name,
-            function_call: func_call,
+            tool_calls: tool_calls,
+            tool_call_id: hist.tool_call_id,
             tokens: hist.tokens
           )
         end