Fixes in HTTP middleware

Author: ddebowczyk

.gitattributes

@@ -1,5 +1,6 @@
 # Exclude unnecessary files from Composer and Git exports
 /.cursorignore    export-ignore
+/.cursorprompt     export-ignore
 /.github/         export-ignore
 /.gitignore       export-ignore
 /.gitattributes   export-ignore
@@ -9,21 +10,25 @@
 /mkdocs.yml       export-ignore
 /mkdocs.yml.bak   export-ignore
 /phpunit.xml      export-ignore
+/phpstan.neon     export-ignore
 /phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
 /psalm.xml        export-ignore
-/phpstan.neon     export-ignore
+/pyrightconfig.json export-ignore
+/requirements-doc.txt   export-ignore
 *.md              export-ignore
 *.mdx             export-ignore
 
 # Project specific ignores
 /archived/        export-ignore
 /docs/            export-ignore
 /docs-build/      export-ignore
-#/evals/          export-ignore # include this one with distribution
-#/examples/       export-ignore # include this one with distribution
-/src-auxiliary/    export-ignore
+/evals/           export-ignore
+/examples/        export-ignore
+/src-auxiliary/   export-ignore
 /src-experimental/ export-ignore
+/src-hub/         export-ignore
+/src-tell/        export-ignore
 /notes/           export-ignore
 /scratchpad/      export-ignore
 /tests/           export-ignore

config/debug.php

@@ -1,13 +1,14 @@
-<?php
-return [
-    'http' => [
-        'enabled' => false,
-        'trace' => false,
-        'requestUrl' => true,
-        'requestHeaders' => true,
-        'requestBody' => true,
-        'responseHeaders' => true,
-        'responseBody' => true,
-        'responseStream' => true,
-    ],
-];
+<?php
+return [
+    'http' => [
+        'enabled' => false, // enable/disable debug
+        'trace' => false, // dump HTTP trace information (available for some clients - e.g. Guzzle)
+        'requestUrl' => true, // dump request URL to console
+        'requestHeaders' => true, // dump request headers to console
+        'requestBody' => true, // dump request body to console
+        'responseHeaders' => true, // dump response headers to console
+        'responseBody' => true, // dump response body to console
+        'responseStream' => true, // dump stream data to console
+        'responseStreamByLine' => true, // dump stream data as full lines (true) or as raw received chunks (false)
+    ],
+];

config/http.php

@@ -5,12 +5,6 @@
 return [
     'defaultClient' => 'guzzle',
 
-    'cache' => [
-        'enabled' => false,
-        'expiryInSeconds' => 3600,
-        'path' => '/tmp/instructor/cache',
-    ],
-
     'clients' => [
         'guzzle' => [
             'httpClientType' => HttpClientType::Guzzle->value,
@@ -48,5 +42,5 @@
             'poolTimeout' => 60,
             'failOnError' => true,
         ],
-    ]
+    ],
 ];

docs/release-notes/v0.12.10.md

@@ -0,0 +1 @@
+- Excluded examples, evals and some CLI tools (hub and tell) to minimize distribution size (they are still available in the source code repository)

docs/release-notes/v0.12.9.md

@@ -0,0 +1 @@
+- Fixed composer.json

evals/LLMModes/run.php

@@ -42,7 +42,7 @@
     ),
 );
 
-//Debug::enable();
+//Debug::setEnabled();
 $connections = array_keys(Settings::get('llm', 'connections'));
 $modes = [Mode::Tools, Mode::JsonSchema, Mode::Json, Mode::MdJson, Mode::Text];
 $stream = [true, false];

evals/SimpleExtraction/run.php

@@ -21,7 +21,7 @@
     responseModel: Company::class,
 );
 
-//Debug::enable();
+//Debug::setEnabled();
 
 $experiment = new Experiment(
     cases: InferenceCases::except(

evals/UseExamples/run.php

@@ -21,7 +21,7 @@
     responseModel: Company::class,
 );
 
-//Debug::enable();
+//Debug::setEnabled();
 
 $experiment = new Experiment(
     cases: InferenceCases::except(

examples/A03_Troubleshooting/Debugging/run.php

@@ -28,7 +28,7 @@ class User {
     public string $name;
 }
 
-// CASE 1 - normal flow
+// CASE 1.1 - normal flow, sync request
 
 $instructor = (new Instructor)->withConnection('openai');
 
@@ -42,6 +42,13 @@ class User {
 echo "\nResult:\n";
 dump($user);
 
+assert(isset($user->name));
+assert(isset($user->age));
+assert($user->name === 'Jason');
+assert($user->age === 25);
+
+// CASE 1.2 - normal flow, streaming request
+
 echo "\n### CASE 1.2 - Debugging streaming request\n\n";
 $user2 = $instructor->withDebug()->respond(
     messages: "Anna is 21 years old.",
@@ -52,11 +59,6 @@ class User {
 echo "\nResult:\n";
 dump($user2);
 
-assert(isset($user->name));
-assert(isset($user->age));
-assert($user->name === 'Jason');
-assert($user->age === 25);
-
 assert(isset($user2->name));
 assert(isset($user2->age));
 assert($user2->name === 'Anna');
@@ -65,9 +67,9 @@ class User {
 
 // CASE 2 - forcing API error via empty LLM config
 
-$instructor = (new Instructor)->withLLMConfig(new LLMConfig());
+$instructor = (new Instructor)->withLLMConfig(new LLMConfig(apiUrl: 'https://wrong.com'));
 
-echo "\n### CASE 2 - Debugging exception\n\n";
+echo "\n### CASE 2 - Debugging with HTTP exception\n\n";
 try {
     $user = $instructor->withDebug()->respond(
         messages: "Jason is 25 years old.",

examples/A04_APISupport/Minimaxi/run.php

@@ -41,7 +41,7 @@ class User {
 // Get Instructor with specified LLM client connection
 // See: /config/llm.php to check or change LLM client connection configuration details
 $instructor = (new Instructor)->withConnection('minimaxi');
-Debug::enable();
+Debug::setEnabled();
 $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,