Skip to content

Commit 85f1117

Browse files
committed
Update README
1 parent 6ce126d commit 85f1117

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

text_2_sql/GETTING_STARTED.md

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

3-
**Execute all these commands in the `text_2_sql` directory.**
3+
**Execute the following commands in the `text_2_sql` directory.**
44

55
To get started, perform the following steps:
66

@@ -12,4 +12,10 @@ To get started, perform the following steps:
1212
4. Create your `.env` file based on the provided sample `.env.example`. Place this file in the same place as the `.env.example`.
1313
5. Generate a data dictionary for your target server using the instructions in the **Running** section of the `data_dictionary/README.md`.
1414
6. Upload these generated data dictionaries files to the relevant containers in your storage account. Wait for them to be automatically indexed with the included skillsets.
15-
7. Navigate to `autogen` directory to view the AutoGen implementation. Follow the steps in `Iteration 5 - Agentic Vector Based Text2SQL.ipynb` to get started.
15+
16+
**Execute the following commands in the `autogen` directory.**
17+
18+
7. Run `uv sync` within the text_2_sql directory to install dependencies.
19+
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
20+
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
21+
8. Navigate to `autogen` directory to view the AutoGen implementation. Follow the steps in `Iteration 5 - Agentic Vector Based Text2SQL.ipynb` to get started.

text_2_sql/data_dictionary/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ If there is no pre-built script for your database engine, take one of the above
224224

225225
## Running
226226

227-
**Execute all these commands in the `text_2_sql` directory.**
227+
**Execute the following commands in the `text_2_sql` directory.**
228228

229229
To generate a data dictionary, perform the following steps:
230230

0 commit comments

Comments
 (0)