Skip to content

Commit 1124a81

Browse files
authored
Merge pull request #183962 from HeidiSteen/heidist-fresh
[azure search] Added steps and images to Debug how-to
2 parents c2a1b7a + 02d4775 commit 1124a81

File tree

5 files changed

+47
-16
lines changed

5 files changed

+47
-16
lines changed

articles/search/cognitive-search-how-to-debug-skillset.md

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ Debug sessions work with all generally available data sources and most preview d
4040

4141
1. Select the indexer that drives the skillset you want to debug. Copies of both the indexer and skillset are used to create the session.
4242

43-
1. Choose a document. The session will default to the first document in the data source, but you can also choose which document to step through.
43+
1. Choose a document. The session will default to the first document in the data source, but you can also choose which document to step through.
44+
45+
If your document resides in a blob container in the same storage account used to cache your debug session, you can copy the document URL from the blob property page in the portal.
46+
47+
:::image type="content" source="media/cognitive-search-debug/copy-blob-url.png" alt-text="Screenshot of the URI property in blob storage." border="true":::
4448

4549
1. Optionally, specify any indexer execution settings that should be used to create the session. Any indexer options that you specify in a debug session have no effect on the indexer itself.
4650

@@ -52,33 +56,39 @@ The debug session begins by executing the indexer and skillset on the selected d
5256

5357
## Start with errors and warnings
5458

55-
Indexer execution history in the portal gives you the full error and warning list for all documents. In a debug session, the errors and warnings will be limited to one document. As a best practice, resolve problems with inputs before moving on to outputs.
59+
Indexer execution history in the portal gives you the full error and warning list for all documents. In a debug session, the errors and warnings will be limited to one document. You'll work through this list, make your changes, and then return to the list to verify whether issues are resolved.
60+
61+
To view the messages, select a skill in **AI Enrichment > Skill Graph** and then select **Errors/Warnings** in the details pane.
62+
63+
As a best practice, resolve problems with inputs before moving on to outputs.
5664

57-
To determine whether a modification resolves an error, follow these steps:
65+
To prove whether a modification resolves an error, follow these steps:
5866

5967
1. Select **Save** in Skill Details to preserve your changes.
6068

6169
1. Select **Run** in the session window to invoke skillset execution using the modified definition.
6270

63-
1. Return to **Errors and warnings** to see if the count is reduced. The list is not refreshed until you open the tab.
71+
1. Return to **Errors/Warnings** to see if the count is reduced. The list will not be refreshed until you open the tab.
6472

65-
## Check field mappings
73+
## View content of enrichment nodes
74+
75+
AI enrichment pipelines extract or infer information and structure from source documents, creating an enriched document in the process. An enriched document is first created during document cracking and populated with a root node (`/document`) plus nodes for any content that is directly ported from the data source (such as a document key) and metadata. Additional nodes are created by skills during skill execution, where each skill output adds a new node to the enrichment tree.
6676

67-
If you're missing output, check the field mappings that specify how content moves out of the pipeline and into a search index.
77+
Enriched documents are internal, but a debug session gives you access to the content produced during skill execution. To view the content or output of each skill, follow these steps:
6878

6979
1. Start with the default views: **AI enrichment > Skill Graph**, with the graph type set to **Dependency Graph**.
7080

71-
1. Select **Field Mappings** near the top. You should find at least the document key that uniquely identifies and associates each search document in the search index with it's source document in the data source.
81+
1. Select a skill.
7282

73-
If you are importing raw content straight from the data source, bypassing enrichment, you should find those fields in **Field Mappings**.
83+
1. In the details pane to the right, select **Executions**, select an OUTPUT, and then open the Expression Evaluator (**`</>`**) to view the expression and it's result.
7484

