Skip to content

Commit 6ce126d

Browse files
committed
Update README
1 parent 9e0c18a commit 6ce126d

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

text_2_sql/GETTING_STARTED.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Getting Started with Agentic Text2SQL Component
22

3+
**Execute all these commands in the `text_2_sql` directory.**
4+
35
To get started, perform the following steps:
46

57
1. Setup Azure OpenAI in your subscription with **gpt-4o-mini** & an embedding model, alongside a SQL Server sample database, AI Search and a storage account.

text_2_sql/data_dictionary/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@ If there is no pre-built script for your database engine, take one of the above
225225
## Running
226226

227227
**Execute all these commands in the `text_2_sql` directory.**
228+
229+
To generate a data dictionary, perform the following steps:
230+
228231
1. Create your `.env` file based on the provided sample `text_2_sql/.env.example`. Place this file in the same place in `text_2_sql/.env`.
229232
2. Package and install the `text_2_sql_core` library. See [build](https://docs.astral.sh/uv/concepts/projects/build/) if you want to build as a wheel and install on an agent. Or you can run from within a `uv` environment and skip packaging.
230233
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`

0 commit comments

Comments
 (0)