Merge pull request #265651 from e-straight/indextoolmigration

"Upgrade promptflow legacy index tools article and media"

Author: Stacyrch140

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

@@ -141,6 +141,44 @@ The following JSON format response is an example returned by the tool that inclu
 
 ```
 
+
+## How to migrate from legacy tools to the Index Lookup tool
+The Index Lookup tool looks to replace the three deprecated legacy index tools, the [Vector Index Lookup tool](./vector-index-lookup-tool.md), the [Vector DB Lookup tool](./vector-db-lookup-tool.md) and the [Faiss Index Lookup tool](./faiss-index-lookup-tool.md).
+If you have a flow that contains one of these tools, follow the steps below to upgrade your flow.
+
+### Upgrade your tools
+
+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.
+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. 
+
+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.
+
+   :::image type="content" source="../../media/prompt-flow/upgrade-index-tools/index-dropdown.png" alt-text="Screenshot of the More Tools dropdown in promptflow." lightbox="../../media/prompt-flow/upgrade-index-tools/index-dropdown.png":::
+
+1. Name the new node and click  “Add”.
+
+   :::image type="content" source="../../media/prompt-flow/upgrade-index-tools/save-node.png" alt-text="Screenshot of the index lookup node with name." lightbox="../../media/prompt-flow/upgrade-index-tools/save-node.png":::
+
+1. In the new node, click on the “mlindex_content” textbox. This should be the first textbox in the list.
+
+   :::image type="content" source="../../media/prompt-flow/upgrade-index-tools/mlindex-box.png" alt-text="Screenshot of the expanded Index Lookup node with the mlindex_content box outlined in red." lightbox="../../media/prompt-flow/upgrade-index-tools/mlindex-box.png":::
+
+1. In the Generate drawer that appears, follow the instructions below to upgrade from the three legacy tools:
+- 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.
+- 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.
+- 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.
+8. After filling in the necessary information, click save. 
+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).
+
+   :::image type="content" source="../../media/prompt-flow/upgrade-index-tools/mlindex-with-content.png" alt-text="Screenshot of the expanded Index Lookup node with index information in the cells." lightbox="../../media/prompt-flow/upgrade-index-tools/mlindex-with-content.png":::
+
+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.
+
+    :::image type="content" source="../../media/prompt-flow/upgrade-index-tools/vector-search.png" alt-text="Screenshot of the expanded Index Lookup node with vector search outlined in red." lightbox="../../media/prompt-flow/upgrade-index-tools/vector-search.png":::
+
+11. Edit downstream components to consume the output of your newly added node, instead of the output of the legacy Vector Index Lookup node. 
+12. Delete the Vector Index Lookup node and its parent embedding node. 
+
 ## Next steps
 
 - [Learn more about how to create a flow](../flow-develop.md)