75-
1. Select **Output Field Mappings** at the bottom of the graph. Here you will find mappings from skill outputs to target fields in the search index. Unless you used the Import Data wizard, output field mappings are defined manually and could be incomplete or mistyped.
85+
:::image type="content" source="media/cognitive-search-debug/enriched-doc-output-expression.png" alt-text="Screenshot of a skill execution showing output values." border="true":::
7686

77-
Verify that the fields in **Output Field Mappings** exist in the search index as specified, checking for spelling and [enrichment node path syntax](cognitive-search-concept-annotations-syntax.md).
87+
1. Alternatively, open **AI enrichment > Enriched Data Structure** to scroll down the list of nodes. The list includes potential and actual nodes, with a column for output, and another column that indicates the upstream object used to produce the output.
7888

79-
:::image type="content" source="media/cognitive-search-debug/output-field-mappings.png" alt-text="Screenshot of the Output Field Mappings node and details." border="true":::
89+
:::image type="content" source="media/cognitive-search-debug/enriched-doc-output.png" alt-text="Screenshot of enriched document showing output values." border="true":::
8090

81-
## Check skills
91+
## Edit skill definitions
8292

8393
If the field mappings are correct, check individual skills for configuration and content. If a skill fails to produce output, it might be missing a property or parameter, which can be determined through error and validation messages.
8494

@@ -88,11 +98,32 @@ The following steps show you how to get information about a skill.
8898

8999
1. In **AI enrichment > Skill Graph**, select a skill. The Skill Details pane opens to the right.
90100

91-
1. Select **Executions** to show which inputs and outputs were used during skill execution.
101+
1. Edit a skill definition using either approach:
92102

93-
:::image type="content" source="media/cognitive-search-debug/skill-input-output-detection.png" alt-text="Screenshot of Skill graph, details, and execution tab inputs and outputs." border="true":::
103+
+ **Skill Settings** if you prefer a visual editor
104+
+ **Skill JSON Editor** to edit the JSON document directly
94105

95-
1. Select **`</>`** Expression Evaluator to show the values returned by the skill.
106+
1. Check the [path syntax for referencing nodes](cognitive-search-concept-annotations-syntax.md) in an enrichment tree. Inputs are usually one of the following:
107+
108+
+ `/document/content` for chunks of text. This node is populated from the blob's content property.
109+
+ `/document/merged_content` for chunks of text in skillets that include Text Merge skill.
110+
+ `/document/normalized_images/*` for text that is recognized or inferred from images.
111+
112+
## Check field mappings
113+
114+
If skills produce output but the search index is empty, check the field mappings that specify how content moves out of the pipeline and into a search index.
115+
116+
1. Start with the default views: **AI enrichment > Skill Graph**, with the graph type set to **Dependency Graph**.
117+
118+
1. Select **Field Mappings** near the top. You should find at least the document key that uniquely identifies and associates each search document in the search index with it's source document in the data source.
119+
120+
If you are importing raw content straight from the data source, bypassing enrichment, you should find those fields in **Field Mappings**.
121+
122+
1. Select **Output Field Mappings** at the bottom of the graph. Here you will find mappings from skill outputs to target fields in the search index. Unless you used the Import Data wizard, output field mappings are defined manually and could be incomplete or mistyped.
123+
124+
Verify that the fields in **Output Field Mappings** exist in the search index as specified, checking for spelling and [enrichment node path syntax](cognitive-search-concept-annotations-syntax.md).
125+
126+
:::image type="content" source="media/cognitive-search-debug/output-field-mappings.png" alt-text="Screenshot of the Output Field Mappings node and details." border="true":::
96127

97128
## Next steps
98129

articles/search/cognitive-search-tutorial-debug-sessions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Debug skillsets
2+
title: 'Tutorial: Debug skillsets'
33
titleSuffix: Azure Cognitive Search
44
description: Debug sessions (preview) is an Azure portal tool used to find, diagnose, and repair problems in a skillset.
55

105 KB
Loading
53.2 KB
Loading
30 KB
Loading

0 commit comments

Comments
 (0)