You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: deploy_ai_search_indexes/README.md
+44-13Lines changed: 44 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,37 @@ The associated scripts in this portion of the repository contains pre-built scri
4
4
5
5
## Steps for Image Processing Index Deployment (For Image Processing)
6
6
7
-
1. Update `.env` file with the associated values. Not all values are required dependent on whether you are using System / User Assigned Identities or a Key based authentication.
8
-
2. Adjust `image_processing.py` with any changes to the index / indexer. The `get_skills()` method implements the skills pipeline. Make any adjustments here in the skills needed to enrich the data source.
9
-
3. Run `deploy.py` with the following args:
7
+
**Execute the following commands in the `deploy_ai_search_indexes` directory:**
10
8
9
+
1. Create your `.env` file based on the provided sample `deploy_ai_search_indexes/.env.example`. Place this file in the same place in `deploy_ai_search_indexes/.env`.
10
+
2. Run `uv sync` within the `deploy_ai_search_indexes` directory to install dependencies.
11
+
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
12
+
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
13
+
14
+
**Execute the following commands in the `deploy_ai_search_indexes/src/deploy_ai_search_indexes` directory:**
15
+
16
+
3. Adjust `image_processing.py` with any changes to the index / indexer. The `get_skills()` method implements the skills pipeline. Make any adjustments here in the skills needed to enrich the data source.
17
+
4. Run `deploy.py` with the following args:
11
18
-`index_type image_processing`. This selects the `ImageProcessingAISearch` sub class.
12
-
-`enable_page_chunking True`. This determines whether page wise chunking is applied in ADI, or whether the inbuilt skill is used for TextSplit. This suits documents that are inheritely page-wise e.g. pptx files.
19
+
-`enable_page_wise_chunking True`. This determines whether page wise chunking is applied in ADI, or whether the inbuilt skill is used for TextSplit. This suits documents that are inheritely page-wise e.g. pptx files.
13
20
-`rebuild`. Whether to delete and rebuild the index.
14
21
-`suffix`. Optional parameter that will apply a suffix onto the deployed index and indexer. This is useful if you want deploy a test version, before overwriting the main version.
15
22
16
23
## Steps for Text2SQL Index Deployment (For Text2SQL)
17
24
18
25
### Schema Store Index
19
26
20
-
1. Update `.env` file with the associated values. Not all values are required dependent on whether you are using System / User Assigned Identities or a Key based authentication.
21
-
2. Adjust `text_2_sql_schema_store.py` with any changes to the index / indexer. The `get_skills()` method implements the skills pipeline. Make any adjustments here in the skills needed to enrich the data source.
22
-
3. Run `deploy.py` with the following args:
27
+
**Execute the following commands in the `deploy_ai_search_indexes` directory:**
28
+
29
+
1. Create your `.env` file based on the provided sample `deploy_ai_search_indexes/.env.example`. Place this file in the same place in `deploy_ai_search_indexes/.env`.
30
+
2. Run `uv sync` within the `deploy_ai_search_indexes` directory to install dependencies.
31
+
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
32
+
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
33
+
34
+
**Execute the following commands in the `deploy_ai_search_indexes/src/deploy_ai_search_indexes` directory:**
35
+
36
+
3. Adjust `text_2_sql_schema_store.py` with any changes to the index / indexer. The `get_skills()` method implements the skills pipeline. Make any adjustments here in the skills needed to enrich the data source.
37
+
4. Run `deploy.py` with the following args:
23
38
24
39
-`index_type text_2_sql_schema_store`. This selects the `Text2SQLSchemaStoreAISearch` sub class.
25
40
-`rebuild`. Whether to delete and rebuild the index.
@@ -28,19 +43,35 @@ The associated scripts in this portion of the repository contains pre-built scri
28
43
29
44
### Column Value Store Index
30
45
31
-
1. Update `.env` file with the associated values. Not all values are required dependent on whether you are using System / User Assigned Identities or a Key based authentication.
32
-
2. Adjust `text_2_sql_column_value_store.py` with any changes to the index / indexer.
33
-
3. Run `deploy.py` with the following args:
46
+
**Execute the following commands in the `deploy_ai_search_indexes` directory:**
47
+
48
+
1. Create your `.env` file based on the provided sample `deploy_ai_search_indexes/.env.example`. Place this file in the same place in `deploy_ai_search_indexes/.env`.
49
+
2. Run `uv sync` within the `deploy_ai_search_indexes` directory to install dependencies.
50
+
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
51
+
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
52
+
53
+
**Execute the following commands in the `deploy_ai_search_indexes/src/deploy_ai_search_indexes` directory:**
54
+
55
+
3. Adjust `text_2_sql_column_value_store.py` with any changes to the index / indexer.
56
+
4. Run `deploy.py` with the following args:
34
57
35
58
-`index_type text_2_sql_column_value_store`. This selects the `Text2SQLColumnValueStoreAISearch` sub class.
36
59
-`rebuild`. Whether to delete and rebuild the index.
37
60
-`suffix`. Optional parameter that will apply a suffix onto the deployed index and indexer. This is useful if you want deploy a test version, before overwriting the main version.
38
61
39
62
### Query Cache Index
40
63
41
-
1. Update `.env` file with the associated values. Not all values are required dependent on whether you are using System / User Assigned Identities or a Key based authentication.
42
-
2. Adjust `text_2_sql_query_cache.py` with any changes to the index. **There is an optional provided indexer or skillset for this cache. You may instead want the application code will write directly to it. See the details in the Text2SQL README for different cache strategies.**
43
-
3. Run `deploy.py` with the following args:
64
+
**Execute the following commands in the `deploy_ai_search_indexes` directory:**
65
+
66
+
1. Create your `.env` file based on the provided sample `deploy_ai_search_indexes/.env.example`. Place this file in the same place in `deploy_ai_search_indexes/.env`.
67
+
2. Run `uv sync` within the `deploy_ai_search_indexes` directory to install dependencies.
68
+
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
69
+
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
70
+
71
+
**Execute the following commands in the `deploy_ai_search_indexes/src/deploy_ai_search_indexes` directory:**
72
+
73
+
3. Adjust `text_2_sql_query_cache.py` with any changes to the index. **There is an optional provided indexer or skillset for this cache. You may instead want the application code will write directly to it. See the details in the Text2SQL README for different cache strategies.**
74
+
4. Run `deploy.py` with the following args:
44
75
45
76
-`index_type text_2_sql_query_cache`. This selects the `Text2SQLQueryCacheAISearch` sub class.
46
77
-`rebuild`. Whether to delete and rebuild the index.
Copy file name to clipboardExpand all lines: text_2_sql/GETTING_STARTED.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@ To get started, perform the following steps:
5
5
**Execute the following commands in the `deploy_ai_search_indexes` directory:**
6
6
7
7
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.
8
-
2.Create your `.env` file based on the provided sample `deploy_ai_search_indexes/.env.example`. Place this file in the same place in `deploy_ai_search_indexes/.env`.
9
-
3.Clone this repository and deploy the AI Search text2sql indexes from `deploy_ai_search_indexes`. See the instructions in the **Steps for Text2SQL Index Deployment (For Structured RAG)** section of the `deploy_ai_search_indexes/README.md`.
8
+
2.Clone this repository and deploy the AI Search text2sql indexes from `deploy_ai_search_indexes`. See the instructions in the **Steps for Text2SQL Index Deployment (For Structured RAG)** section of the `deploy_ai_search_indexes/README.md`.
9
+
3.Create your `.env` file based on the provided sample `deploy_ai_search_indexes/.env.example`. Place this file in the same place in `deploy_ai_search_indexes/.env`.
10
10
11
11
**Execute the following commands in the `text_2_sql_core` directory:**
12
12
13
13
4. 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`.
14
-
5. Run `uv sync` within the text_2_sql directory to install dependencies.
14
+
5. Run `uv sync` within the `text_2_sql_core` directory to install dependencies.
15
15
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
16
16
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
17
17
6. 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`.
@@ -20,7 +20,7 @@ To get started, perform the following steps:
20
20
21
21
**Execute the following commands in the `autogen` directory:**
22
22
23
-
9. Run `uv sync` within the text_2_sql directory to install dependencies.
23
+
9. Run `uv sync` within the `autogen` directory to install dependencies.
24
24
- Install the optional dependencies if you need a database connector other than TSQL. `uv sync --extra <DATABASE ENGINE>`
25
25
- See the supported connectors in `text_2_sql_core/src/text_2_sql_core/connectors`.
26
26
10. Navigate to `autogen` directory to view the AutoGen implementation. Follow the steps in `Iteration 5 - Agentic Vector Based Text2SQL.ipynb` to get started.
0 commit comments