Merge pull request #269602 from lgayhardt/amlpfindextool0324

AML Index lookup tool migrate

Author: ttorble

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

@@ -17,6 +17,9 @@ author: lgayhardt
 
 [!INCLUDE [Azure AI Studio preview](../../includes/preview-ai-studio.md)]
 
+> [!IMPORTANT]
+> Vector, Vector DB and Faiss Index Lookup tools are deprecated and will be retired soon. [Migrated to the new Index Lookup tool (preview).](index-lookup-tool.md#how-to-migrate-from-legacy-tools-to-the-index-lookup-tool)
+
 The prompt flow *Faiss Index Lookup* tool is tailored for querying within a user-provided Faiss-based vector store. In combination with the [Large Language Model (LLM) tool](llm-tool.md), it can help to extract contextually relevant information from a domain knowledge base.
 
 ## Build with the Faiss Index Lookup tool

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

@@ -17,6 +17,9 @@ author: lgayhardt
 
 [!INCLUDE [Azure AI Studio preview](../../includes/preview-ai-studio.md)]
 
+> [!IMPORTANT]
+> Vector, Vector DB and Faiss Index Lookup tools are deprecated and will be retired soon. [Migrated to the new Index Lookup tool (preview).](index-lookup-tool.md#how-to-migrate-from-legacy-tools-to-the-index-lookup-tool)
+
 The prompt flow *Vector DB Lookup* tool is a vector search tool that allows users to search top-k similar vectors from vector database. This tool is a wrapper for multiple third-party vector databases. The list of current supported databases is as follows.
 
 | Name | Description |

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

@@ -17,6 +17,9 @@ author: lgayhardt
 
 [!INCLUDE [Azure AI Studio preview](../../includes/preview-ai-studio.md)]
 
+> [!IMPORTANT]
+> Vector, Vector DB and Faiss Index Lookup tools are deprecated and will be retired soon. [Migrated to the new Index Lookup tool (preview).](index-lookup-tool.md#how-to-migrate-from-legacy-tools-to-the-index-lookup-tool)
+
 The prompt flow *Vector index lookup* tool is tailored for querying within vector index such as Azure AI Search. You can extract contextually relevant information from a domain knowledge base.
 
 ## Build with the Vector index lookup tool

articles/machine-learning/prompt-flow/tools-reference/faiss-index-lookup-tool.md

@@ -11,11 +11,14 @@ ms.topic: reference
 author: likebupt
 ms.author: keli19
 ms.reviewer: lagayhar
-ms.date: 11/02/2023
+ms.date: 03/21/2024
 ---
 
 # Faiss Index Lookup tool
 
+> [!IMPORTANT]
+> Vector, Vector DB and Faiss Index Lookup tools are deprecated and will be retired soon. [Migrated to the new Index Lookup tool (preview).](index-lookup-tool.md#how-to-migrate-from-legacy-tools-to-the-index-lookup-tool)
+
 Faiss Index Lookup is a tool tailored for querying within a user-provided Faiss-based vector store. In combination with our large language model (LLM) tool, it empowers you to extract contextually relevant information from a domain knowledge base.
 
 ## Prerequisites

articles/machine-learning/prompt-flow/tools-reference/index-lookup-tool.md

@@ -150,6 +150,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](../how-to-create-manage-runtime.md#update-a-runtime-on-the-ui).
+1. Navigate to your flow. You can do this by selecting the **Prompt flow** tab under *Authoring*, selecting **Flows** pivot tab, and then selecting the name of your flow.
+
+1. Once inside the flow, select the “+ More tools” button near the top of the pane. A dropdown should open and select **Index Lookup [Preview]** to add an instance of the Index Lookup tool.
+
+   :::image type="content" source="./media/index-lookup-tool/index-dropdown.png" alt-text="Screenshot of the More Tools dropdown in prompt flow." lightbox="./media/index-lookup-tool/index-dropdown.png":::
+
+1. Name the new node and select “Add”.
+
+   :::image type="content" source="./media/index-lookup-tool/save-node.png" alt-text="Screenshot of the index lookup node with name." lightbox="./media/index-lookup-tool/save-node.png":::
+
+1. In the new node, select the “mlindex_content” textbox. This should be the first textbox in the list.
+
+   :::image type="content" source="./media/index-lookup-tool/mlindex-box.png" alt-text="Screenshot of the expanded Index Lookup node with the mlindex_content box outlined in red." lightbox="./media/index-lookup-tool/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.
+1. After filling in the necessary information, select save. 
+1. Upon returning to the node, there should be information populated in the “mlindex_content” textbox. Select 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/index-lookup-tool/mlindex-with-content.png" alt-text="Screenshot of the expanded Index Lookup node with index information in the cells." lightbox="./media/index-lookup-tool/mlindex-with-content.png":::
+
+1. 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" might be available.
+
+    :::image type="content" source="./media/index-lookup-tool/vector-search.png" alt-text="Screenshot of the expanded Index Lookup node with vector search outlined in red." lightbox="./media/index-lookup-tool/vector-search.png":::
+
+1. Edit downstream components to consume the output of your newly added node, instead of the output of the legacy Vector Index Lookup node.
+1. Delete the Vector Index Lookup node and its parent embedding node.
+
 ## Next steps
 
 - [Learn more about how to create a flow](../how-to-develop-flow.md)