Provider meta on tools & OpenAI Strict Tool Schema (#51)

Author: sixlive

Diff for: src/Concerns/BuildsTextRequests.php

@@ -5,6 +5,7 @@
 namespace EchoLabs\Prism\Concerns;
 
 use EchoLabs\Prism\Contracts\Message;
+use EchoLabs\Prism\Enums\Provider;
 use EchoLabs\Prism\Enums\ToolChoice;
 use EchoLabs\Prism\Exceptions\PrismException;
 use EchoLabs\Prism\Requests\TextRequest;
@@ -37,6 +38,23 @@ trait BuildsTextRequests
 
     protected string|ToolChoice|null $toolChoice = null;
 
+    protected string $provider;
+
+    protected string $model;
+
+    public function using(string|Provider $provider, string $model): self
+    {
+        $this->provider = is_string($provider) ? $provider : $provider->value;
+        $this->model = $model;
+
+        return $this;
+    }
+
+    public function provider(): string
+    {
+        return $this->provider;
+    }
+
     public function withPrompt(string|View $prompt): self
     {
         if ($this->messages) {

Diff for: src/Concerns/HasProvider.php

@@ -6,7 +6,6 @@
 
 use EchoLabs\Prism\Concerns\BuildsTextRequests;
 use EchoLabs\Prism\Concerns\HandlesToolCalls;
-use EchoLabs\Prism\Concerns\HasProvider;
 use EchoLabs\Prism\Enums\FinishReason;
 use EchoLabs\Prism\PrismManager;
 use EchoLabs\Prism\Providers\ProviderResponse;
@@ -20,7 +19,7 @@
 
 class TextGenerator
 {
-    use BuildsTextRequests, HandlesToolCalls, HasProvider;
+    use BuildsTextRequests, HandlesToolCalls;
 
     protected TextState $state;
 

Diff for: src/Generators/TextGenerator.php

@@ -4,6 +4,7 @@
 
 namespace EchoLabs\Prism\Providers\OpenAI;
 
+use EchoLabs\Prism\Enums\Provider;
 use EchoLabs\Prism\Providers\ProviderTool;
 use EchoLabs\Prism\Tool as PrismTool;
 
@@ -12,7 +13,7 @@ class Tool extends ProviderTool
     #[\Override]
     public static function toArray(PrismTool $tool): array
     {
-        return [
+        return array_filter([
             'type' => 'function',
             'function' => [
                 'name' => $tool->name(),
@@ -23,6 +24,7 @@ public static function toArray(PrismTool $tool): array
                     'required' => $tool->requiredParameters(),
                 ],
             ],
-        ];
+            'strict' => data_get($tool->providerMeta(Provider::OpenAI), 'strict', null),
+        ]);
     }
 }

Diff for: src/Providers/OpenAI/Tool.php

@@ -7,6 +7,7 @@
 use ArgumentCountError;
 use Closure;
 use EchoLabs\Prism\Contracts\Schema;
+use EchoLabs\Prism\Enums\Provider;
 use EchoLabs\Prism\Exceptions\PrismException;
 use EchoLabs\Prism\Schema\ArraySchema;
 use EchoLabs\Prism\Schema\BooleanSchema;
@@ -33,6 +34,9 @@ class Tool
     /** @var Closure():string|callable():string */
     protected $fn;
 
+    /** @var array<string, array<string, mixed>> */
+    protected $providerMeta = [];
+
     public function as(string $name): self
     {
         $this->name = $name;
@@ -47,7 +51,6 @@ public function for(string $description): self
         return $this;
     }
 
-    /** @param Closure():string|callable():string $fn */
     public function using(Closure|callable $fn): self
     {
         $this->fn = $fn;
@@ -136,6 +139,24 @@ public function withEnumParameter(
         return $this;
     }
 
+    /**
+     * @param  array<string, mixed>  $meta
+     */
+    public function withProviderMeta(Provider $provider, array $meta): self
+    {
+        $this->providerMeta[$provider->value] = $meta;
+
+        return $this;
+    }
+
+    /**
+     * @return array<string, mixed>> $meta
+     */
+    public function providerMeta(Provider $provider): array
+    {
+        return data_get($this->providerMeta, $provider->value, []);
+    }
+
     /** @return array<int, string> */
     public function requiredParameters(): array
     {

Diff for: src/Tool.php

@@ -4,6 +4,7 @@
 
 namespace Tests\Providers\OpenAI;
 
+use EchoLabs\Prism\Enums\Provider;
 use EchoLabs\Prism\Providers\OpenAI\Tool as OpenAITool;
 use EchoLabs\Prism\Tool;
 
@@ -27,3 +28,28 @@
         ],
     ]);
 });
+
+it('maps tools with strict mode', function (): void {
+    $tool = (new Tool)
+        ->as('search')
+        ->for('Searching the web')
+        ->withStringParameter('query', 'the detailed search query')
+        ->using(fn (): string => '[Search results]')
+        ->withProviderMeta(Provider::OpenAI, [
+            'strict' => true,
+        ]);
+
+    expect(OpenAITool::toArray($tool))->toBe([
+        'type' => 'function',
+        'function' => [
+            'name' => $tool->name(),
+            'description' => $tool->description(),
+            'parameters' => [
+                'type' => 'object',
+                'properties' => $tool->parameters(),
+                'required' => $tool->requiredParameters(),
+            ],
+        ],
+        'strict' => true,
+    ]);
+});