Skip to content
Nappai Documentation

SQLAgent

SQLAgent helps you interact with your SQL database without needing to write complex SQL code. You can ask questions in plain English, and SQLAgent will translate them into SQL queries and return the results. This makes it much easier to access and understand your data.

Relationship with Language Models and SQL Databases

SQLAgent uses a powerful language model (like a sophisticated AI) to understand your questions. It then uses this understanding to create the correct SQL query to run against your database. The results are then presented in a user-friendly way.

Inputs

  • Language Model: This is the AI that understands your questions. You’ll need to select a language model from the available options. This is a required field.
  • Database URI: This is the address of your SQL database. It tells SQLAgent where to find your data. This includes the location and your login details. This is a required field.
  • Extra Tools (Advanced): These are optional extra features that can enhance SQLAgent’s capabilities. You can add these if you need more specialized functionality. This is an optional field.

Outputs

SQLAgent produces a configured SQL agent. This agent is then used to execute your natural language requests against your database. The output you see will be the results of your query, presented in a clear and understandable format. You can then use these results in other parts of your Nappai workflow.

Usage Example

Let’s say you want to know the total sales for the last month. Instead of writing a complex SQL query, you can simply type into SQLAgent: “What were the total sales last month?”. SQLAgent will automatically connect to your database, generate the appropriate SQL query, run it, and display the total sales figure.

Templates

This component is used in the ‘SqlAgent’ template.

  • SQL Query Constructor: This component helps you build SQL queries manually if you prefer.
  • Explain SQL results: This component helps you understand the results of a SQL query in more detail.
  • SQL Executor: This component executes SQL queries directly.

Tips and Best Practices

  • Make your questions as clear and specific as possible. The more precise your question, the better SQLAgent can understand your request.
  • If you encounter errors, double-check your Database URI to ensure it’s correct.
  • Experiment with the “Extra Tools” to see how they can enhance your experience.

Security Considerations

Ensure your Database URI uses secure credentials and is only accessible to authorized users. Never share your Database URI with unauthorized individuals. Review the security settings of your chosen Language Model.