Merge pull request #201063 from HeidiSteen/heidist-debug-ga

[azure search] Debug sessions GA

Author: AnnaMHuff

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

@@ -1,26 +1,23 @@
 ---
-title: Debug Sessions concepts (preview)
+title: Debug Sessions concepts
 titleSuffix: Azure Cognitive Search
-description: Debug Sessions, accessed through the Azure portal, provides an IDE-like environment where you can identify and fix errors, validate changes, and push changes to skillsets in the AI enrichment pipeline. Debug Sessions is a preview feature.
+description: Debug Sessions, accessed through the Azure portal, provides an IDE-like environment where you can identify and fix errors, validate changes, and push changes to skillsets in an enrichment pipeline.
 
 manager: nitinme
 author: HeidiSteen
 ms.author: heidist
 ms.service: cognitive-search
 ms.topic: conceptual
-ms.date: 12/30/2021
+ms.date: 06/15/2022
 ---
 
 # Debug Sessions in Azure Cognitive Search
 
-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.
-
-> [!Important]
-> 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/).
+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.
 
 ## How a debug session works
 
-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. 
+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 blob container in an Azure Storage account that you provide. You can reuse the same container for all subsequent debug sessions you create. A helpful container name might be "cognitive-search-debug-sessions".
 
 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.
 
@@ -32,15 +29,15 @@ The visual editor is organized into tabs and panes. This section introduces the
 
 The **Skill Graph** provides a visual hierarchy of the skillset and its order of execution from top to bottom. Skills that are dependent upon the output of other skills are positioned lower in the graph. Skills at the same level in the hierarchy can execute in parallel. Color coded labels of skills in the graph indicate the types of skills that are being executed in the skillset (TEXT or VISION).
 
-Selecting a skill in the graph will display the details of that instance of the skill in the right pane, including it's definition, errors or warnings, and execution history. The **Skill Graph** is where you will select which skill to debug or enhance. The details pane to the right is where you edit and explore.
+Selecting a skill in the graph will display the details of that instance of the skill in the right pane, including its definition, errors or warnings, and execution history. The **Skill Graph** is where you will select which skill to debug or enhance. The details pane to the right is where you edit and explore.
 
 :::image type="content" source="media/cognitive-search-debug/skills-graph.png" alt-text="Screenshot of Skills Graph tab." border="true":::
 
 ### Skill details pane
 
 When you select an object in the **Skill Graph**, the adjacent pane provides interactive work areas in a tabbed layout. An illustration of the details pane can be found in the previous screenshot.
 
-Skill details includes the following areas:
+Skill details include the following areas:
 
 + **Skill Settings** shows a formatted version of the skill definition.
 + **Skill JSON Editor** shows the raw JSON document of the definition.
@@ -57,7 +54,7 @@ A skill can execute multiple times in a skillset for a single document. For exam
 
 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, providing a stack-trace like feature. This allows identification of the root cause of a problem that may manifest in a downstream skill. 
 
-When debugging an error with a custom skill, there is the option to generate a request for a skill invocation in the execution history.
+When you debug an error with a custom skill, there is the option to generate a request for a skill invocation in the execution history.
 
 ## AI Enrichments tab > Enriched Data Structure
 

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

@@ -8,7 +8,7 @@ author: HeidiSteen
 ms.author: heidist
 ms.service: cognitive-search
 ms.topic: how-to
-ms.date: 06/02/2022
+ms.date: 06/15/2022
 ---
 
 # Debug an Azure Cognitive Search skillset in Azure portal
@@ -17,33 +17,28 @@ Start a portal-based debug session to identify and resolve errors, validate chan
 
 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're 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).
 
-> [!Important]
-> Debug sessions is a preview portal feature, provided under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
-
 ## Prerequisites
 
 + An existing enrichment pipeline, including a data source, a skillset, an indexer, and an index. 
 
-+ You must have at least **Contributor** role over the Search service, to be able to run Debug Sessions.
++ A **Contributor** role assignment in the Search service.
 
 + An Azure Storage account, used to save session state.
 
-+ You must have at least **Storage Blob Data Contributor** role assgined over the Storage account. 
-
-+ If the Azure Storage account has configured a firewall, you must configure it to [provide access to the Search service](search-indexer-howto-access-ip-restricted.md).
++ A **Storage Blob Data Contributor** role assignment in Azure Storage. 
 
++ If the Azure Storage account is behind a firewall, configure it to [allow Search service access](search-indexer-howto-access-ip-restricted.md).
 
 ## Limitations
 
 A Debug Session works with all generally available [indexer data sources](search-data-sources-gallery.md) and most preview data sources. The following list notes the exceptions:
 
 + The MongoDB API (preview) of Cosmos DB is currently not supported.
 
