Bug fixes

cognesy · Jun 22, 2024 · 5c9a058 · 5c9a058
1 parent 47f1cf1
commit 5c9a058
Show file tree

Hide file tree

Showing 59 changed files with 668 additions and 407 deletions.
diff --git a/examples/03_Techniques/ChainOfSummaries/run.php b/examples/03_Techniques/ChainOfSummaries/run.php
@@ -50,11 +50,11 @@
 /** Executive level summary of the project */
 class Summary {
     /** current summary iteration, not bigger than 3 */
-    public int $iteration;
+    public int $iteration = 0;
     /** @var string[] 1-3 facts most relevant from executive perspective and missing from the summary (avoid technical details) */
-    public array $missingFacts;
+    public array $missingFacts = [];
     /** denser summary in 1-3 sentences, which covers every fact from the previous summary plus the missing ones */
-    public string $expandedSummary;
+    public string $expandedSummary = '';
 }
 
 /** Increasingly denser, expanded summaries */
@@ -69,6 +69,9 @@ class ChainOfSummaries {
     ->request(
         messages: $report,
         responseModel: ChainOfSummaries::class,
+        prompt: 'Generate a denser summary based on the provided content.',
+        toolTitle: 'summarizer',
+        toolDescription: 'Generates a summary based on the provided content.',
         options: [
             'max_tokens' => 4096,
         ])

diff --git a/examples/03_Techniques/TranslateUIFields/run.php b/examples/03_Techniques/TranslateUIFields/run.php
@@ -54,7 +54,7 @@ public function validate(object $dataObject): ValidationResult {
 
 $transformedModel = (new Instructor)
     ->wiretap(fn($e)=>$e->print())
-    ->appendValidator($validator)
+    ->addValidator($validator)
     ->respond(
         input: $sourceModel,
         responseModel: get_class($sourceModel),

diff --git a/examples/05_APISupport/LLMSupportOllama/run.php b/examples/05_APISupport/LLMSupportOllama/run.php
@@ -58,14 +58,19 @@ class User {
 $user = $instructor->respond(
     messages: "Jason (@jxnlco) is 25 years old and is the admin of this project. He likes playing football and reading books.",
     responseModel: User::class,
-    model: 'llama2:latest',
+    prompt: 'Parse the user data to JSON, respond using following JSON Schema: <|json_schema|>',
     examples: [[
-        'input' => 'Ive got email Frank - their developer. He asked to come back to him [email protected]. Btw, he plays on drums!',
-        'output' => ['age' => null, 'name' => 'Frank', 'role' => 'developer', 'hobbies' => ['playing drums'],],
+        'input' => 'Ive got email Frank - their developer. Asked to connect via Twitter @frankch. Btw, he plays on drums!',
+        'output' => ['name' => 'Frank', 'role' => 'developer', 'hobbies' => ['playing drums'], 'username' => 'frankch', 'age' => null],
+    ],[
+        'input' => 'We have a meeting with John, our new user. He is 30 years old - check his profile: @jx90.',
+        'output' => ['name' => 'John', 'role' => 'admin', 'hobbies' => [], 'username' => 'jx90', 'age' => 30],
     ]],
+    model: 'qwen2',
     mode: Mode::Json,
 );
 
+
 print("Completed response model:\n\n");
 
 dump($user);

diff --git a/src/ApiClient/Enums/ClientType.php b/src/ApiClient/Enums/ClientType.php
@@ -26,8 +26,6 @@
 use Cognesy\Instructor\Clients\OpenRouter\OpenRouterClient;
 use Cognesy\Instructor\Clients\TogetherAI\TogetherAIClient;
 use Cognesy\Instructor\Clients\TogetherAI\TogetherApiRequest;
-use Exception;
-use Tests\MockLLM;
 
 enum ClientType : string
 {
@@ -63,8 +61,11 @@ public static function fromString(string $type) : self {
         };
     }
 
-    public static function fromRequestClass(string $class)
+    public static function fromRequestClass(string|object $class)
     {
+        if (is_object($class)) {
+            $class = get_class($class);
+        }
         return match($class) {
             AnthropicApiRequest::class => self::Anthropic,
             AnyscaleApiRequest::class => self::Anyscale,

diff --git a/src/ApiClient/Requests/ApiRequest.php b/src/ApiClient/Requests/ApiRequest.php
@@ -94,7 +94,7 @@ protected function defaultBody(): array {
                 $this->requestBody,
                 [
                     'model' => $this->model(),
-                    'messages' => $this->clientType->toNativeMessages($this->withMetaSections()->messages()),
+                    'messages' => $this->messages(),
                     'tools' => $this->tools(),
                     'tool_choice' => $this->getToolChoice(),
                     'response_format' => $this->getResponseFormat(),
@@ -105,41 +105,43 @@ protected function defaultBody(): array {
         return $body;
     }
 
-    protected function withMetaSections() : static {
-        $this->script->section('pre-input')->appendMessageIfEmpty([
+    protected function withMetaSections(Script $script) : Script {
+        $result = Script::fromScript($script);
+
+        $result->section('pre-input')->appendMessageIfEmpty([
             'role' => 'user',
             'content' => "INPUT:",
         ]);
 
-        $this->script->section('pre-prompt')->appendMessageIfEmpty([
+        $result->section('pre-prompt')->appendMessageIfEmpty([
             'role' => 'user',
             'content' => "TASK:",
         ]);
 
-        if ($this->script->section('examples')->notEmpty()) {
-            $this->script->section('pre-examples')->appendMessageIfEmpty([
+        if ($result->section('examples')->notEmpty()) {
+            $result->section('pre-examples')->appendMessageIfEmpty([
                 'role' => 'user',
                 'content' => "EXAMPLES:",
             ]);
         }
 
-        $this->script->section('post-examples')->appendMessageIfEmpty([
+        $result->section('post-examples')->appendMessageIfEmpty([
             'role' => 'user',
             'content' => "RESPONSE:",
         ]);
 
-        if ($this->script->section('retries')->notEmpty()) {
-            $this->script->section('pre-retries')->appendMessageIfEmpty([
+        if ($result->section('retries')->notEmpty()) {
+            $result->section('pre-retries')->appendMessageIfEmpty([
                 'role' => 'user',
                 'content' => "FEEDBACK:",
             ]);
-            $this->script->section('post-retries')->appendMessageIfEmpty([
+            $result->section('post-retries')->appendMessageIfEmpty([
                 'role' => 'user',
                 'content' => "CORRECTED RESPONSE:",
             ]);
         }
 
-        return $this;
+        return $result;
     }
 
     protected function getData(string $name, mixed $defaultValue) : mixed {

diff --git a/src/ApiClient/Requests/Traits/HandlesRequestBody.php b/src/ApiClient/Requests/Traits/HandlesRequestBody.php
@@ -3,6 +3,8 @@
 
 // API REQUEST - DEFAULT IMPLEMENTATION
 
+use Cognesy\Instructor\ApiClient\Enums\ClientType;
+
 trait HandlesRequestBody
 {
     protected function model() : string {
@@ -14,7 +16,8 @@ public function messages(): array {
             return $this->messages;
         }
 
-        return $this->script
+        return $this
+            ->withMetaSections($this->script)
             ->withContext($this->scriptContext)
             ->select([
                 'system',
@@ -23,7 +26,7 @@ public function messages(): array {
                 'pre-examples', 'examples', 'post-examples',
                 'pre-retries', 'retries', 'post-retries'
             ])
-            ->toArray();
+            ->toNativeArray(ClientType::fromRequestClass($this), mergePerRole: true);
     }
 
     public function tools(): array {

diff --git a/src/Clients/Anthropic/AnthropicApiRequest.php b/src/Clients/Anthropic/AnthropicApiRequest.php
@@ -22,7 +22,7 @@ protected function defaultBody(): array {
                 [
                     'model' => $this->model(),
                     'system' => $this->system(),
-                    'messages' => $this->clientType->toNativeMessages(Messages::mergedPerRole($this->withMetaSections()->messages())),
+                    'messages' => $this->messages(),
                     'tools' => $this->tools(),
                     'tool_choice' => $this->getToolChoice(),
                     'max_tokens' => $this->maxTokens,

diff --git a/src/Clients/Anthropic/Traits/HandlesRequestBody.php b/src/Clients/Anthropic/Traits/HandlesRequestBody.php
@@ -1,9 +1,11 @@
 <?php
-
 namespace Cognesy\Instructor\Clients\Anthropic\Traits;
 
+use Cognesy\Instructor\ApiClient\Enums\ClientType;
 use Cognesy\Instructor\Enums\Mode;
 
+// ANTHROPIC API
+
 trait HandlesRequestBody {
     public function messages(): array {
         if ($this->noScript()) {
@@ -14,7 +16,8 @@ public function messages(): array {
             unset($this->scriptContext['json_schema']);
         }
 
-        return $this->script
+        return $this
+            ->withMetaSections($this->script)
             ->withContext($this->scriptContext)
             ->select([
                 'system',
@@ -23,7 +26,7 @@ public function messages(): array {
                 'pre-examples', 'examples', 'post-examples',
                 'pre-retries', 'retries', 'post-retries'
             ])
-            ->toArray();
+            ->toNativeArray(ClientType::fromRequestClass($this), mergePerRole: true);
     }
 
     public function system(): string {

diff --git a/src/Clients/Azure/AzureApiRequest.php b/src/Clients/Azure/AzureApiRequest.php
@@ -4,12 +4,11 @@
 use Cognesy\Instructor\ApiClient\RequestConfig\ApiRequestConfig;
 use Cognesy\Instructor\ApiClient\Requests\ApiRequest;
 use Cognesy\Instructor\ApiClient\Requests\Traits\HandlesResponse;
-use Cognesy\Instructor\ApiClient\Requests\Traits\HandlesRequestBody;
 use Saloon\Enums\Method;
 
 class AzureApiRequest extends ApiRequest
 {
-    use HandlesRequestBody;
+    use Traits\HandlesRequestBody;
     use HandlesResponse;
 
     public function __construct(

diff --git a/src/Clients/Azure/Traits/HandlesRequestBody.php b/src/Clients/Azure/Traits/HandlesRequestBody.php
@@ -0,0 +1,48 @@
+<?php
+namespace Cognesy\Instructor\Clients\Azure\Traits;
+
+use Cognesy\Instructor\Enums\Mode;
+
+trait HandlesRequestBody
+{
+    public function messages(): array {
+        if ($this->noScript()) {
+            return $this->messages;
+        }
+
+        if($this->mode->is(Mode::Tools)) {
+            unset($this->scriptContext['json_schema']);
+        }
+
+        return $this
+            ->withMetaSections($this->script)
+            ->withContext($this->scriptContext)
+            ->select([
+                'system',
+                'pre-input', 'messages', 'input', 'post-input',
+                'pre-prompt', 'prompt', 'post-prompt',
+                'pre-examples', 'examples', 'post-examples',
+                'pre-retries', 'retries', 'post-retries'
+            ])
+            ->toArray();
+    }
+
+    public function tools(): array {
+        return $this->tools;
+    }
+
+    public function getToolChoice(): string|array {
+        if (empty($this->tools)) {
+            return '';
+        }
+        return $this->toolChoice ?: 'auto';
+    }
+
+    protected function getResponseSchema() : array {
+        return $this->responseFormat['schema'] ?? [];
+    }
+
+    protected function getResponseFormat(): array {
+        return $this->responseFormat['format'] ?? [];
+    }
+}
diff --git a/src/Clients/Cohere/CohereApiRequest.php b/src/Clients/Cohere/CohereApiRequest.php
@@ -20,8 +20,8 @@ protected function defaultBody(): array {
                 [
                     'model' => $this->model(),
                     'preamble' => $this->preamble(),
-                    'chat_history' => $this->clientType->toNativeMessages($this->chatHistory()),
-                    'message' => Messages::asString($this->withMetaSections()->messages()),
+                    'chat_history' => $this->chatHistory(),
+                    'message' => Messages::asString($this->messages()),
                     'tools' => $this->tools(),
                 ],
             )

diff --git a/src/Clients/Cohere/Traits/HandlesRequestBody.php b/src/Clients/Cohere/Traits/HandlesRequestBody.php
@@ -1,14 +1,19 @@
 <?php
 namespace Cognesy\Instructor\Clients\Cohere\Traits;
 
+use Cognesy\Instructor\ApiClient\Enums\ClientType;
+
+// COHERE API
+
 trait HandlesRequestBody
 {
     public function messages(): array {
         if ($this->noScript()) {
             return $this->messages;
         }
 
-        return $this->script
+        return $this
+            ->withMetaSections($this->script)
             ->withContext($this->scriptContext)
             ->select([
                 'system',
@@ -17,7 +22,7 @@ public function messages(): array {
                 'pre-examples', 'examples', 'post-examples',
                 'pre-retries', 'retries', 'post-retries'
             ])
-            ->toArray();
+            ->toNativeArray(ClientType::fromRequestClass($this), mergePerRole: true);
     }
 
     public function preamble(): string {
@@ -29,7 +34,7 @@ public function preamble(): string {
     }
 
     public function chatHistory(): array {
-        return [];
+        return $this->clientType->toNativeMessages([]);
 //        return $this->script
 //            ->withContext($this->scriptContext)
 //            ->select(['messages', 'data-ack', 'prompt', 'examples'])

diff --git a/src/Clients/Gemini/GeminiApiRequest.php b/src/Clients/Gemini/GeminiApiRequest.php
@@ -31,7 +31,7 @@ protected function defaultBody(): array {
         $body = array_filter(
             [
                 'systemInstruction' => empty($this->system()) ? [] : ['parts' => ['text' => Messages::asString($this->system())]],
-                'contents' => $this->clientType->toNativeMessages($this->withMetaSections()->messages()),
+                'contents' => $this->messages(),
                 'generationConfig' => $this->options(),
             ],
         );

diff --git a/src/Clients/Gemini/Traits/HandlesRequestBody.php b/src/Clients/Gemini/Traits/HandlesRequestBody.php
@@ -3,6 +3,8 @@
 
 // GEMINI API
 
+use Cognesy\Instructor\ApiClient\Enums\ClientType;
+
 trait HandlesRequestBody
 {
     protected function system() : array {
@@ -21,15 +23,16 @@ public function messages(): array {
             return $this->messages;
         }
 
-        return $this->script
+        return $this
+            ->withMetaSections($this->script)
             ->withContext($this->scriptContext)
             ->select([
                 'pre-input', 'messages', 'input', 'post-input',
                 'pre-prompt', 'prompt', 'post-prompt',
                 'pre-examples', 'examples', 'post-examples',
                 'pre-retries', 'retries', 'post-retries'
             ])
-            ->toArray();
+            ->toNativeArray(ClientType::fromRequestClass($this), mergePerRole: true);
     }
 
     public function tools(): array {

diff --git a/src/Clients/Groq/GroqApiRequest.php b/src/Clients/Groq/GroqApiRequest.php
@@ -2,10 +2,11 @@
 namespace Cognesy\Instructor\Clients\Groq;
 
 use Cognesy\Instructor\ApiClient\Requests\ApiRequest;
+use Cognesy\Instructor\ApiClient\Requests\Traits\HandlesRequestBody;
 use Cognesy\Instructor\ApiClient\Requests\Traits\HandlesResponse;
 
 class GroqApiRequest extends ApiRequest
 {
-    use Traits\HandlesRequestBody;
+    use HandlesRequestBody;
     use HandlesResponse;
 }
diff --git a/src/Clients/Groq/Traits/HandlesRequestBody.php b/src/Clients/Groq/Traits/HandlesRequestBody.php
@@ -16,7 +16,8 @@ public function messages(): array {
             return $this->messages;
         }
 
-        return $this->script
+        return $this
+            ->withMetaSections($this->script)
             ->withContext($this->scriptContext)
             ->select([
                 'system',

diff --git a/src/Clients/Ollama/OllamaApiRequest.php b/src/Clients/Ollama/OllamaApiRequest.php
@@ -17,7 +17,7 @@ protected function defaultBody(): array {
                 $this->requestBody,
                 [
                     'model' => $this->model(),
-                    'messages' => $this->clientType->toNativeMessages($this->withMetaSections()->messages()),
+                    'messages' => $this->messages(),
                     'response_format' => $this->getResponseFormat(),
                     // TODO: Ollama does not support tool calling - add when supported
                     //'tools' => $this->tools(),