add function helper

app/LlmDriver/BaseClient.php

@@ -26,6 +26,42 @@ public function embedData(string $data): EmbeddingsResponseDto
         ]);
     }
 
+    /**
+     * This is to get functions out of the llm
+     * if none are returned your system
+     * can error out or try another way.
+     *
+     * @param  MessageInDto[]  $messages
+     */
+    public function functionPromptChat(array $messages, array $only = []): array
+    {
+        if (! app()->environment('testing')) {
+            sleep(2);
+        }
+
+        Log::info('LlmDriver::MockClient::functionPromptChat', $messages);
+
+        $data = get_fixture('openai_response_with_functions.json');
+
+        $functions = [];
+
+        foreach (data_get($data, 'choices', []) as $choice) {
+            foreach (data_get($choice, 'message.toolCalls', []) as $tool) {
+                if (data_get($tool, 'type') === 'function') {
+                    $name = data_get($tool, 'function.name', null);
+                    if (! in_array($name, $only)) {
+                        $functions[] = [
+                            'name' => $name,
+                            'arguments' => json_decode(data_get($tool, 'function.arguments', []), true),
+                        ];
+                    }
+                }
+            }
+        }
+
+        return $functions;
+    }
+
     /**
      * @param  MessageInDto[]  $messages
      */
@@ -64,8 +100,8 @@ protected function getConfig(string $driver): array
         return config("llmdriver.drivers.$driver");
     }
 
-
-    public function getFunctions() : array {
+    public function getFunctions(): array
+    {
         return [];
     }
 }

app/LlmDriver/Functions/FunctionContract.php

@@ -2,18 +2,16 @@
 
 namespace App\LlmDriver\Functions;
 
+use App\LlmDriver\Functions\PropertyDto;
+
 abstract class FunctionContract
 {
     protected string $name;
 
-    protected string $dscription;
+    protected string $description;
 
     protected string $type = 'object';
 
-    /**
-     * @param  array<string, mixed>  $data
-     * @return array<string, mixed>
-     */
     abstract public function handle(FunctionCallDto $functionCallDto): array;
 
     public function getFunction(): FunctionDto
@@ -35,13 +33,13 @@ protected function getName(): string
         return $this->name;
     }
 
-    /**
-     * @return ParameterDto[]
-     */
-    abstract protected function getProperties(): array;
-
     protected function getDescription(): string
     {
-        return $this->name;
+        return $this->description;
     }
+
+    /**
+     * @return PropertyDto[]
+     */
+    abstract protected function getProperties(): array;
 }

app/LlmDriver/Functions/SearchAndSummarize.php

@@ -6,22 +6,22 @@ class SearchAndSummarize extends FunctionContract
 {
     protected string $name = 'search_and_summarize';
 
-    protected string $dscription = 'Used to embed users prompt, search database and return summarized results.';
+    protected string $description = 'Used to embed users prompt, search database and return summarized results.';
 
     public function handle(FunctionCallDto $functionCallDto): array
     {
         return [];
     }
 
     /**
-     * @return ParameterDto[]
+     * @return PropertyDto[]
      */
     protected function getProperties(): array
     {
         return [
             new PropertyDto(
                 name: 'prompt',
-                description: 'The prompt to search for in the database.',
+                description: 'The prompt the user is using the search for.',
                 type: 'string',
                 required: true,
             ),

app/LlmDriver/LlmDriverClient.php

@@ -49,10 +49,10 @@ protected function getDefaultDriver()
         return 'mock';
     }
 
-    public function getFunctions() : array {
+    public function getFunctions(): array
+    {
         return [
             (new SearchAndSummarize())->getFunction(),
         ];
     }
-
 }

app/LlmDriver/LlmServiceProvider.php

@@ -2,7 +2,6 @@
 
 namespace App\LlmDriver;
 
-use App\LlmDriver\LlmDriverClient;
 use Illuminate\Support\ServiceProvider;
 
 class LlmServiceProvider extends ServiceProvider

app/LlmDriver/OpenAiClient.php

@@ -18,12 +18,13 @@ public function chat(array $messages): CompletionResponse
     {
         $functions = $this->getFunctions();
 
-
         $response = OpenAI::chat()->create([
-            'model' => $this->getConfig('openai')['completion_model'],
+            'model' => $this->getConfig('openai')['chat_model'],
             'messages' => collect($messages)->map(function ($message) {
                 return $message->toArray();
             })->toArray(),
+            'tool_choice' => 'auto',
+            'tools' => $functions,
         ]);
 
         $results = null;
@@ -78,12 +79,43 @@ public function completion(string $prompt, int $temperature = 0): CompletionResp
      * Since this abstraction layer is based on OpenAi
      * Not much needs to happen here
      * but on the others I might need to do XML?
-     * @return array 
      */
-    public function getFunctions() : array {
+    public function getFunctions(): array
+    {
         $functions = LlmDriverFacade::getFunctions();
+
         return collect($functions)->map(function ($function) {
-            return $function->toArray();
+            $function = $function->toArray();
+            $properties = [];
+            $required = [];
+
+            foreach (data_get($function, 'parameters.properties', []) as $property) {
+                $name = data_get($property, 'name');
+
+                if (data_get($property, 'required', false)) {
+                    $required[] = $name;
+                }
+
+                $properties[$name] = [
+                    'description' => data_get($property, 'description', null),
+                    'type' => data_get($property, 'type', 'string'),
+                    'enum' => data_get($property, 'enum', []),
+                    'default' => data_get($property, 'default', null),
+                ];
+            }
+
+            return [
+                'type' => 'function',
+                'function' => [
+                    'name' => data_get($function, 'name'),
+                    'description' => data_get($function, 'description'),
+                    'parameters' => [
+                        'type' => 'object',
+                        'properties' => $properties,
+                    ],
+                    'required' => $required,
+                ],
+            ];
         })->toArray();
     }
 }

tests/Feature/FunctionDtoTest.php

@@ -64,6 +64,4 @@ public function test_dto(): void
         $this->assertEquals('bar', $parameterTwo->default);
         $this->assertTrue($parameterTwo->required);
     }
-
-
 }

tests/Feature/LlmDriverClientTest.php

@@ -26,7 +26,8 @@ public function test_driver_openai(): void
         $this->assertInstanceOf(OpenAiClient::class, $results);
     }
 
