Skip to content

Commit e760f1f

Browse files
committed
AML Index lookup tool migrate
1 parent 0f18682 commit e760f1f

File tree

7 files changed

+43
-5
lines changed

7 files changed

+43
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,15 @@ If you have a flow that contains one of these tools, follow the steps below to u
153153

154154
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.
155155

156-
:::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":::
156+
:::image type="content" source="../../media/prompt-flow/index-lookup-tool/index-dropdown.png" alt-text="Screenshot of the More Tools dropdown in promptflow." lightbox="../../media/prompt-flow/index-lookup-tool/index-dropdown.png":::
157157

158158
1. Name the new node and click “Add”.
159159

160-
:::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":::
160+
:::image type="content" source="../../media/prompt-flow/index-lookup-tool/save-node.png" alt-text="Screenshot of the index lookup node with name." lightbox="../../media/prompt-flow/index-lookup-tool/save-node.png":::
161161

162162
1. In the new node, click on the “mlindex_content” textbox. This should be the first textbox in the list.
163163

164-
:::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":::
164+
:::image type="content" source="../../media/prompt-flow/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/prompt-flow/index-lookup-tool/mlindex-box.png":::
165165

166166
1. In the Generate drawer that appears, follow the instructions below to upgrade from the three legacy tools:
167167
- 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.
@@ -170,11 +170,11 @@ If you have a flow that contains one of these tools, follow the steps below to u
170170
8. After filling in the necessary information, click save.
171171
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).
172172

173-
:::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":::
173+
:::image type="content" source="../../media/prompt-flow/index-lookup-tool/mlindex-with-content.png" alt-text="Screenshot of the expanded Index Lookup node with index information in the cells." lightbox="../../media/prompt-flow/index-lookup-tool/mlindex-with-content.png":::
174174

175175
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.
176176

177-
:::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":::
177+
:::image type="content" source="../../media/prompt-flow/index-lookup-tool/vector-search.png" alt-text="Screenshot of the expanded Index Lookup node with vector search outlined in red." lightbox="../../media/prompt-flow/index-lookup-tool/vector-search.png":::
178178

179179
11. Edit downstream components to consume the output of your newly added node, instead of the output of the legacy Vector Index Lookup node.
180180
12. Delete the Vector Index Lookup node and its parent embedding node.

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,44 @@ The following JSON format response is an example returned by the tool that inclu
150150

151151
```
152152

153+
## How to migrate from legacy tools to the Index Lookup tool
154+
155+
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).
156+
If you have a flow that contains one of these tools, follow the steps below to upgrade your flow.
157+
158+
### Upgrade your tools
159+
160+
1. [Update your runtime](how-to-create-manage-runtime.md#update-a-runtime-on-the-ui).
161+
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.
162+
163+
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.
164+
165+
:::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":::
166+
167+
1. Name the new node and select “Add”.
168+
169+
:::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":::
170+
171+
1. In the new node, select the “mlindex_content” textbox. This should be the first textbox in the list.
172+
173+
:::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":::
174+
175+
1. In the Generate drawer that appears, follow the instructions below to upgrade from the three legacy tools:
176+
- 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.
177+
- 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.
178+
- 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.
179+
8. After filling in the necessary information, select save.
180+
9. 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).
181+
182+
:::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":::
183+
184+
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" might be available.
185+
186+
:::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":::
187+
188+
11. Edit downstream components to consume the output of your newly added node, instead of the output of the legacy Vector Index Lookup node.
189+
12. Delete the Vector Index Lookup node and its parent embedding node.
190+
153191
## Next steps
154192

155193
- [Learn more about how to create a flow](../how-to-develop-flow.md)
66.5 KB
Loading
21.9 KB
Loading
25.1 KB
Loading
6.84 KB
Loading
29 KB
Loading

0 commit comments

Comments
 (0)