Release version 0.17.0

Author: ddebowczyk

.github/workflows/split.yml

@@ -16,39 +16,39 @@ jobs:
       fail-fast: false
       matrix:
         package:
-          - local: 'packages/addons'
-            repo:  'cognesy/instructor-addons'
-            name:  'instructor-addons'
+          - local: 'packages/utils'
+            repo:  'cognesy/instructor-utils'
+            name:  'instructor-utils'
+          - local: 'packages/setup'
+            repo:  'cognesy/instructor-setup'
+            name:  'instructor-setup'
           - local: 'packages/auxiliary'
             repo:  'cognesy/instructor-aux'
             name:  'instructor-aux'
-          - local: 'packages/evals'
-            repo:  'cognesy/instructor-evals'
-            name:  'instructor-evals'
+          - local: 'packages/templates'
+            repo:  'cognesy/instructor-templates'
+            name:  'instructor-templates'
           - local: 'packages/http-client'
             repo:  'cognesy/instructor-http-client'
             name:  'instructor-http-client'
-          - local: 'packages/hub'
-            repo:  'cognesy/instructor-hub'
-            name:  'instructor-hub'
-          - local: 'packages/instructor'
-            repo:  'cognesy/instructor-struct'
-            name:  'instructor-struct'
           - local: 'packages/polyglot'
             repo:  'cognesy/instructor-polyglot'
             name:  'instructor-polyglot'
-          - local: 'packages/setup'
-            repo:  'cognesy/instructor-setup'
-            name:  'instructor-setup'
           - local: 'packages/tell'
             repo:  'cognesy/instructor-tell'
             name:  'instructor-tell'
-          - local: 'packages/templates'
-            repo:  'cognesy/instructor-templates'
-            name:  'instructor-templates'
-          - local: 'packages/utils'
-            repo:  'cognesy/instructor-utils'
-            name:  'instructor-utils'
+          - local: 'packages/instructor'
+            repo:  'cognesy/instructor-struct'
+            name:  'instructor-struct'
+          - local: 'packages/evals'
+            repo:  'cognesy/instructor-evals'
+            name:  'instructor-evals'
+          - local: 'packages/hub'
+            repo:  'cognesy/instructor-hub'
+            name:  'instructor-hub'
+          - local: 'packages/addons'
+            repo:  'cognesy/instructor-addons'
+            name:  'instructor-addons'
 
     steps:
       - uses: actions/checkout@v4

bin/sync-ver.sh

@@ -20,18 +20,18 @@ echo "Updating to version $VERSION (dependency constraint ^$MAJOR_MINOR)"
 
 # Define packages and their sections based on composer.json
 declare -A PACKAGES
-PACKAGES["packages/addons"]="cognesy/instructor-addons"
-PACKAGES["packages/auxiliary"]="cognesy/instructor-auxiliary"
-PACKAGES["packages/evals"]="cognesy/instructor-evals"
+PACKAGES["packages/utils"]="cognesy/instructor-utils"
+PACKAGES["packages/templates"]="cognesy/instructor-templates"
 #PACKAGES["packages/experimental"]="cognesy/instructor-experimental"
 PACKAGES["packages/http-client"]="cognesy/instructor-http-client"
-PACKAGES["packages/hub"]="cognesy/instructor-hub"
-PACKAGES["packages/instructor"]="cognesy/instructor-struct"
 PACKAGES["packages/polyglot"]="cognesy/instructor-polyglot"
 PACKAGES["packages/setup"]="cognesy/instructor-setup"
+PACKAGES["packages/instructor"]="cognesy/instructor-struct"
 PACKAGES["packages/tell"]="cognesy/instructor-tell"
-PACKAGES["packages/templates"]="cognesy/instructor-templates"
-PACKAGES["packages/utils"]="cognesy/instructor-utils"
+PACKAGES["packages/evals"]="cognesy/instructor-evals"
+PACKAGES["packages/hub"]="cognesy/instructor-hub"
+PACKAGES["packages/addons"]="cognesy/instructor-addons"
+PACKAGES["packages/auxiliary"]="cognesy/instructor-auxiliary"
 
 # Define which packages go in which section of the main composer.json
 declare -A MAIN_REQUIRE_PACKAGES

config/llm.php

@@ -109,7 +109,7 @@
             'apiUrl' => 'https://api.fireworks.ai/inference/v1',
             'apiKey' => Env::get('FIREWORKS_API_KEY', ''),
             'endpoint' => '/chat/completions',
