Skip to content

Commit fed01d1

Browse files
authored
Merge pull request #185651 from bleroy/beleroy/debug-session-tweaks
Some tweaks to the debug session documentation
2 parents 3cb9fd7 + 287cc94 commit fed01d1

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

articles/search/cognitive-search-debug-session.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ ms.date: 12/30/2021
1313

1414
# Debug Sessions in Azure Cognitive Search
1515

16-
Debug Sessions is a visual editor that works with an existing skillset in the Azure portal, exposing the structure and content of a single enriched document, as its produced by an indexer and skillset, for the duration of the session. Because you are working with a live document, the session is interactive - you can identify errors, modify and invoke skill execution, and validate the results in real time. If your changes resolve the problem, you can commit them to a published skillset to apply the fixes globally.
16+
Debug Sessions is a visual editor that works with an existing skillset in the Azure portal, exposing the structure and content of a single enriched document, as it's produced by an indexer and skillset, for the duration of the session. Because you are working with a live document, the session is interactive - you can identify errors, modify and invoke skill execution, and validate the results in real time. If your changes resolve the problem, you can commit them to a published skillset to apply the fixes globally.
1717

1818
> [!Important]
1919
> Debug Sessions is a preview feature provided under [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2020
2121
## How a debug session works
2222

23-
When you start a session, the search service creates a copy of the skillset, indexer, and a search index containing a single document that will be used to test the skillset. All session state will be saved to a container in an Azure Storage account that you provide.
23+
When you start a session, the search service creates a copy of the skillset, indexer, and a data source containing a single document that will be used to test the skillset. All session state will be saved to a container in an Azure Storage account that you provide.
2424

2525
A cached copy of the enriched document and skillset is loaded into the visual editor so that you can inspect the content and metadata of the enriched document, with the ability to check each document node and edit any aspect of the skillset definition. Any changes made within the session are cached. Those changes will not affect the published skillset unless you commit them. Committing changes will overwrite the production skillset.
2626

@@ -44,7 +44,7 @@ Skill details includes the following areas:
4444

4545
+ **Skill Settings** shows a formatted version of the skill definition.
4646
+ **Skill JSON Editor** shows the raw JSON document of the definition.
47-
+ **Executions** shows the number of times a skill was executed.
47+
+ **Executions** shows the data corresponding to each time a skill was executed.
4848
+ **Errors and warnings** shows the messages generated upon session start or refresh.
4949

5050
On Executions or Skill Settings, select the **`</>`** symbol to open the [**Expression Evaluator**](#expression-evaluator) used for viewing and editing the expressions of the skills inputs and outputs.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.date: 12/31/2021
1515

1616
Start a debug session to identify and resolve errors, validate changes, and push changes to a published skillset in your Azure Cognitive Search service.
1717

18-
A debug session is a cached indexer and skillset execution, scoped to a single document, that you can edit and test your changes interactively. If you are unfamiliar with how a debug session works, see [Debug sessions in Azure Cognitive Search](cognitive-search-debug-session.md). To practice a debug workflow with a sample document, see [Tutorial: Debug sessions](cognitive-search-tutorial-debug-sessions.md).
18+
A debug session is a cached indexer and skillset execution, scoped to a single document, that you can use to edit and test your changes interactively. If you are unfamiliar with how a debug session works, see [Debug sessions in Azure Cognitive Search](cognitive-search-debug-session.md). To practice a debug workflow with a sample document, see [Tutorial: Debug sessions](cognitive-search-tutorial-debug-sessions.md).
1919

2020
> [!Important]
2121
> Debug sessions is a preview portal feature, provided under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
@@ -64,7 +64,7 @@ As a best practice, resolve problems with inputs before moving on to outputs.
6464

6565
To prove whether a modification resolves an error, follow these steps:
6666

67-
1. Select **Save** in Skill Details to preserve your changes.
67+
1. Select **Save** in the skill details pane to preserve your changes.
6868

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

@@ -103,7 +103,7 @@ The following steps show you how to get information about a skill.
103103
+ **Skill Settings** if you prefer a visual editor
104104
+ **Skill JSON Editor** to edit the JSON document directly
105105

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:
106+
1. Check the [path syntax for referencing nodes](cognitive-search-concept-annotations-syntax.md) in an enrichment tree. Following are some of the most common input paths:
107107

108108
+ `/document/content` for chunks of text. This node is populated from the blob's content property.
109109
+ `/document/merged_content` for chunks of text in skillets that include Text Merge skill.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ You will need the [Postman collection](https://github.com/Azure-Samples/azure-se
103103

104104
## Check results in the portal
105105

106-
The sample code intentionally creates a buggy index as a consequence of problems that occurred during skillset execution. The problem in the index is missing data.
106+
The sample code intentionally creates a buggy index as a consequence of problems that occurred during skillset execution. The problem is that the index is missing data.
107107

108108
1. In Azure portal, on the search service **Overview** page, select the **Indexes** tab.
109109

@@ -113,7 +113,7 @@ The sample code intentionally creates a buggy index as a consequence of problems
113113

114114
1. Select **Search** to run the query. You should see empty values for "organizations" and "locations".
115115

116-
These fields should have been populated through the skillset's [Entity Recognition skill](cognitive-search-skill-entity-recognition-v3.md), used to detect organizations and locations anywhere within the blob's content. In the next exercise, you'll use debug the skillset to determine what went wrong.
116+
These fields should have been populated through the skillset's [Entity Recognition skill](cognitive-search-skill-entity-recognition-v3.md), used to detect organizations and locations anywhere within the blob's content. In the next exercise, you'll debug the skillset to determine what went wrong.
117117

118118
Another way to investigate errors and warnings is through the Azure portal.
119119

0 commit comments

Comments
 (0)