Skip to content

Commit e6fb415

Browse files
committed
edited index lookup tool doc with migration steps
1 parent 60666ef commit e6fb415

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

articles/ai-studio/how-to/prompt-flow-tools/index-lookup-tool.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,43 @@ The following JSON format response is an example returned by the tool that inclu
141141

142142
```
143143

144+
145+
## How to migrate from legacy tools to the Index Lookup tool
146+
Previously, in prompt flow for Azure AI Studio there were three different tools for looking up a vector index: the Faiss Index Lookup tool, the Vector DB Lookup Tool, and the Vector Index Lookup tool. We have combined and simplified these three tools into one new tool, known as the [*Index Lookup* tool](./index-lookup-tool.md). The *Index Lookup* tool enables the usage of common vector indices (such as Azure AI Search, FAISS, and Pinecone) for retrieval augmented generation (RAG) in prompt flow. The tool automatically detects the indices in the workspace and allows the selection of the index to be used in the flow. This article will help guide you through the process of upgrading from the legacy lookup tools to the new *Index Lookup* tool.
147+
148+
## Upgrade your tools
149+
150+
1. Update your runtime. In order to do this navigate to the "AI project settings tab on the left blade in AI Studio. From there you should see a list of Prompt flow runtimes. Select the name of the runtime you want to update, and click on the “Update” button near the top of the panel. Wait for the runtime to update itself.
151+
1. Navigate to your flow. You can do this by clicking on the “Prompt flow” tab on the left blade in AI Studio, clicking on the “Flows” pivot tab, and then clicking on the name of your flow.
152+
153+
1. Once inside the flow, click on the “+ More tools” button near the top of the pane. A dropdown should open and click on “Index Lookup [Preview]” to add an instance of the Index Lookup tool.
154+
155+
:::image type="content" source="../../media/prompt-flow/upgrade-index-tools/index-dropdown.png" alt-text="Screenshot of the Index Lookup tool added to a flow in Azure AI Studio." lightbox="../../media/prompt-flow/upgrade-index-tools/index-dropdown.png":::
156+
157+
1. Name the new node and click “Add”.
158+
159+
:::image type="content" source="../../media/prompt-flow/upgrade-index-tools/save-node.png" alt-text="Screenshot of the Index Lookup tool added to a flow in Azure AI Studio." lightbox="../../media/prompt-flow/upgrade-index-tools/save-node.png":::
160+
161+
1. In the new node, click on the “mlindex_content” textbox. This should be the first textbox in the list.
162+
163+
:::image type="content" source="../../media/prompt-flow/upgrade-index-tools/mlindex-box.png" alt-text="Screenshot of the Index Lookup tool added to a flow in Azure AI Studio." lightbox="../../media/prompt-flow/upgrade-index-tools/mlindex-box.png":::
164+
165+
1. In the Generate drawer that appears, follow the instructions below to upgrade from the three legacy tools:
166+
- If using the legacy **Vector Index Lookup** tool, select “Registered Index" in the “index_type” dropdown. Select your vector index asset from the “mlindex_asset_id” dropdown.
167+
- If using the legacy **Faiss Index Lookup** tool, select “Faiss” in the “index_type” dropdown and specify the same path as in the legacy tool.
168+
- If using the legacy **Vector DB Lookup** tool, select AI Search or Pinecone depending on the DB type in the “index_type” dropdown and fill in the information as necessary.
169+
8. After filling in the necessary information, click save.
170+
9. Upon returning to the node, there should be information populated in the “mlindex_content” textbox. Click on the “queries” textbox next, and select the search terms you want to query. You’ll want to select the same value as the input to the “embed_the_question” node, typically either “\${inputs.question}” or “${modify_query_with_history.output}” (the former if you’re in a standard flow and the latter if you’re in a chat flow).
171+
172+
:::image type="content" source="../../media/prompt-flow/upgrade-index-tools/mlindex-with-content.png" alt-text="Screenshot of the Index Lookup tool added to a flow in Azure AI Studio." lightbox="../../media/prompt-flow/upgrade-index-tools/mlindex-with-content.png":::
173+
174+
10. Select a query type by clicking on the dropdown next to “query_type.” “Vector” will produce identical results as the legacy flow, but depending on your index configuration, other options including "Hybrid" and "Semantic" may be available.
175+
176+
:::image type="content" source="../../media/prompt-flow/upgrade-index-tools/vector-search.png" alt-text="Screenshot of the Index Lookup tool added to a flow in Azure AI Studio." lightbox="../../media/prompt-flow/upgrade-index-tools/vector-search.png":::
177+
178+
11. Edit downstream components to consume the output of your newly added node, instead of the output of the legacy Vector Index Lookup node.
179+
12. Delete the Vector Index Lookup node and its parent embedding node.
180+
144181
## Next steps
145182

146183
- [Learn more about how to create a flow](../flow-develop.md)

0 commit comments

Comments
 (0)