Skip to content

Commit c720fdd

Browse files
committed
refine according to reviewer comments
1 parent b8cd86c commit c720fdd

File tree

6 files changed

+11
-7
lines changed

6 files changed

+11
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Faiss Index Lookup is a tool tailored for querying within a user-provided Faiss-
2626
| workspace datastores or workspace default blob | AzureML Data Scientist |
2727
| other blobs | Storage Blob Data Reader |
2828
> [!NOTE]
29-
> When legacy tools switching to code first mode, if you encounter "'embeddingstore.tool.faiss_index_lookup.search' is not found" error, please refer to the [Troubleshooting Guidance](./troubleshooting-guidance.md).
29+
> When legacy tools switching to code first mode, if you encounter "'embeddingstore.tool.faiss_index_lookup.search' is not found" error, please refer to the [Troubleshoot Guidance](./troubleshoot-guidance.md).
3030
3131
## Inputs
3232

articles/machine-learning/prompt-flow/tools-reference/troubleshooting-guidance.md renamed to articles/machine-learning/prompt-flow/tools-reference/troubleshoot-guidance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Troubleshooting Guidance
2+
title: Troubleshoot Guidance
33
titleSuffix: Azure Machine Learning
44
description: This article addresses frequent questions about tool usage.
55
services: machine-learning
@@ -12,7 +12,7 @@ ms.reviewer: lagayhar
1212
ms.date: 09/05/2023
1313
---
1414

15-
# Troubleshooting Guidance
15+
# Troubleshoot Guidance
1616

1717
This article addresses frequent questions about tool usage.
1818

@@ -27,9 +27,9 @@ To resolve the issue, you have two options:
2727
- **Option 1**
2828
- Update your runtime to latest version.
2929
- Click on "Raw file mode" to switch to the raw code view, then open the "flow.dag.yaml" file.
30-
![switch-to-raw-file-mode](../media/faq/switch_to_raw_file_mode.png)
30+
![how-to-switch-to-raw-file-mode](../media/faq/switch-to-raw-file-mode.png)
3131
- Update the tool names.
32-
![update-tool-name](../media/faq/update_tool_name.png)
32+
![how-to-update-tool-name](../media/faq/update-tool-name.png)
3333

3434
| Tool | New tool name |
3535
| ---- | ---- |

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The tool searches data from a third-party vector database. To use it, you should
4545
- Add "Weaviate" connection. Fill "API base" with your self-maintained instance address and fill "API key" field.
4646

4747
> [!NOTE]
48-
> When legacy tools switching to code first mode, if you encounter "'embeddingstore.tool.vector_db_lookup.search' is not found" error, please refer to the [Troubleshooting Guidance](./troubleshooting-guidance.md).
48+
> When legacy tools switching to code first mode, if you encounter "'embeddingstore.tool.vector_db_lookup.search' is not found" error, please refer to the [Troubleshoot Guidance](./troubleshoot-guidance.md).
4949
5050
## Inputs
5151

@@ -91,12 +91,14 @@ The following is an example JSON format response returned by the tool, which inc
9191
- **Azure Cognitive Search:**
9292

9393
For Azure Cognitive Search, the following fields are populated:
94+
9495
| Field Name | Type | Description |
9596
| ---- | ---- | ----------- |
9697
| original_entity | dict | the original response json from search REST API|
9798
| score | float | @search.score from the original entity, which evaluates the similarity between the entity and the query vector |
9899
| text | string | text of the entity|
99100
| vector | list | vector of the entity|
101+
100102
<details>
101103
<summary>Output</summary>
102104

@@ -122,6 +124,7 @@ The following is an example JSON format response returned by the tool, which inc
122124
- **Qdrant:**
123125

124126
For Qdrant, the following fields are populated:
127+
125128
| Field Name | Type | Description |
126129
| ---- | ---- | ----------- |
127130
| original_entity | dict | the original response json from search REST API|
@@ -159,6 +162,7 @@ The following is an example JSON format response returned by the tool, which inc
159162
- **Weaviate:**
160163

161164
For Weaviate, the following fields are populated:
165+
162166
| Field Name | Type | Description |
163167
| ---- | ---- | ----------- |
164168
| original_entity | dict | the original response json from search REST API|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Vector index lookup is a tool tailored for querying within an Azure Machine Lear
3030
| workspace datastores or workspace default blob | AzureML Data Scientist |
3131
| other blobs | Storage Blob Data Reader |
3232
> [!NOTE]
33-
> When legacy tools switching to code first mode, if you encounter "'embeddingstore.tool.vector_index_lookup.search' is not found" error, please refer to the [Troubleshooting Guidance](./troubleshooting-guidance.md).
33+
> When legacy tools switching to code first mode, if you encounter "'embeddingstore.tool.vector_index_lookup.search' is not found" error, please refer to the [Troubleshoot Guidance](./troubleshoot-guidance.md).
3434
3535
## Inputs
3636

0 commit comments

Comments
 (0)