Skip to content

Commit a0a0462

Browse files
committed
updated with Heidi's comments
1 parent 2c2d2b1 commit a0a0462

File tree

3 files changed

+26
-23
lines changed

3 files changed

+26
-23
lines changed

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,51 +39,53 @@ To start a debug session you must have an existing AI enrichment pipeline includ
3939

4040
The debug session begins by executing the skillset on the selected document. The debug session will record additional metadata associated with each operation in the skillset. The metadata created by the pipeline's skill executions, informs the following set of features that are then used to help identify and fix issues with the skillset.
4141

42-
## AI enrichments
42+
## AI Enrichments
4343

4444
As skills execute a tree of enrichments, representing the document, grows. Using a tree to visualize the outputs of skills or enrichments provides a comprehensive look at all the enrichments performed. You can look across the entire document and inspect each node of the enrichment tree. This perspective makes it easier to shape objects. This format also provides visual cues to the type, path, and contents of each node in the tree.
4545

46-
## Skill graph
46+
## Skill Graph
4747

48-
The skill graph view provides a hierarchical, visual representation of the skillset. The graph is a top to bottom representation of the order in which the skills are executed. Skills that are dependent upon the output of other skills will be shown lower in the graph. Skills at the same level in the hierarchy can execute in parallel.
48+
The **Skill Graph** view provides a hierarchical, visual representation of the skillset. The graph is a top to bottom representation of the order in which the skills are executed. Skills that are dependent upon the output of other skills will be shown lower in the graph. Skills at the same level in the hierarchy can execute in parallel.
4949

50-
Selecting a skill in the graph will highlight the skills connected to it, the node(s) that create its inputs and the node(s) that accept its outputs. Each skill node displays its type, errors or warnings, and execution counts. The skills graph is where you will select which skill to debug or enhance.
50+
Selecting a skill in the graph will highlight the skills connected to it, the nodes that create its inputs and the nodes that accept its outputs. Each skill node displays its type, errors or warnings, and execution counts. The **Skill Graph** is where you will select which skill to debug or enhance. When you select a skill its details will be displayed in the skill details pane to the right of the graph.
5151

5252
> [!div class="mx-imgBorder"]
53-
> ![Skill graph](media/cognitive-search-debug/skills-graph.png)
53+
> ![Skill Graph](media/cognitive-search-debug/skills-graph.png)
5454
5555
## Skill details
5656

57-
The skill details pane displays a set of areas for working with a specific skill. You can review and edit the details of the skill's settings. The skill's JSON definition is provided. The details of the skill's execution and the errors and warnings are also displayed. The Skill Settings & Skill JSON Editor allow for direct edits to the skill. The Expression Evaluator </> opens a window for viewing and editing the expressions of the skills inputs and outputs.
57+
The skill details pane displays a set of areas for working with a specific skill, when that skill is highlighted in the **Skill Graph**. You can review and edit the details of the skill's settings. The skill's JSON definition is provided. The details of the skill's execution and the errors and warnings are also displayed. The **Skill Settings** tab & **Skill JSON Editor** allow for direct edits to the skill. The [`</>`](##expression-evaluator) opens a window for viewing and editing the expressions of the skills inputs and outputs.
5858

59-
Nested input controls in the skill settings window can be used to build complex shapes for projections, output field mappings for a complex type field, or an input to a skill. When used with the expression evaluator, nested inputs provide an easy test and validate expression builder.
59+
Nested input controls in the skill settings window can be used to build complex shapes for projections, output field mappings for a complex type field, or an input to a skill. When used with the **Expression evaluator**, nested inputs provide an easy test and validate expression builder.
6060

6161
## Skill execution history
6262

63-
A skill can execute multiple times in a skillset for a single document. For example, the OCR skill will execute once for each image extracted from each document. The skill execution history provides a deeper look into each invocation of the skill.
63+
A skill can execute multiple times in a skillset for a single document. For example, the OCR skill will execute once for each image extracted from each document. In the skill details pane the **Executions** tab displays the skill's execution history providing a deeper look into each invocation of the skill.
6464

6565
The execution history enables tracking a specific enrichment back to the skill that generated it. Clicking on a skill input navigates to the skill that generated that input. This allows identification of the root cause of a problem that may manifest in a downstream skill.
6666

6767
When a potential issue is identified, the execution history displays links to the skills that generated the specific inputs, providing a stack-trace like feature. Clicking on the skill associated with an input, navigates to the skill to fix any bugs or continue to trace the specific issue.
6868

6969
When building a custom skill or debugging an error with a custom skill, there is the option to generate a request for a skill invocation in the execution history.
7070

71-
## Enriched data structure
71+
## Enriched Data Structure
7272