-    public function test_get_functions() {
+    public function test_get_functions()
+    {
         $this->assertNotEmpty(LlmDriverFacade::getFunctions());
     }
 }

tests/Feature/MockClientTest.php

@@ -10,9 +10,27 @@
 
 class MockClientTest extends TestCase
 {
-    /**
-     * A basic feature test example.
-     */
+    public function test_tools(): void
+    {
+
+        $client = new MockClient();
+
+        $results = $client->functionPromptChat(['test']);
+
+        $this->assertCount(1, $results);
+
+        $this->assertEquals('search_and_summarize', $results[0]['name']);
+    }
+
+    public function test_tool_with_limit(): void
+    {
+        $client = new MockClient();
+
+        $results = $client->functionPromptChat(['test'], ['search_and_summarize']);
+
+        $this->assertCount(0, $results);
+    }
+
     public function test_embeddings(): void
     {
 

tests/Feature/OpenAiClientTest.php

@@ -12,18 +12,18 @@
 
 class OpenAiClientTest extends TestCase
 {
-
     public function test_get_functions(): void
     {
         $openaiClient = new \App\LlmDriver\OpenAiClient();
         $response = $openaiClient->getFunctions();
         $this->assertNotEmpty($response);
         $this->assertIsArray($response);
         $first = $response[0];
-        $this->assertArrayHasKey('name', $first);
-        $this->assertArrayHasKey('description', $first);
-        $this->assertArrayHasKey('parameters', $first);
+        $this->assertArrayHasKey('type', $first);
+        $this->assertArrayHasKey('function', $first);
+        $expected = get_fixture('openai_client_get_functions.json');
 
+        $this->assertEquals($expected, $response);
 
     }
 

tests/Feature/SearchAndSummarizeTest.php

@@ -2,11 +2,8 @@
 
 namespace Tests\Feature;
 
-use App\LlmDriver\Functions\ParameterDto;
 use App\LlmDriver\Functions\ParametersDto;
 use App\LlmDriver\Functions\PropertyDto;
-use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Foundation\Testing\WithFaker;
 use Tests\TestCase;
 
 class SearchAndSummarizeTest extends TestCase

tests/fixtures/claude_messages_debug.json

@@ -1,26 +1,10 @@
 [
     {
-        "content": "test",
+        "content": "how does the document define 'Generative AI'",
         "role": "user"
     },
     {
-        "content": "test 1",
-        "role": "assistant"
-    },
-    {
-        "role": "user",
-        "content": "Continuation of search results"
-    },
-    {
-        "content": "test 2",
-        "role": "assistant"
-    },
-    {
-        "role": "user",
-        "content": "Continuation of search results"
-    },
-    {
-        "content": "test 3",
+        "content": "The user uploaded documents that the user will ask questions about. Please keep your answers related to the documents.",
         "role": "assistant"
     }
 ]

tests/fixtures/openai_client_get_functions.json

@@ -0,0 +1,23 @@
+[
+    {
+        "type": "function",
+        "function": {
+            "name": "search_and_summarize",
+            "description": "Used to embed users prompt, search database and return summarized results.",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "prompt": {
+                        "description": "The prompt the user is using the search for.",
+                        "type": "string",
+                        "enum": [],
+                        "default": ""
+                    }
+                }
+            },
+            "required": [
+                "prompt"
+            ]
+        }
+    }
+]

tests/fixtures/openai_response_with_functions.json

@@ -0,0 +1,33 @@
+{
+    "id": "chatcmpl-99MsQDhcyADcsehLfCQAwuyhhTxmB",
+    "object": "chat.completion",
+    "created": 1712019918,
+    "model": "gpt-4-0125-preview",
+    "systemFingerprint": "fp_f38f4d6482",
+    "choices": [
+        {
+            "index": 0,
+            "message": {
+                "role": "assistant",
+                "content": null,
+                "toolCalls": [
+                    {
+                        "id": "call_u3GOeiE4LaSJvOqV2uOqeXK2",
+                        "type": "function",
+                        "function": {
+                            "name": "search_and_summarize",
+                            "arguments": "{\"prompt\":\"define 'Generative AI'\"}"
+                        }
+                    }
+                ],
+                "functionCall": null
+            },
+            "finishReason": "tool_calls"
+        }
+    ],
+    "usage": {
+        "promptTokens": 101,
+        "completionTokens": 22,
+        "totalTokens": 123
+    }
+}