https://github.com/helgesverre/mindwave
[WIP] 🧠 Toolkit for building AI features into your Laravel app.
https://github.com/helgesverre/mindwave
laravel-package mindwave
Last synced: 9 months ago
JSON representation
[WIP] 🧠 Toolkit for building AI features into your Laravel app.
- Host: GitHub
- URL: https://github.com/helgesverre/mindwave
- Owner: HelgeSverre
- License: mit
- Created: 2023-05-10T21:55:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T12:41:35.000Z (over 2 years ago)
- Last Synced: 2024-12-28T08:30:23.118Z (over 1 year ago)
- Topics: laravel-package, mindwave
- Language: PHP
- Homepage: https://mindwave.no
- Size: 3.5 MB
- Stars: 70
- Watchers: 4
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://packagist.org/packages/mindwave/mindwave)
[](https://github.com/mindwave/mindwave/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/mindwave/mindwave/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/mindwave/mindwave)
# Mindwave: AI Chatbots, Agents & Document Q&A in Laravel Simplified.
## WARNING: This package is NOT ready to be used yet!
Please follow [@helgesverre](https://twitter.com/helgesverre) for updates, and keep an eye on [TODO.md](/TODO.md) to
track progress.
## Installation
You can install the package via composer:
```bash
composer require mindwave/mindwave
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="mindwave-config"
```
## What is Mindwave?
Mindwave is a Laravel package that lets you easily build AI-powered chatbots, agents, and document question and
answering (Q&A) functionality into your application.
With Mindwave, you can incorporate the power of OpenAI's state-of-the-art language models, Pinecone's vector search
capabilities and your own custom "tools" to create intelligent software applications.
## Code Example
```php
consume(
DocumentLoader::fromPdf(
data: File::get("uploads/important-document.pdf"),
meta: ["name" => "Important document"],
)
)
->consume(
DocumentLoader::fromUrl(
data: "https://mindwave.no/",
meta: ["name" => "Mindwave Documentation"],
)
)
->consume(
DocumentLoader::make("My name is Helge Sverre")
);
$agent->ask("List the top 3 most important things in 'important document'");
$agent->ask("What is mindwave?");
$agent->ask("What is my name?");
```
## Use Cases
- 💬 **Chatbots**: Building AI-powered chatbots to provide support to customers.
- 🤖 **Agents**: Developing intelligent agents to automate tasks within an application.
- ❓ **Document Q&A**: Creating document question and answering (Q&A) systems to extract insights from text.
## Documentation
[Full documentation can be found here](https://mindwave.no).
## Demo Application
To see a real world example of how the Mindwave package can be used, checkout the
[demo application here](https://github.com/helgesverre/mindwave-demo).
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Credits
- [Helge Sverre](https://twitter.com/helgesverre)
- [Probots.io](https://github.com/probots-io) for the [Pinecone PHP Package](https://github.com/probots-io/pinecone-php)
- [Tim Kleyersburg](https://github.com/timkley) for the [Weaviate PHP Package](https://github.com/timkley/weaviate-php)
- [PGVector team](https://github.com/pgvector/pgvector-php/graphs/contributors) for
the [PGVector PHP package](https://github.com/pgvector/pgvector-php)
- [Yethee](https://github.com/yethee) for the [Tiktoken PHP Package](https://github.com/yethee/tiktoken-php)
- [hkulekci](https://github.com/hkulekci) for the [Qdrant PHP Package](https://github.com/hkulekci/qdrant-php)
- [LangChain](https://github.com/hwchase17/langchain/) for serving as the inspiration
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.