-+ For the SQL API of Cosmos DB, if a row fails during index and there is no corresponding metadata, the debug session might not pick the correct row.
++ For the SQL API of Cosmos DB, if a row fails during index and there's no corresponding metadata, the debug session might not pick the correct row.
 
 + For the SQL API of Cosmos DB, if a partitioned collection was previously non-partitioned, a Debug Session won't find the document.
 
-
 ## Create a debug session
 
 1. [Sign in to Azure portal](https://portal.azure.com) and find your search service.
@@ -164,7 +159,7 @@ Custom skills can be more challenging to debug because the code runs externally.
     ```
 
     > [!NOTE]
-    > By default, Azure Functions are exposed on 7071. Other tools and configurations might require that you provide a different port.
+    > By default, Azure functions are exposed on 7071. Other tools and configurations might require that you provide a different port.
 
 1. When ngrok starts, copy and save the public forwarding URL for the next step. The forwarding URL is randomly generated.
 
@@ -176,20 +171,13 @@ Within the debug session, modify your Custom Web API Skill URI to call the ngrok
 
 You can edit the skill definition in the portal.
 
-### Test
+### Test your code
 
 At this point, new requests from your debug session should now be sent to your local Azure Function. You can use breakpoints in your Visual Studio code to debug your code or run step by step.
 
-
-## Expected behaviors
-
-+ If debugging for a CosmosDB SQL data source, if the CosmosDB SQL collection was previously non-partitioned, and then it was changed to a partitioned collection on the CosmosDB end, Debug Sessions won't be able to pick up the correct document from CosmosDB.
-+ CosmosDB SQL errors omit some metadata about what row failed, so in some cases, Debug Sessions won’t pick the correct row.
-
-
 ## Next steps
 
 Now that you understand the layout and capabilities of the Debug Sessions visual editor, try the tutorial for a hands-on experience.
 
 > [!div class="nextstepaction"]
-> [Tutorial: Explore Debug sessions](./cognitive-search-tutorial-debug-sessions.md)
+> [Tutorial: Explore Debug sessions](./cognitive-search-tutorial-debug-sessions.md)

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

@@ -1,15 +1,15 @@
 ---
 title: 'Tutorial: Debug skillsets'
 titleSuffix: Azure Cognitive Search
-description: Debug sessions (preview) is an Azure portal tool used to find, diagnose, and repair problems in a skillset.
+description: Debug sessions is an Azure portal tool used to find, diagnose, and repair problems in a skillset.
 
 author: HeidiSteen
 ms.author: heidist
 manager: nitinme
 
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 12/31/2021
+ms.date: 06/15/2022
 ---
 
 # Tutorial: Debug a skillset using Debug Sessions
@@ -20,10 +20,6 @@ Skillsets coordinate a series of actions that analyze or transform content, wher
 
 In this article, you'll use **Debug sessions** to find and fix missing inputs and outputs. The tutorial is all-inclusive. It provides sample data, a Postman collection that creates objects, and instructions for debugging problems in the skillset.
 
-> [!Important]
-> Debug sessions is a preview feature provided under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
->
-
 ## Prerequisites
 
 Before you begin, have the following prerequisites in place:
@@ -224,15 +220,15 @@ There are two ways to research this error. The first is to look at where the inp
 
 1. Still in the **Enriched Data Structure**, open the Expression Evaluator **</>** for the "language" node and copy the expression `/document/language`.
 
-1. In the right pane, select **Skill Settings** for the #1 skill and open the Expression Evaluator **</>** for the input "languageCode."
+1. In the right pane, select **Skill Settings** for the #1 skill and open the Expression Evaluator **</>** for the input "languageCode".
 
 1. Paste the new value, `/document/language` into the Expression box and click **Evaluate**. It should display the correct input "en".
 
 1. Select **Save**.
 
-1. Select **Run**. 
+1. Select **Run**.
 
-After the debug session execution completes, check the Errors/Warnings tab and it will show that all of the input warnings are gone. There now remains just the two warnings about output fields for organizations and locations.
+After the debug session execution completes, check the Errors/Warnings tab and it will show that all of the input warnings are gone. There now remain just the two warnings about output fields for organizations and locations.
 
 ## Fix missing skill output values
 

articles/search/search-api-preview.md

@@ -8,13 +8,14 @@ author: HeidiSteen
 ms.author: heidist
 ms.service: cognitive-search
 ms.topic: conceptual
-ms.date: 05/27/2022
+ms.date: 06/15/2022
 ---
+
 # Preview features in Azure Cognitive Search
 
-This article is a comprehensive list of all features that are in public preview. Preview functionality is provided without a service level agreement, and is not recommended for production workloads. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
+This article is a comprehensive list of all features that are in public preview. Preview functionality is provided under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/), without a service level agreement, and isn't recommended for production workloads.
 
-Preview features that transition to general availability are removed from this list. If a feature isn't listed below, you can assume it is generally available. For announcements regarding general availability, see [Service Updates](https://azure.microsoft.com/updates/?product=search) or [What's New](whats-new.md).
+Preview features that transition to general availability are removed from this list. If a feature isn't listed below, you can assume it's generally available or retired. For announcements regarding general availability, see [Service Updates](https://azure.microsoft.com/updates/?product=search) or [What's New](whats-new.md).
 
 |Feature                          | Category | Description | Availability  |
 |---------|------------------|-------------|---------------|
@@ -33,7 +34,6 @@ Preview features that transition to general availability are removed from this l
 | [**featuresMode parameter**](/rest/api/searchservice/preview-api/search-documents#query-parameters) | Relevance (scoring) | Relevance score expansion to include details: per field similarity score, per field term frequency, and per field number of unique tokens matched. You can consume these data points in [custom scoring solutions](https://github.com/Azure-Samples/search-ranking-tutorial). | Add this query parameter using [Search Documents](/rest/api/searchservice/preview-api/search-documents), API versions 2021-04-30-Preview, 2020-06-30-Preview, or 2019-05-06-Preview. |
 | [**Azure Machine Learning (AML) skill**](cognitive-search-aml-skill.md) | AI enrichment (skills) | A new skill type to integrate an inferencing endpoint from Azure Machine Learning. Get started with [this tutorial](cognitive-search-tutorial-aml-custom-skill.md). | Use [Search Preview REST API](/rest/api/searchservice/), API versions 2021-04-30-Preview, 2020-06-30-Preview, or 2019-05-06-Preview. Also available in the portal, in skillset design, assuming Cognitive Search and Azure ML services are deployed in the same subscription. |
 | [**Incremental enrichment**](cognitive-search-incremental-indexing-conceptual.md) | AI enrichment (skills) | Adds caching to an enrichment pipeline, allowing you to reuse existing output if a targeted modification, such as an update to a skillset or another object, does not change the content. Caching applies only to enriched documents produced by a skillset.| Add this configuration setting using [Create or Update Indexer Preview REST API](/rest/api/searchservice/create-indexer), API versions 2021-04-30-Preview, 2020-06-30-Preview, or 2019-05-06-Preview. |
-| [**Debug Sessions**](cognitive-search-debug-session.md) | Portal, AI enrichment (skills) | An in-session skillset editor used to investigate and resolve issues with a skillset. Fixes applied during a debug session can be saved to a skillset in the service. | Portal only, using mid-page links on the Overview page to open a debug session. |
 | [**moreLikeThis**](search-more-like-this.md) | Query | Finds documents that are relevant to a specific document. This feature has been in earlier previews. | Add this query parameter in [Search Documents Preview REST API](/rest/api/searchservice/search-documents) calls, with API versions 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview, 2016-09-01-Preview, or 2017-11-11-Preview. |
 
 ## How to call a preview REST API

articles/search/search-sku-manage-costs.md

@@ -52,7 +52,7 @@ There is no meter on the number of queries, query responses, or documents ingest
 
 Data traffic might also incur networking costs. See the [Bandwidth pricing](https://azure.microsoft.com/pricing/details/bandwidth/).
 
-Several premium features ([Knowledge store](knowledge-store-concept-intro.md), [Debug Sessions](cognitive-search-debug-session.md), [Enrichment cache (preview)](cognitive-search-incremental-indexing-conceptual.md)) have a dependency on Azure Storage. The meters for Azure Storage apply in this case, and the associated storage costs of using these features will be included in the Azure Storage bill.
+Several premium features such as [knowledge store](knowledge-store-concept-intro.md), [Debug Sessions](cognitive-search-debug-session.md), and [enrichment cache](cognitive-search-incremental-indexing-conceptual.md) have a dependency on Azure Storage. The meters for Azure Storage apply in this case, and the associated storage costs of using these features will be included in the Azure Storage bill.
 
 [Customer-managed keys](search-security-manage-encryption-keys.md) provide double encryption of sensitive content. This feature requires a billable [Azure Key Vault](https://azure.microsoft.com/pricing/details/key-vault/)).
 

articles/search/whats-new.md

@@ -7,16 +7,23 @@ author: HeidiSteen
 ms.author: heidist
 ms.service: cognitive-search
 ms.topic: overview
-ms.date: 06/07/2022
+ms.date: 06/15/2022
 ms.custom: references_regions 
 ---
+
 # What's new in Azure Cognitive Search
 
 Learn what's new in the service. Bookmark this page to keep up to date with service updates. 
 
 * [**Preview features**](search-api-preview.md) is a list of current features that haven't been approved for production workloads.
 * [**Previous versions**](/previous-versions/azure/search/) is an archive of earlier feature announcements.
 
+## June 2022
+
+|Feature                          |  Description | Availability  |
+|------------------------------------|--------------|---------------|
+| [Debug Sessions](cognitive-search-debug-session.md) | Debug sessions, a built-in editor that runs in Azure portal, is now generally available.   | Generally available. |
+
 ## May 2022
 
 |Feature                          |  Description | Availability  |