Skip to content

Commit 4285496

Browse files
Merge pull request #285244 from HeidiSteen/heidist-debug
fixing typos
2 parents 3b62393 + 5ad01c3 commit 4285496

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ This article explains supported scenarios and how the editor is organized. Tabs
2323

2424
Use Debug Sessions to investigate and resolve problems with:
2525

26-
+ Built-in skills used for [AI enrichment](cognitive-search-concept-intro.md) (OCR, image analysis, Entity Recognition, Sentiment Analysis, Keyword Extraction).
26+
+ Built-in skills used for [AI enrichment](cognitive-search-concept-intro.md), such as OCR, image analysis, entity recognition, and keyword extraction.
2727

2828
+ Built-in skills used for [integrated vectorization](vector-search-integrated-vectorization.md), with data chunking through Text Split, and vectorization through an embedding skill.
2929

3030
+ Custom skills used to integrate external processing that you provide.
3131

32-
Compare the following images for the first two scenarios. The surface area shows the progression of skills that generate or transform content en route from the source document to the search index. The flow includes index mapping options, and you can trace the arrows to follow the processing trails. The details pane to the right is context-sensitive. It shows a representation of the enriched document, or the details of a skill or mapping.
32+
Compare the following debug session images for the first two scenarios. For both scenarios, the surface area shows the progression of skills that generate or transform content en route from the source document to the search index. The flow includes index mapping options, and you can trace the arrows to follow the processing trail. The details pane to the right is context-sensitive. It shows a representation of the enriched document, or the details of a skill or mapping.
3333

3434
The first image shows a pattern for applied AI enrichment. Skills can run sequentially or in parallel if there are no dependencies. Output field mappings send enriched or generated content from in-memory data structures to fields in an index.
3535

3636
:::image type="content" source="media/cognitive-search-debug/debug-session-flow-applied-ai.png" alt-text="Screenshot of a debug session for OCR and image analysis." lightbox="media/cognitive-search-debug/debug-session-flow-applied-ai.png":::
3737

38-
Skills for integrated vectorization typically include Text Split and an embedding skill. A Text Split skills chunks a document into pages. Projection mappings control parent-chunk indexing. This skillset skips the parent index and creates an index with just chunked content, using metadata to identify the source of the chunk.
38+
The second image shows a typical pattern for integrated vectorization. Skills for integrated vectorization usually includes Text Split and an embedding skill. A Text Split skill chunks a document into pages. An embedding skills provides vectorization. Projection mappings control how chunks of content are index. This particular skillset skips the parent index and creates an index of just chunked content, using metadata to identify the source of the chunk.
3939

4040
:::image type="content" source="media/cognitive-search-debug/debug-session-flow-integrated-vectorization.png" alt-text="Screenshot of a debug session for integrated vectorization." lightbox="media/cognitive-search-debug/debug-session-flow-integrated-vectorization.png":::
4141

@@ -75,15 +75,15 @@ Follow the links to drill further into skills processing. For example, the follo
7575

7676
### Skill details pane
7777

78-
Skill details have the following sections.
78+
The **Skill details** pane has the following sections:
7979

80-
+ **Iterations**: Show you how many times a skill executes. You can check the inputs and outputs of each one.
80+
+ **Iterations**: Shows you how many times a skill executes. You can check the inputs and outputs of each one.
8181
+ **Skill Settings**: View or edit the JSON skillset definition.
8282
+ **Errors and warnings**: Shows the errors or warnings specific to this skill.
8383

84-
## Enriched Data Structure
84+
### Enriched data structure pane
8585

86-
The **Enriched Data Structure** pane slides out to the side when you select the blue show or hide arrow symbol. It's human readable representation of what the enriched document contains. Previous screenshots in this article show examples of the enriched data structure.
86+
The **Enriched Data Structure** pane slides out to the side when you select the blue show or hide arrow symbol. It's a human readable representation of what the enriched document contains. Previous screenshots in this article show examples of the enriched data structure.
8787

8888
## Next steps
8989

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,9 @@ Debug sessions work with all generally available [indexer data sources](search-d
7575
+ Within that container, it creates a folder using the name you provided for the session name.
7676
+ It starts your debug session.
7777

78-
1. The debug session opens to the definition page. The page looks similar the following screenshot.
78+
1. A debug session opens to the settings page. You can make modifications to the initial configuration and override any defaults.
7979

80-
:::image type="content" source="media/cognitive-search-debug/debug-session-new.png" lightbox="media/cognitive-search-debug/debug-session-new.png" alt-text="Screenshot of a debug session page." border="true":::
81-
82-
1. In **Storage connection string**, you can specify or change the storage account. If you already have role assignments, you can skip this step.
80+
1. In **Storage connection string**, you can specify the connection string or change the storage account.
8381

8482
1. In **Document to debug**, choose the first document in the index or select a specific document. If you select a specific document, depending on the data source, you're asked for a URI or a row ID.
8583

@@ -177,7 +175,9 @@ Custom skills can be more challenging to debug because the code runs externally,
177175

178176
### Get a public URL
179177

180-
#### Using Tunnelmole
178+
This section describes two approaches for getting a public URL to a custom skill.
179+
180+
#### Use Tunnelmole
181181

182182
Tunnelmole is an open source tunneling tool that can create a public URL that forwards requests to your local machine through a tunnel.
183183

@@ -203,7 +203,7 @@ Tunnelmole is an open source tunneling tool that can create a public URL that fo
203203

204204
In the preceding example, `https://m5hdpb-ip-49-183-170-144.tunnelmole.net` forwards to port `7071` on your local machine, which is the default port where Azure functions are exposed.
205205

206-
#### Using ngrok
206+
#### Use ngrok
207207

208208
[**ngrok**](https://ngrok.com/docs) is a popular, closed source, cross-platform application that can create a tunneling or forwarding URL, so that internet requests reach your local machine. Use ngrok to forward requests from an enrichment pipeline in your search service to your machine to allow local debugging.
209209

@@ -226,9 +226,9 @@ Tunnelmole is an open source tunneling tool that can create a public URL that fo
226226

227227
### Configure in Azure portal
228228

229-
Within the debug session, modify your Custom Web API Skill URI to call the Tunnelmole or ngrok forwarding URL. Ensure that you append "/api/FunctionName" when using Azure Function for executing the skillset code.
229+
Once you have a public URL for your custom skill, modify your Custom Web API Skill URI within a debug session to call the Tunnelmole or ngrok forwarding URL. Be sure to append "/api/FunctionName" when using Azure Function for executing the skillset code.
230230

231-
You can edit the skill definition in the portal.
231+
You can edit the skill definition in the **Skill settings** section of the **Skill details** pane.
232232

233233
### Test your code
234234

0 commit comments

Comments
 (0)