laravel-ask-database

Laravel Ask Database 项目介绍

项目概述

Laravel Ask Database 是一个使用自然语言进行数据库查询构建的工具包。它利用了 OpenAI 的 GPT-3 技术来支持实现这一功能。开发者可以通过直观的自然语言来对数据库进行查询，而无需编写复杂的 SQL 语句。例如，通过 DB::ask('How many users do we have on the "pro" plan?'); 这样的调用，开发者可以直接得到数据库中的相应数据。

值得注意的是，该工具包主要用于学习 prompt engineering 和如何通过 PHP/Laravel 实现 AI 生成查询。因此，它可能并不适合在生产环境中使用。

安装指南

要使用 Laravel Ask Database，可以通过 Composer 进行安装：

composer require beyondcode/laravel-ask-database

安装完成后，可以发布配置文件进行进一步的定制：

php artisan vendor:publish --tag="ask-database-config"

发布的配置文件包含了一些重要选项：

• connection：用于选择数据库连接名，通常开发者可能希望限制数据库用户对数据库的只读访问。
• strict_mode：当查询执行写入或修改操作时，严格模式会抛出异常。如果使用具有只读权限的数据库用户，可以禁用此模式。
• max_tables_before_performing_lookup：在调用 OpenAI 进行额外的表名查询之前，允许使用的最大表数量。这在数据库中有大量表和列的情况下尤为重要。

使用方法

首先，需要在 .env 文件中配置 OpenAI 的 API 密钥：

OPENAI_API_KEY=sk-...

然后，可以使用 DB::ask() 方法向数据库发起查询请求，例如：

$response = DB::ask('How many users are there?');

测试

可以使用以下命令运行测试，确保一切正常：

composer test

版本变更与贡献

该项目的变更记录可以通过查看 CHANGELOG 文档获取，具体贡献指南可以参考 CONTRIBUTING 文档。项目由 Marcel Pociot 及其贡献者共同完成，并以 MIT 许可协议发布。

结语

Laravel Ask Database 是一个结合现代 AI 技术与数据库操作的学习型项目，它为开发者提供了全新的数据库操作体验和自由，降低了数据库查询的门槛。虽然它不适合生产环境，但作为学习和探索的工具格外出色。