sebacarrasco93 / laravel-ask-database
使用自然语言和AI从Laravel查询数据库
dev-main
2024-03-03 03:22 UTC
Requires
- php: ^8.1
- illuminate/contracts: ^10.0
- illuminate/database: ^10.43
- openai-php/laravel: ^0.3.1
- spatie/laravel-package-tools: ^1.14.0
- spatie/once: ^3.1
Requires (Dev)
- larastan/larastan: ^2.9
- laravel/pint: ^1.0
- mockery/mockery: ^1.5
- nunomaduro/collision: ^6.0
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-03 04:17:52 UTC
README
说明
此包旨在成为提示工程的学习资源,以及如何使用PHP/Laravel实现AI生成查询。你可能不应该在生产环境中使用它
由Beyond Code创建的原始包已被归档,它还使用硬编码的text-davinci-003模型,并且已被弃用。然而,这个版本支持自定义特定模型。你可以在
config/ask-database.php
文件中更改它,或者在你的.env
文件中更改它
Ask DB 允许你使用OpenAI的GPT构建自然语言数据库查询。
DB::ask('How many users do we have on the "pro" plan?'); // We have 23 users with "pro" plan.
安装
通过composer安装包
composer require sebacarrasco93/laravel-ask-database
使用以下命令发布配置文件
php artisan vendor:publish --tag="ask-database-config" php artisan vendor:publish --provider="OpenAI\Laravel\ServiceProvider"
关于意外删除、更新或插入怎么办?默认情况下,通过启用严格模式进行保护。你可以禁用它。这样做需自负风险
// config/ask-database.php 'strict_mode' => env('ASK_DATABASE_STRICT_MODE', true),
使用方法
首先,你需要在.env
文件中配置你的OpenAI API密钥
OPENAI_API_KEY=sk-...
默认使用gpt-3.5-turbo-instruct
。你可以选择自定义它
ASK_DATABASE_MODEL=gpt-3.5-turbo-instruct
然后,你可以使用DB::ask()
方法来向数据库提问
$response = DB::ask('How many users are there?'); // We have 100 users
测试
composer test
更新日志
请参阅更新日志以获取有关最近更改的更多信息。
贡献
请参阅贡献指南以获取详细信息。
致谢
许可协议
MIT许可(MIT)。请参阅许可文件以获取更多信息。