Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add NLSQLRetrieverWithSampleRows and NLSQLTableQueryEngineWithSampleRows to sql_query.py
Description
This is a very minor addition to the
sql_query.py
module, adding two classesNLSQLRetrieverWithSampleRows
andNLSQLTableQueryEngineWithSampleRows
which inherit fromNLSQLRetriever
andBaseSQLTableQueryEngine
respectively. This addition is based on the great tutorial by Jerry Liu which then was updated to Workflows in this notebook. The motivation is that, in both the tutorial and the notebook, there is an implementation to add sample rows inside the context to improve the response of the LLM, by giving it a taste of the content of each retrieved table, which makes the SQL more resilient against slight variations in the values to be queried using SQL, for example, which value to use in a "where" clause under a Leave Type column, is it "Business Trip", "BUSINESS", or "TRIP" or who knows?! Giving a sample of the rows inside the context improves the response of the LLM in that regard. The implementation in the tutorial is done using Workflows or QueryPipeline, where most of it (missing only the sample rows) is already implemented in theNLSQLTableQueryEngine
class, so why not add the sample rows to it?!Fixes # Missing adding sample rows to the context in the
NLSQLTableQueryEngine
classNew Package?
Did I fill in the
tool.llamahub
section in thepyproject.toml
and provide a detailed README.md for my new integration or package?Version Bump?
Did I bump the version in the
pyproject.toml
file of the package I am updating? (Except for thellama-index-core
package)Type of Change
Please delete options that are not relevant.
How Has This Been Tested?
Your pull-request will likely not be merged unless it is covered by some form of impactful unit testing.
Suggested Checklist:
make format; make lint
to appease the lint gods