-            'defaultModel' => 'accounts/fireworks/models/mixtral-8x7b-instruct',
+            'defaultModel' => 'accounts/fireworks/models/llama4-maverick-instruct-basic',
             'defaultMaxTokens' => 1024,
             'contextLength' => 65_000,
             'maxOutputLength' => 4096,
@@ -166,10 +166,10 @@
         ],
         'moonshot-kimi' => [
             'providerType' => LLMProviderType::Moonshot->value,
-            'apiUrl' => 'https://api.moonshot.ai/v1',
+            'apiUrl' => 'https://api.moonshot.cn/v1',
             'apiKey' => Env::get('MOONSHOT_API_KEY', ''),
             'endpoint' => '/chat/completions',
-            'defaultModel' => 'kimi-k1.5-preview',
+            'defaultModel' => 'kimi-latest',
             'defaultMaxTokens' => 1024,
             'contextLength' => 128_000,
             'maxOutputLength' => 4096,
@@ -179,7 +179,7 @@
             'apiUrl' => 'http://localhost:11434/v1',
             'apiKey' => Env::get('OLLAMA_API_KEY', ''),
             'endpoint' => '/chat/completions',
-            'defaultModel' => 'qwen2.5-coder:3b', //'gemma2:2b',
+            'defaultModel' => 'gemma3:1b', // 'qwen2.5-coder:3b', //'gemma2:2b',
             'defaultMaxTokens' => 1024,
             'httpClient' => 'http-ollama',
             'contextLength' => 128_000,
@@ -214,7 +214,7 @@
             'apiUrl' => 'https://api.perplexity.ai',
             'apiKey' => Env::get('PERPLEXITY_API_KEY', ''),
             'endpoint' => '/chat/completions',
-            'defaultModel' => 'llama-3.1-sonar-small-128k-online',
+            'defaultModel' => 'sonar',
             'defaultMaxTokens' => 1024,
             'contextLength' => 128_000,
             'maxOutputLength' => 2048,
@@ -234,7 +234,7 @@
             'apiUrl' => 'https://api.together.xyz/v1',
             'apiKey' => Env::get('TOGETHER_API_KEY', ''),
             'endpoint' => '/chat/completions',
-            'defaultModel' => 'mistralai/Mixtral-8x7B-Instruct-v0.1',
+            'defaultModel' => 'meta-llama/Llama-3.3-70B-Instruct-Turbo',
             'defaultMaxTokens' => 1024,
             'contextLength' => 128_000,
             'maxOutputLength' => 4096,
@@ -244,7 +244,7 @@
             'apiUrl' => 'https://api.x.ai/v1',
             'apiKey' => Env::get('XAI_API_KEY', ''),
             'endpoint' => '/chat/completions',
-            'defaultModel' => '-1212',
+            'defaultModel' => 'grok-3',
             'defaultMaxTokens' => 1024,
             'contextLength' => 128_000,
             'maxOutputLength' => 128_000,

docs-build/cookbook/instructor/advanced/context_cache_structured.mdx

@@ -32,7 +32,7 @@ require 'examples/boot.php';
 
 use Cognesy\Instructor\Features\Schema\Attributes\Description;
 use Cognesy\Instructor\Instructor;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 use Cognesy\Utils\Str;
 
 class Project {
@@ -80,7 +80,7 @@ $project = $cached->respond(
     messages: 'Describe the project in a way compelling to my audience: P&C insurance CIOs.',
     responseModel: Project::class,
     options: ['max_tokens' => 4096],
-    mode: Mode::MdJson,
+    mode: OutputMode::MdJson,
 );
 dump($project);
 assert($project instanceof Project);
@@ -99,7 +99,7 @@ $project = $cached->respond(
     messages: "Describe the project in a way compelling to my audience: boutique CMS consulting company owner.",
     responseModel: Project::class,
     options: ['max_tokens' => 4096],
-    mode: Mode::Json,
+    mode: OutputMode::Json,
 );
 dump($project);
 assert($project instanceof Project);

docs-build/cookbook/instructor/advanced/custom_llm.mdx

@@ -18,7 +18,7 @@ require 'examples/boot.php';
 use Cognesy\Instructor\Instructor;
 use Cognesy\Polyglot\LLM\Data\LLMConfig;
 use Cognesy\Polyglot\LLM\Enums\LLMProviderType;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 use Cognesy\Utils\Env;
 
 class User {
@@ -44,7 +44,7 @@ $instructor = (new Instructor)->withLLMConfig($config);
 $user = $instructor->respond(
     messages: "Our user Jason is 25 years old.",
     responseModel: User::class,
-    mode: Mode::Tools,
+    mode: OutputMode::Tools,
 );
 
 

docs-build/cookbook/instructor/advanced/custom_prompts.mdx

@@ -20,7 +20,7 @@ require 'examples/boot.php';
 
 use Cognesy\Http\Events\HttpRequestSent;
 use Cognesy\Instructor\Instructor;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 
 class User {
     public int $age;
@@ -37,7 +37,7 @@ $user = $instructor
         messages: "Our user Jason is 25 years old.",
         responseModel: User::class,
         prompt: "\nYour task is to extract correct and accurate data from the messages using provided tools.\n",
-        mode: Mode::Tools
+        mode: OutputMode::Tools
     );
 echo "\nRESPONSE:\n";
 dump($user);
@@ -48,7 +48,7 @@ $user = $instructor
         messages: "Our user Jason is 25 years old.",
         responseModel: User::class,
         prompt: "\nYour task is to respond correctly with JSON object. Response must follow JSONSchema:\n<|json_schema|>\n",
-        mode: Mode::Json
+        mode: OutputMode::Json
     );
 echo "\nRESPONSE:\n";
 dump($user);
@@ -59,7 +59,7 @@ $user = $instructor
         messages: "Our user Jason is 25 years old.",
         responseModel: User::class,
         prompt: "\nYour task is to respond correctly with strict JSON object containing extracted data within a ```json {} ``` codeblock. Object must validate against this JSONSchema:\n<|json_schema|>\n",
-        mode: Mode::MdJson
+        mode: OutputMode::MdJson
     );
 echo "\nRESPONSE:\n";
 dump($user);

docs-build/cookbook/instructor/advanced/demonstrations.mdx

@@ -21,7 +21,7 @@ require 'examples/boot.php';
 use Cognesy\Http\Events\HttpRequestSent;
 use Cognesy\Instructor\Features\Core\Data\Example;
 use Cognesy\Instructor\Instructor;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 
 class User {
     public int $age;
@@ -46,7 +46,7 @@ $user = (new Instructor)
                 template: "example input:\n<|input|>\noutput:\n```json\n<|output|>\n```\n",
             ),
         ],
