Skip to content

Commit

Permalink
[DH-5509] Improve env vars documentation and example file
Browse files Browse the repository at this point in the history
  • Loading branch information
jcjc712 committed Mar 20, 2024
1 parent b829615 commit 9d2fedd
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
6 changes: 3 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ LLM_MODEL = "gpt-4-turbo-preview"

# All of our SQL generation agents are using different tools to generate SQL queries, in order to limit the number of times that agents can
# use different tools you can set the "AGENT_MAX_ITERATIONS" env variable. By default it is set to 20 iterations.

AGENT_MAX_ITERATIONS = 15
#timeout in seconds for the engine to return a response. Defaults to 150 seconds
DH_ENGINE_TIMEOUT =
DH_ENGINE_TIMEOUT = 150
#tmeout for SQL execution, our agents exceute the SQL query to recover from errors, this is the timeout for that execution. Defaults to 30 seconds
SQL_EXECUTION_TIMEOUT =
#The upper limit on number of rows returned from the query engine (equivalent to using LIMIT N in PostgreSQL/MySQL/SQlite). Defauls to 50
UPPER_LIMIT_QUERY_RETURN_ROWS =
UPPER_LIMIT_QUERY_RETURN_ROWS = 50
#Encryption key for storing DB connection data in Mongo
ENCRYPT_KEY =

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ ORG_ID =
ENCRYPT_KEY =
# the variable that determines how many rows should be returned from a query to the agents, set it to small values to avoid high costs and long response times, default is 50
UPPER_LIMIT_QUERY_RETURN_ROWS =
UPPER_LIMIT_QUERY_RETURN_ROWS = 50
# the variable that force the engine to quit if the sql geneation takes more than the time set in this variable, default is None.
DH_ENGINE_TIMEOUT =
DH_ENGINE_TIMEOUT = 150
```

While not strictly required, we also strongly suggest you change the MONGO username and password fields as well.
Expand Down
5 changes: 3 additions & 2 deletions docs/envars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ provided in the .env.example file with the default values.
ONLY_STORE_CSV_FILES_LOCALLY =
DH_ENGINE_TIMEOUT =
UPPER_LIMIT_QUERY_RETURN_ROWS =
AGENT_MAX_ITERATIONS = 15
DH_ENGINE_TIMEOUT = 150
UPPER_LIMIT_QUERY_RETURN_ROWS = 50
.. csv-table::
Expand Down

0 comments on commit 9d2fedd

Please sign in to comment.