73-
The enriched data structure pane shows the document's enrichments through the skillset, detailing the context for each enrichment and the originating skill. The expression evaluator `</>` can also be used to view the contents for each enrichment.
73+
The **Enriched Data Structure** pane shows the document's enrichments through the skillset, detailing the context for each enrichment and the originating skill. The **Expression evaluator** can also be used to view the contents for each enrichment.
7474

7575
> [!div class="mx-imgBorder"]
76-
> ![Enriched data structure](media/cognitive-search-debug/enriched-data-structure-display.png)
76+
> ![Enriched Data Structure](media/cognitive-search-debug/enriched-data-structure-display.png)
7777
7878
## Expression evaluator
7979

80-
Debug sessions have a few features that are available across the different components. The expression evaluator `</>` gives a quick peek into the value of any path. It allows for editing the path and testing the results before updating any of the inputs or context for a skill or projection.
80+
**Expression evaluator** gives a quick peek into the value of any path. It allows for editing the path and testing the results before updating any of the inputs or context for a skill or projection.
8181

8282
## Errors/Warnings
8383

8484
This window displays all of the errors and warnings the skillset produces as it is executed against the document in the debug session.
8585

8686
## Next steps
8787

88+
Now that you understand the elements of Debug sessions try the tutorial for a hands-on experience.
89+
8890
> [!div class="nextstepaction"]
8991
> [Explore Debug sessions feature tutorial](https://docs.microsoft.com/azure/search/cognitive-search-tutorial-debug-sessions)

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,29 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2626

2727
## Prerequisites
2828

29-
1. An Azure subscription. Create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) or use your current subscription.
30-
1. An Azure Cognitive Search service instance.
31-
1. An Azure Storage account.
32-
1. [Postman desktop app](https://www.getpostman.com/).
29+
> [!div class="checklist"]
30+
> * An Azure subscription. Create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) or use your current subscription
31+
> * An Azure Cognitive Search service instance
32+
> * An Azure Storage account
33+
> * [Postman desktop app](https://www.getpostman.com/)
3334
3435
## Create services and load data
3536

3637
This tutorial uses Azure Cognitive Search and Azure Storage services.
3738

38-
1. [Download sample data](https://github.com/Azure-Samples/azure-search-knowledge-mining/blob/master/workshops/data/clinical-trials-small.zip) consisting of 107 files. Unzip the files.
39+
* [Download sample data](https://github.com/Azure-Samples/azure-search-sample-data/tree/master/clinical-trials-pdf-19) consisting of 19 files.
3940

40-
1. [Create an Azure storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal) or [find an existing account](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Storage%2storageAccounts/).
41+
* [Create an Azure storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal) or [find an existing account](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Storage%2storageAccounts/).
4142

4243
Choose the same region as Azure Cognitive Search to avoid bandwidth charges.
4344

4445
Choose the StorageV2 (general purpose V2) account type.
4546

46-
1. Open the storage services pages and create a container. Best practice is to specify the access level "private". Name your container `clinicaltrialdataset`.
47+
* Open the storage services pages and create a container. Best practice is to specify the access level "private". Name your container `clinicaltrialdataset`.
4748

48-
1. In container, click **Upload** to upload the sample files you downloaded and unzipped in the first step.
49+
* In container, click **Upload** to upload the sample files you downloaded and unzipped in the first step.
4950

50-
1. [Create an Azure Cognitive Search service](search-create-service-portal.md) or [find an existing service](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices). You can use a free service for this quickstart.
51+
* [Create an Azure Cognitive Search service](search-create-service-portal.md) or [find an existing service](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices). You can use a free service for this quickstart.
5152

5253
## Get a key and URL
5354

@@ -66,7 +67,7 @@ All requests require an api-key on every request sent to your service. Having a
6667
In this section, Postman and a provided collection are used to create the search service's data source, skillset, index, and indexer.
6768

6869
1. If you do not have Postman, you can [download the Postman desktop app here](https://www.getpostman.com/).
69-
1. [Download the Postman collection](https://github.com/Azure-Samples/azure-search-postman-samples/tree/master/Debug-sessions)
70+
1. [Download the Debug Sessions Postman collection](https://github.com/Azure-Samples/azure-search-postman-samples/tree/master/Debug-sessions)
7071
1. Start Postman
7172
1. Under **Files** > **New**, select the collection to import.
7273
1. After the collection is imported, expand the actions list (...).

articles/search/whats-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Azure Search is now renamed to **Azure Cognitive Search** to reflect the expande
2222

2323
## Feature announcements
2424

25-
### May 2020 //build
25+
### May 2020 (Microsoft Build)
2626

2727
+ Debug sessions feature is now in preview. [Sign up to request access](https://aka.ms/DebugSessions). Debug sessions provides a portal-based interface to investigate and resolve issues with a skillset. Fixes created in the debug session can be saved to production skillsets or downloaded for import to your source-controlled project.
2828

0 commit comments

Comments
 (0)