Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs[patch]: remove duplicate content from sql QA tutorial page #6150

Merged
merged 1 commit into from
Jul 19, 2024
Merged

docs[patch]: remove duplicate content from sql QA tutorial page #6150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions docs/core_docs/docs/tutorials/sql_qa.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,6 @@ At a high-level, the steps of most SQL chain and agent are:

![SQL Use Case Diagram](/img/sql_usecase.png)

## ⚠️ Security note ⚠️

Building Q&A systems of SQL databases can require executing model-generated SQL queries. There are inherent risks in doing this.
Make sure that your database connection permissions are always scoped as narrowly as possible for your chain/agent's needs.
This will mitigate though not eliminate the risks of building a model-driven system. For more on general security best practices, see [here](/docs/security).

## Architecture

At a high-level, the steps of most SQL chain and agent are:

1. **Convert question to SQL query**: Model converts user input to a SQL query.
2. **Execute SQL query**: Execute the SQL query
3. **Answer the question**: Model responds to user input using the query results.

![SQL Use Case Diagram](/img/sql_usecase.png)

## Setup

First, get required packages and set environment variables:
Expand Down
Loading