https://github.com/christopherarter/dream
An AI/ML toolbox for Laravel
https://github.com/christopherarter/dream
ai laravel machine-learning
Last synced: 4 months ago
JSON representation
An AI/ML toolbox for Laravel
- Host: GitHub
- URL: https://github.com/christopherarter/dream
- Owner: christopherarter
- License: mit
- Created: 2022-10-31T04:01:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-19T21:47:32.000Z (over 3 years ago)
- Last Synced: 2026-01-31T14:44:04.464Z (5 months ago)
- Topics: ai, laravel, machine-learning
- Language: PHP
- Homepage:
- Size: 35.4 MB
- Stars: 182
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# The AI/ML Toolbox for Laravel
[](https://packagist.org/packages/christopherarter/dream)
[](https://packagist.org/packages/christopherarter/dream)
Dream is a package for Laravel that brings common AI/ML tools into your Laravel application without all the boilerplate.
It currently supports:
- **OpenAI**
- **AWS Comprehend**
## Requirements
- PHP 8.1
- Laravel 9
## Getting Started
### Installation
You can install the package via composer:
```bash
composer require christopherarter/dream
```
Next, publish the vendor config file:
```bash
php artisan vendor:publish --provider="Dream\DreamServiceProvider"
```
### Authentication
#### OpenAI
```dotenv
DREAM_OPENAI_API_KEY=your-api-key
```
#### AWS
To use AWS Comprehend, you can add your AWS credentials in your `.env` file. **Note: the user must have access to the AWS Comprehend service.**
```dotenv
AWS_ACCESS_KEY_ID=your-access-key
AWS_SECRET_ACCESS_KEY=your-secret-key
```
---
## Usage
To use this package, you can rely on the `Dream` facade. This facade will automatically use the default driver you have set in your `config/dream.php` file.
```php
use Dream\Facades\Dream;
```
### Sentiment Analysis
Sentiment analysis is the process of determining whether a piece of writing is positive, negative, or neutral. It's also known as opinion mining, deriving the opinion or attitude of a speaker.
Dream includes several helper methods to make it easy to use sentiment analysis.
Example:
```php
use Dream\Facades\Dream;
$sentiment = Dream::text('I love Laravel!')->sentiment();
$sentiment->disposition(); // 'positive';
$sentiment->positive(); // true;
```
Available Methods:
```php
use Dream\Facades\Dream;
$sentiment->disposition(); // 'positive' | 'negative' | 'neutral';
$sentiment->positive(); // true | false;
$sentiment->negative(); // true | false;
$sentiment->neutral(); // true | false;
```
### Entity Extraction
Entity extraction is the process of detecting and classifying key information from text and other unstructured data sources.
It's also known as named entity recognition (NER).
```php
use Dream\Facades\Dream;
$entities = Dream::text('I need a reservation for Mr. Foo and Mr. Bar at
the Foo Bar Restaurant on October 31st.')
->entities();
$entities->people()->toArray(); // ['Mr. Foo', 'Mr. Bar'];
$entities->places()->toArray(); // ['Foo Bar Restaurant'];
$entities->dates()->toArray(); // ['October 31st'];
```
Available Methods:
```php
$entities->people(); // Collection of people
$entities->places(); // Collection of places
$entities->dates(); // Collection of dates
$entities->organizations(); // Collection of organizations
$entities->events(); // Collection of events
$entities->products(); // Collection of products
$entities->quantities(); // Collection of quantities
$enteties->other(); // Collection of other entities
```
### Key Phrase Extraction
Key phrase extraction is the process of identifying the most important phrases in a block of text.
Dream includes the ability to extract key phrases from a string.
```php
use Dream\Facades\Dream;
Dream::text('Laravel is a web application framework with expressive,
elegant syntax. We’ve already laid the foundation — freeing you to create
without sweating the small things.')
->phrases()
->pluck('text')
->toArray();
// [
// "Laravel",
// "a web application framework",
// "expressive, elegant syntax",
// "the foundation —",
// "the small things",
// ]
```
### Language Detection
Language detection is the process of identifying the language of a given text.
Dream includes the ability to detect the language of a string.
```php
use Dream\Facades\Dream;
Dream::text('¿Cuál es tu película favorita?')->language(); // 'es'
```
The language code will be the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code for the language. The
return type is a value backed enum `Dream\Enums\Language` to ensure consistency
across clients.
### Image Text Detection
Dream can detect the text inside of an image. To do this, we'll use the `imageText()` method.
```php
use Dream\Facades\Dream;
$file = Storage::get('image.jpg');
Dream::image($file)
->text()
->pluck('text')
->toArray();
// ["This was text in an image"]
```
*Note: Currently only available using AWS*
### Image Label Detection
Dream can determine labels for an image using the `imageLabels()` method.
```php
use Dream\Facades\Dream;
$file = Storage::get('image.jpg');
Dream::image($file)
->labels()
->pluck('name')
->toArray();
// ["man", "fish", "boat", "water", "ocean", "sea"];
```
*Note: Currently only available using AWS*
---
## Clients
### AWS Comprehend
#### IAM Configuration
The AWS user you provide will need to have access to the Comprehend service.
Here's a policy example:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"comprehend:*",
],
"Effect": "Allow",
"Resource": "*"
}
]
}
```
If you'd like to strictly adhere to [least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege), you can limit the Actions in the role
to just the ones you need. For example, if you only need to use the `entities` method, you can limit the Actions to just `comprehend:DetectEntities`.
#### AWS Rekognition
To use the image detection methods, you'll need to enable the [AWS Rekognition](https://aws.amazon.com/rekognition/) service for your user as well.
You can add this to the example policy above:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"comprehend:*",
],
"Effect": "Allow",
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"rekognition:*"
],
"Resource": "*"
}
]
}
```
#### Environment Variables
By default, Dream will use the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to authenticate with AWS Comprehend.
If you would like to specify a different AWS key & secret to use with Dream,
you can do so by setting the keys with the `DREAM_` prefix.
For example,
```dotenv
DREAM_AWS_ACCESS_KEY_ID=your-key
DREAM_AWS_SECRET_ACCESS_KEY=your-secret
```
### Azure Cognitive Services
Coming soon :)
---
### Building Custom Clients
If you would like to build your own client, or contribute to this project by
adding another client from a different provider, you can do so by extending
the base classes:
- `Dream\Clients\Client` - The base client class
- `Dream\Clients\TextClient` - The base text client class
- `Dream\Clients\ImageClient` - The base image client class
A client should have both image and text capabilities. These capabilities are handled
in their own respective client classes.
```php
[
// ...
'my-custom-client' => [
'driver' => MyCustomClient::class,
],
],
];
```
Finally, you'll set your client as the default driver in your environment. Here's an example in your `.env`:
```dotenv
DREAM_DRIVER=my-custom-client
```
### Testing
```bash
composer test
```
## Roadmap
- [x] Add OCR & Image Recognition
- [x] Add support for OpenAI
- [ ] Add support for Google Natural Language
- [ ] Add support for custom local models using [Rubix ML](https://github.com/RubixML/ML)
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email chris@arter.dev instead of using the issue tracker.
## Credits
- Maintained by [Chris Arter](https://github.com/christopherarter)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.