Release version 0.14.7

Author: ddebowczyk

README.md

@@ -23,20 +23,25 @@ Here's a simple CLI demo app using Instructor to extract structured data from te
 
 This repository is a monorepo containing all Instructor's components (required and optional). It hosts all that you need to work with LLMs via Instructor.
 
-Individual components are distributed also as standalone packages that can be used independently.
+Individual components are also distributed as standalone packages that can be used independently.
 
 ![image](docs/images/instructor-packages.png)
 
-Links to read-only repositories of the individual packages:
- - [instructor-struct](https://github.com/cognesy/instructor-struct) - get dev friendly structured outputs from LLMs
- - [instructor-polyglot](https://github.com/cognesy/instructor-polyglot) - use single API for inference and embeddings across most of LLM providers, easily switch between them (e.g., develop on Ollama, switch to Groq in production)
- - [instructor-http-client](https://github.com/cognesy/instructor-http-client) - easily switch between underlying HTTP client libraries (out-of-the-box support for Guzzle, Symfony, Laravel)
- - [instructor-aux](https://github.com/cognesy/instructor-aux) - external tools and integrations, e.g. used by Instructor examples
- - [instructor-addons](https://github.com/cognesy/instructor-addons) - extra capabilities and common LLM-related problem solutions
- - [instructor-utils](https://github.com/cognesy/instructor-utils) - common utility classes used by Instructor packages
- - [instructor-setup](https://github.com/cognesy/instructor-setup) - CLI tool for publishing Instructor config files in your app
- - [instructor-hub](https://github.com/cognesy/instructor-hub) - CLI tool for browsing and running Instructor examples
- - [instructor-tell](https://github.com/cognesy/instructor-tell) - CLI tool for executing LLM prompts in your terminal
+Links to read-only repositories of the standalone package distributions:
+ 
+- [instructor-addons](https://github.com/cognesy/instructor-addons) - extra capabilities and common LLM-related problem solutions
+- [instructor-aux](https://github.com/cognesy/instructor-aux) - external tools and integrations, e.g. used by Instructor examples
+- [instructor-evals](https://github.com/cognesy/instructor-evals) - LLM output evaluation tools
+- [instructor-http-client](https://github.com/cognesy/instructor-http-client) - easily switch between underlying HTTP client libraries (out-of-the-box support for Guzzle, Symfony, Laravel)
+- [instructor-hub](https://github.com/cognesy/instructor-hub) - CLI tool for browsing and running Instructor examples
+- [instructor-polyglot](https://github.com/cognesy/instructor-polyglot) - use single API for inference and embeddings across most of LLM providers, easily switch between them (e.g., develop on Ollama, switch to Groq in production)
+- [instructor-setup](https://github.com/cognesy/instructor-setup) - CLI tool for publishing Instructor config files in your app
+- [instructor-struct](https://github.com/cognesy/instructor-struct) - get dev friendly structured outputs from LLMs
+- [instructor-tell](https://github.com/cognesy/instructor-tell) - CLI tool for executing LLM prompts in your terminal
+- [instructor-templates](https://github.com/cognesy/instructor-templates) - text and chat template tools used by Instructor, support Twig, Blade and ArrowPipe formats
+- [instructor-utils](https://github.com/cognesy/instructor-utils) - common utility classes used by Instructor packages
+
+> NOTE: If you are just starting to use Instructor, I recommend using the `instructor-php` package. It contains all the required components and is the easiest way to get started with the library.
 
 
 
@@ -92,10 +97,11 @@ Links to read-only repositories of the individual packages:
 
 - Developer friendly LLM context caching for reduced costs and faster inference (for Anthropic models)
 - Developer friendly data extraction from images (for OpenAI, Anthropic and Gemini models)
+- Generate vector embeddings using APIs of multiple supported LLM providers
 
 ### Documentation and examples
 
-- Learn more from growing documentation and 50+ cookbooks
+- Learn more from growing documentation and 100+ cookbooks
 
 
 
@@ -958,11 +964,6 @@ Additional dependencies are required for some extras:
  - spatie/array-to-xml
  - gioni06/gpt3-tokenizer
 
-## TODOs
-
- - [ ] Async support
- - [ ] Documentation
-
 
 ## Contributing
 

bin/composer-install-all.sh

@@ -4,6 +4,8 @@ set -e  # stops script on first error
 for dir in packages/*; do
   if [ -f "$dir/composer.json" ]; then
     echo "🔍 Updating dependencies in $dir"
+    composer --working-dir="$dir" clear-cache
+    composer --working-dir="$dir" dump-autoload
     composer --working-dir="$dir" install --no-scripts --no-progress
   fi
 done

bin/publish-ver.sh

@@ -26,16 +26,18 @@ echo "Using release notes from: $NOTES_FILE"
 
 # Define packages - must match those in sync-ver.sh
 declare -A PACKAGES
-PACKAGES["packages/utils"]="cognesy/instructor-utils"
 PACKAGES["packages/addons"]="cognesy/instructor-addons"
-PACKAGES["packages/polyglot"]="cognesy/instructor-polyglot"
-PACKAGES["packages/instructor"]="cognesy/instructor-struct"
 PACKAGES["packages/auxiliary"]="cognesy/instructor-auxiliary"
+PACKAGES["packages/evals"]="cognesy/instructor-evals"
+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/tell"]="cognesy/instructor-tell"
-PACKAGES["packages/experimental"]="cognesy/instructor-experimental"
+PACKAGES["packages/templates"]="cognesy/instructor-templates"
+PACKAGES["packages/utils"]="cognesy/instructor-utils"
 
 # 0. Build docs
 echo "Step 0: Rebuilding documentation..."

bin/sync-ver.sh

@@ -22,29 +22,33 @@ echo "Updating to version $VERSION (dependency constraint ^$MAJOR_MINOR)"
 declare -A PACKAGES
 PACKAGES["packages/addons"]="cognesy/instructor-addons"
 PACKAGES["packages/auxiliary"]="cognesy/instructor-auxiliary"
+PACKAGES["packages/evals"]="cognesy/instructor-evals"
 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/tell"]="cognesy/instructor-tell"
+PACKAGES["packages/templates"]="cognesy/instructor-templates"
 PACKAGES["packages/utils"]="cognesy/instructor-utils"
 
 # Define which packages go in which section of the main composer.json
 declare -A MAIN_REQUIRE_PACKAGES
-MAIN_REQUIRE_PACKAGES["packages/utils"]="cognesy/instructor-utils"
 MAIN_REQUIRE_PACKAGES["packages/addons"]="cognesy/instructor-addons"
-MAIN_REQUIRE_PACKAGES["packages/polyglot"]="cognesy/instructor-polyglot"
+MAIN_REQUIRE_PACKAGES["packages/http-client"]="cognesy/instructor-http-client"
 MAIN_REQUIRE_PACKAGES["packages/instructor"]="cognesy/instructor-struct"
+MAIN_REQUIRE_PACKAGES["packages/polyglot"]="cognesy/instructor-polyglot"
+MAIN_REQUIRE_PACKAGES["packages/setup"]="cognesy/instructor-setup"
+MAIN_REQUIRE_PACKAGES["packages/templates"]="cognesy/instructor-templates"
+MAIN_REQUIRE_PACKAGES["packages/utils"]="cognesy/instructor-utils"
 
 declare -A MAIN_REQUIRE_DEV_PACKAGES
 MAIN_REQUIRE_DEV_PACKAGES["packages/auxiliary"]="cognesy/instructor-auxiliary"
-MAIN_REQUIRE_DEV_PACKAGES["packages/http-client"]="cognesy/instructor-http-client"
+MAIN_REQUIRE_DEV_PACKAGES["packages/evals"]="cognesy/instructor-evals"
+MAIN_REQUIRE_DEV_PACKAGES["packages/experimental"]="cognesy/instructor-experimental"
 MAIN_REQUIRE_DEV_PACKAGES["packages/hub"]="cognesy/instructor-hub"
-MAIN_REQUIRE_DEV_PACKAGES["packages/setup"]="cognesy/instructor-setup"
 MAIN_REQUIRE_DEV_PACKAGES["packages/tell"]="cognesy/instructor-tell"
-MAIN_REQUIRE_DEV_PACKAGES["packages/experimental"]="cognesy/instructor-experimental"
 
 # Check if jq is installed
 if ! command -v jq &> /dev/null; then

bin/test-publish.sh

@@ -30,15 +30,18 @@ echo "Using release notes from: $NOTES_FILE"
 
 # Define packages - must match those in sync-ver.sh
 declare -A PACKAGES
-PACKAGES["packages/utils"]="cognesy/instructor-utils"
 PACKAGES["packages/addons"]="cognesy/instructor-addons"
-PACKAGES["packages/polyglot"]="cognesy/instructor-polyglot"
-PACKAGES["packages/instructor"]="cognesy/instructor-struct"
 PACKAGES["packages/auxiliary"]="cognesy/instructor-auxiliary"
+PACKAGES["packages/evals"]="cognesy/instructor-evals"
+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/tell"]="cognesy/instructor-tell"
+PACKAGES["packages/templates"]="cognesy/instructor-templates"
+PACKAGES["packages/utils"]="cognesy/instructor-utils"
 
 # Create a backup directory
 BACKUP_DIR="test_backup_$(date +%Y%m%d_%H%M%S)"

composer.json

@@ -30,8 +30,10 @@
       "Cognesy\\Addons\\": "packages/addons/src/",
       "Cognesy\\Http\\": "packages/http-client/src/",
       "Cognesy\\Instructor\\": "packages/instructor/src/",
+      "Cognesy\\Messages\\": "packages/messages/src/",
       "Cognesy\\Polyglot\\": "packages/polyglot/src/",
       "Cognesy\\Setup\\": "packages/setup/src/",
+      "Cognesy\\Template\\": "packages/templates/src/",
       "Cognesy\\Utils\\": "packages/utils/src/"
     },
     "files": []
@@ -50,9 +52,11 @@
       "Cognesy\\Http\\Tests\\": "packages/http-client/tests/",
       "Cognesy\\InstructorHub\\Tests\\": "packages/hub/tests/",
       "Cognesy\\Instructor\\Tests\\": "packages/instructor/tests/",
+      "Cognesy\\Messages\\Tests\\": "packages/messages/tests/",
       "Cognesy\\Polyglot\\Tests\\": "packages/polyglot/tests/",
       "Cognesy\\Setup\\Tests\\": "packages/setup/tests/",
       "Cognesy\\Tell\\Tests\\": "packages/tell/tests/",
+      "Cognesy\\Templates\\Tests\\": "packages/templates/tests/",
       "Cognesy\\Utils\\Tests\\": "packages/utils/tests/",
       "Evals\\": "evals/",
       "Examples\\": "examples/",

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

@@ -19,9 +19,9 @@ Mode compatibility:
 <?php
 require 'examples/boot.php';
 
+use Cognesy\Http\Debug\Debug;
 use Cognesy\Instructor\Instructor;
 use Cognesy\Polyglot\LLM\Enums\Mode;
-use Cognesy\Utils\Debug\Debug;
 
 enum UserType : string {
     case Guest = 'guest';

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

@@ -19,9 +19,9 @@ Mode compatibility:
 <?php
 require 'examples/boot.php';
 
+use Cognesy\Http\Debug\Debug;
 use Cognesy\Instructor\Instructor;
 use Cognesy\Polyglot\LLM\Enums\Mode;
-use Cognesy\Utils\Debug\Debug;
 
 enum UserType : string {
     case Guest = 'guest';

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

@@ -19,9 +19,9 @@ Mode compatibility:
 <?php
 require 'examples/boot.php';
 
+use Cognesy\Http\Debug\Debug;
 use Cognesy\Instructor\Instructor;
 use Cognesy\Polyglot\LLM\Enums\Mode;
-use Cognesy\Utils\Debug\Debug;
 
 enum UserType : string {
     case Guest = 'guest';

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

@@ -14,10 +14,10 @@ the provided text.
 <?php
 require 'examples/boot.php';
 
+use Cognesy\Http\Debug\Debug;
 use Cognesy\Instructor\Extras\Sequence\Sequence;
 use Cognesy\Instructor\Instructor;
 use Cognesy\Polyglot\LLM\Enums\Mode;
-use Cognesy\Utils\Debug\Debug;
 
 $report = <<<'EOT'
     [2021-09-01]