• Stars
    star
    218
  • Rank 175,213 (Top 4 %)
  • Language
    PHP
  • License
    MIT License
  • Created about 1 year ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Query your database using natural language

Laravel Ask DB: Natural Language Database Query Builder

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Ask DB allows you to use OpenAI's GPT-3 to build natural language database queries.

DB::ask('How many users do we have on the "pro" plan?');

Installation

You can install the package via composer:

composer require beyondcode/laravel-ask-database

You can publish the config file with:

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

This is the contents of the published config file:

return [
    /**
     * The database connection name to use. Depending on your
     * use case, you might want to limit the database user
     * to have read-only access to the database.
     */
    'connection' => env('ASK_DATABASE_DB_CONNECTION', 'mysql'),

    /**
     * Strict mode will throw an exception when the query
     * would perform a write/alter operation on the database.
     *
     * If you want to allow write operations - or if you are using a read-only
     * database user - you may disable strict mode.
     */
    'strict_mode' => env('ASK_DATABASE_STRICT_MODE', true),

    /**
     * The maximum number of tables to use before performing an additional
     * table name lookup call to OpenAI.
     * If you have a lot of database tables and columns, they might not fit
     * into a single request to OpenAI. In that case, we will perform a
     * lookup call to OpenAI to get the matching table names for the
     * provided question.
     */
    'max_tables_before_performing_lookup' => env('ASK_DATABASE_MAXIMUM_TABLES', 15),
];

Usage

First, you need to configure your OpenAI API key in your .env file:

OPENAI_API_KEY=sk-...

Then, you can use the DB::ask() method to ask the database:

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

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Credits

License

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

More Repositories

1

laravel-websockets

Websockets for Laravel. Done right.
PHP
5,053
star
2

expose

A beautiful, fully open-source, tunneling service - written in pure PHP
PHP
4,147
star
3

laravel-er-diagram-generator

Generate entity relation diagrams from your Laravel model files.
PHP
1,858
star
4

laravel-query-detector

Laravel N+1 Query Detector
PHP
1,785
star
5

laravel-dump-server

Bring Symfony's Var-Dump Server to Laravel
PHP
1,477
star
6

laravel-self-diagnosis

Perform Self-Diagnosis Tests On Your Laravel Application
PHP
1,386
star
7

writeout.ai

Transcribe and translate your audio files - for free
PHP
1,287
star
8

laravel-mailbox

Catch incoming emails in your Laravel application
PHP
973
star
9

laravel-vouchers

Allow users to redeem vouchers that are bound to models.
PHP
601
star
10

laravel-credentials

Add encrypted credentials to your Laravel production environment.
PHP
572
star
11

laravel-view-xray

Take a look into your Laravel views
PHP
572
star
12

dusk-dashboard

A beautiful dashboard for your Laravel Dusk tests
PHP
559
star
13

laravel-confirm-email

Add email verification to your Laravel projects
PHP
532
star
14

laravel-server-timing

Add Server-Timing header information from within your Laravel apps.
PHP
528
star
15

laravel-comments

Add comments to your Laravel application
PHP
426
star
16

livewire-devtools

Chrome and Firefox DevTools extension for debugging Livewire applications
JavaScript
390
star
17

laravel-websockets-demo

Demo application to use with the Laravel WebSockets package.
PHP
382
star
18

laravel-favicon

Create dynamic favicons based on your environment settings.
PHP
343
star
19

laravel-debugbar-companion

The Laravel DebugBar companion app
Vue
292
star
20

laravel-tag-helper

Add powerful HTML tag helpers to your Laravel application
PHP
236
star
21

tailwindcss-jit-cdn

Tailwind CSS JIT in your browser
JavaScript
229
star
22

laravel-tinker-server

Tinker with your variables while working on your Laravel application
PHP
207
star
23

banners

Create beautiful looking social images for your PHP packages
TypeScript
201
star
24

tailwind-jit-api

Use the full power of Tailwind CSS' new JIT compiler by including one script tag to your HTML.
JavaScript
166
star
25

laravel-visual-diff

Create visual diffs in your Laravel application tests.
PHP
161
star
26

github-now

Automatically generate your GitHub user profile page
PHP
140
star
27

nova-tinker-tool

Use the power of Tinker within your Nova application.
Vue
116
star
28

laravel-prose-linter

Syntax-aware proofreading for your Laravel application.
PHP
104
star
29

laravel-inline-translation

Add inline translation capabilities to your Laravel application.
PHP
104
star
30

httpdump

Easily inspect incoming HTTP Requests
PHP
104
star
31

forge-cli

An opinionated Laravel Forge CLI tool
PHP
100
star
32

laravel-masked-db-dump

Dump masked information from your database
PHP
96
star
33

nova-custom-dashboard-card

A Laravel Nova dashboard card that allows you to build custom dashboards.
Vue
86
star
34

slack-notification-channel

Laravel Slack notification channel with API token support instead of incoming webhooks.
PHP
85
star
35

helo-laravel

HELO Laravel helper package to add
PHP
84
star
36

chatgpt-clone

A ChatGPT clone using the new OpenAI chat completions API
PHP
81
star
37

laravel-scope-checks

Automatically convert your Eloquent scopes to boolean check methods.
PHP
78
star
38

laravel-package-tools

Use the make: commands that you know and love from Laravel - outside of Laravel.
PHP
71
star
39

laravel-fixed-window-limiter

PHP
69
star
40

invoker-community

63
star
41

tinkerwell-community

58
star
42

carbon-desktop-app

🎨 Create and share beautiful images of your source code - right from a native app.
JavaScript
57
star
43

nova-filterable-cards

Add custom filters to your Nova metric cards
Vue
56
star
44

tinkerwell-helper

Open Tinkerwell right from your Laravel apps.
PHP
55
star
45

laravel-sliding-window-limiter

Sliding Time Window Rate Limiter for Laravel
PHP
41
star
46

fathom-analytics-api

The unofficial Fathom Analytics API
PHP
39
star
47

laravelpackageboilerplate.com

PHP
36
star
48

skeleton-laravel

PHP
34
star
49

nova-laravel-update-card

Check if you're running the latest Laravel version right from your Nova dashboard.
PHP
34
star
50

windy-community

31
star
51

docs.beyondco.de

Documentation of the Beyond Code package.
HTML
22
star
52

nova-rss-card

Display custom RSS feeds on your Nova dashboard.
PHP
14
star
53

invoker-er-diagram-plugin

Generate ER Diagrams in Invoker
Vue
14
star
54

nova-installer

The Laravel Nova Package Installer
PHP
14
star
55

laravel-badges

Built live on stage at Laracon Australia 2019
PHP
13
star
56

helo-community

Repository to discuss technical HELO issues, feature requests and more
13
star
57

regexpress

12
star
58

invoker-test-toolkit

Detect, run and evaluate your applications PHPUnit tests in Invoker.
Vue
7
star
59

laragone

PHP
7
star
60

tinkerwell-web-docs

Tinkerwell Web documentation with inline code snippets
7
star
61

skeleton-php

PHP
7
star
62

forge-demo

PHP
6
star
63

devtoolsfortailwind-community

5
star
64

fathom-notifier

PHP
5
star
65

invoker-routes-plugin

A Invoker plugin that shows you a table for all of your registered Laravel routes
Vue
4
star
66

docs-example

Example repository to display the documentation structure
2
star
67

invoker-plugin-typings

1
star
68

github-notion-sync

Syncing issues of multiple repositories with a Notion database.
1
star