-        mode: Mode::Json)
+        mode: OutputMode::Json)
     ->get();
 
 echo "\nOUTPUT:\n";

docs-build/cookbook/instructor/advanced/partials.mdx

@@ -18,7 +18,7 @@ response is received.
 require 'examples/boot.php';
 
 use Cognesy\Instructor\Instructor;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 use Cognesy\Utils\Cli\Console;
 
 class UserRole
@@ -72,7 +72,7 @@ $user = (new Instructor)
         messages: $text,
         responseModel: UserDetail::class,
         options: ['stream' => true],
-        mode: Mode::Json,
+        mode: OutputMode::Json,
     )->get();
 
 echo "All tokens received, fully completed object available in `\$user` variable.\n";

docs-build/cookbook/instructor/advanced/streaming.mdx

@@ -16,7 +16,7 @@ generated.
 require 'examples/boot.php';
 
 use Cognesy\Instructor\Instructor;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 use Cognesy\Utils\Cli\Console;
 
 class UserRole
@@ -67,7 +67,7 @@ $stream = (new Instructor)->withConnection('openai')->request(
     messages: $text,
     responseModel: UserDetail::class,
     options: ['stream' => true],
-    mode: Mode::Json,
+    mode: OutputMode::Json,
 )->stream();
 
 foreach ($stream->partials() as $partial) {

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

@@ -21,7 +21,7 @@ Mode compatibility:
 require 'examples/boot.php';
 
 use Cognesy\Instructor\Instructor;
-use Cognesy\Polyglot\LLM\Enums\Mode;
+use Cognesy\Polyglot\LLM\Enums\OutputMode;
 
 enum UserType : string {
     case Guest = 'guest';
@@ -46,7 +46,7 @@ $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: 'jamba-1.5-mini', // set your own value/source
-    mode: Mode::Json,
+    mode: OutputMode::Json,
     examples: [[
         'input' => 'Ive got email Frank - their developer, who\'s 30. His Twitter handle is @frankch. Btw, he plays on drums!',
         'output' => ['age' => 30, 'name' => 'Frank', 'username' => '@frankch', 'role' => 'developer', 'hobbies' => ['playing drums'],],