Download the PHP package basillangevin/instructor-laravel without Composer

Structured outputs for LLMs using Spatie Data objects.

Instructor Laravel turns LLM (Large Language Model) responses into spatie/laravel-data objects, helping you easily integrate LLMs into your applications.

Installation

You can install the package via composer:

You can publish the config file with:

These are the contents of the published config file:

Introduction

Instructor Laravel is built on top of echolabsdev/prism: a fantastic package that provides a unified interface to work with various LLM providers.

Instructor Laravel extends the Structured Outputs feature of Prism, allowing you to use spatie/laravel-data objects as your data schema.

The package modifies two methods from Prism: withSchema and generate. All other Prism methods are available and work as expected.

Basic Usage

Because this package transforms LLM responses into spatie/laravel-data objects, we'll start by defining a Data object.

Then, we'll build our LLM request by:

• starting with the Instructor facade,
• passing our Data object class to the withSchema method,
• using standard Prism structured output methods to configure the request, then
• calling the generate method.

The generate method will return a BirdData object from the LLM response.

Collections of Data objects

Instructor Laravel also supports transforming responses that contain collections of Data objects.

The generate method will return a Collection`` ofBirdData` objects.

You may pass a custom Collection class name as the second argument of withCollectionSchema to use a custom collection class:

Validation and retries

Instructor Laravel will automatically validate the LLM response against the Data object's rules.

If the LLM response doesn't match the expected structure, Instructor Laravel will call the LLM again with any errors it encountered, helping the LLM generate a response that matches the expected structure.

By default, the request will be retried up to 3 times. You can change this by calling withRetries(...) or withoutRetries():

The withRetries method accepts the same arguments as Laravel's retry helper (excluding the $callback argument). The number of retries will be added to the initial request, so if you pass 3 to withRetries, the request will be made up to 4 times in total (1 initial attempt + 3 retries).

Improving LLM response reliability

To improve the LLM's understanding of the expected response, Laravel Instructor transforms the Data class into a JSON Schema and passes it to the LLM.

Under the hood, schemas are generated using basillangevin/laravel-json-data-schema. This package adds additional information to the generated schema by transforming:

• PHPDoc block summaries and descriptions,
• most spatie/laravel-data validation attributes, and
• Title, Description, and CustomAnnotation attributes.

All of this information is available to the LLM from the very first request, so it can be helpful to annotate your Data classes more information as needed.

Testing

Each PHP file in this package has a co-located Pest test file named {FileName}Test.php.

This package achieves 100% test coverage, 100% mutation coverage, and 100% PHPStan coverage coverage at level 10.

The following commands can be used to test the package:

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• BasilLangevin
• All Contributors

License

The MIT License (MIT). Please see License File for more information.