Release version 0.12.11

Author: ddebowczyk

docs-build/cookbook/instructor/api_support/minimaxi.mdx

@@ -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,

docs-build/cookbook/instructor/api_support/moonshotai.mdx

@@ -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('moonshot-kimi');
-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,

docs-build/cookbook/instructor/api_support/sambanova.mdx

@@ -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('sambanova');
-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,

docs-build/cookbook/instructor/extras/complex_extraction.mdx

@@ -96,7 +96,7 @@ enum StakeholderRole: string {
     case Other = 'other';
 }
 
-Debug::enable();
+Debug::setEnabled();
 
 $instructor = new Instructor;
 

docs-build/cookbook/instructor/extras/complex_extraction_gemini.mdx

@@ -95,7 +95,7 @@ enum StakeholderRole: string {
     case Other = 'other';
 }
 
-//Debug::enable();
+//Debug::setEnabled();
 $instructor = (new Instructor)->withConnection('gemini');
 
 echo "PROJECT EVENTS:\n\n";

docs-build/cookbook/instructor/troubleshooting/debugging.mdx

@@ -22,13 +22,14 @@ require 'examples/boot.php';
 
 use Cognesy\Instructor\Instructor;
 use Cognesy\Polyglot\LLM\Data\LLMConfig;
+use Cognesy\Utils\Str;
 
 class User {
     public int $age;
     public string $name;
 }
 
-// CASE 1 - normal flow
+// CASE 1.1 - normal flow, sync request
 
 $instructor = (new Instructor)->withConnection('openai');
 
@@ -42,8 +43,15 @@ $user = $instructor->withDebug()->respond(
 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(
+$user2 = $instructor->withDebug(true)->respond(
     messages: "Anna is 21 years old.",
     responseModel: User::class,
     options: [ 'stream' => true ]
@@ -52,11 +60,6 @@ $user2 = $instructor->withDebug()->respond(
 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,18 +68,20 @@ assert($user2->age === 21);
 
 // CASE 2 - forcing API error via empty LLM config
 
-$instructor = (new Instructor)->withLLMConfig(new LLMConfig());
+// let's initialize the instructor with an incorrect LLM config
+$instructor = (new Instructor)
+    ->withLLMConfig(new LLMConfig(apiUrl: 'https://example.com'));
 
-echo "\n### CASE 2 - Debugging exception\n\n";
+echo "\n### CASE 2 - Debugging with HTTP exception\n\n";
 try {
-    $user = $instructor->withDebug()->respond(
+    $user = $instructor->withDebug(true)->respond(
         messages: "Jason is 25 years old.",
         responseModel: User::class,
         options: [ 'stream' => true ]
     );
 } catch (Exception $e) {
-    echo "\nCaught it:\n";
-    dump($e);
+    $msg = Str::limit($e->getMessage(), 250);
+    echo "\nCaught exception: " . $msg . "\n";
 }
 ?>
 ```

docs-build/cookbook/polyglot/llm_advanced/reasoning_content.mdx

@@ -19,7 +19,7 @@ use Cognesy\Polyglot\LLM\Inference;
 use Cognesy\Utils\Debug\Debug;
 use Cognesy\Utils\Str;
 
-//Debug::enable();
+//Debug::setEnabled();
 
 // EXAMPLE 1: regular API, allows to customize inference options
 $response = (new Inference)

docs-build/cookbook/polyglot/llm_extras/chat_with_summary.mdx

@@ -56,7 +56,7 @@ $chat = ChatWithSummary::create(
 );
 $chat->script()->section('main')->appendMessage($startMessage);
 
-//Debug::enable();
+//Debug::setEnabled();
 
 for($i = 0; $i < $maxSteps; $i++) {
     $chat->script()

docs-build/cookbook/polyglot/llm_extras/tool_use.mdx

@@ -38,7 +38,7 @@ require 'examples/boot.php';
 use Cognesy\Addons\ToolUse\Tools\FunctionTool;
 use Cognesy\Addons\ToolUse\ToolUse;
 
-//Debug::enable();
+//Debug::setEnabled();
 
 function add_numbers(int $a, int $b) : int {
     return $a + $b;

docs-build/cookbook/polyglot/llm_troubleshooting/http_debug.mdx

@@ -5,10 +5,8 @@ docname: 'http_debug'
 
 ## Overview
 
-Instructor PHP provides a way to debug HTTP calls made to LLM APIs via `Debug::enable()` method.
-`Debug::enable()` works globally, it turns on dumping all HTTP requests and responses to the console.
-
-> NOTE: Currently `Debug::enable()` is only supported by Guzzle HTTP client.
+Instructor PHP provides a way to debug HTTP calls made to LLM APIs via `Debug::setEnabled()` method.
+`Debug::setEnabled()` works globally, it turns on dumping all HTTP requests and responses to the console.
 
 ## Example
 
@@ -19,7 +17,7 @@ require 'examples/boot.php';
 use Cognesy\Polyglot\LLM\Inference;
 use Cognesy\Utils\Debug\Debug;
 
-Debug::enable();
+Debug::setEnabled();
 
 $response = (new Inference)
     ->create(