Skip to content

Commit 0ac592f

Browse files
authored
Merge pull request #476 from HeidiSteen/heidist-fresh
[azure search] Semantic search updates per Dan Quirk
2 parents cc1f32d + d9e1db7 commit 0ac592f

7 files changed

+72
-56
lines changed

articles/search/cognitive-search-attach-cognitive-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Enrichments are billable operations. If you no longer need to call Azure AI serv
185185
186186
Key-based billing applies when API calls to Azure AI services resources exceed 20 API calls per indexer, per day.
187187
188-
The key is used for billing, but not for enrichment operations' connections. For connections, a search service [connects over the internal network](search-security-overview.md#internal-traffic) to an Azure AI services resource that's located in the [same physical region](https://azure.microsoft.com/global-infrastructure/services/?products=search). Most regions that offer Azure AI Search also offer other Azure AI services such as Language. If you attempt AI enrichment in a region that doesn't have both services, you'll see this message: "Provided key isn't a valid CognitiveServices type key for the region of your search service."
188+
The key is used for billing, but not for enrichment operations' connections. For connections, a search service [connects over the internal network](search-security-overview.md#internal-traffic) to an Azure AI services resource that's located in the [same physical region](search-region-support.md). Most regions that offer Azure AI Search also offer other Azure AI services such as Language. If you attempt AI enrichment in a region that doesn't have both services, you'll see this message: "Provided key isn't a valid CognitiveServices type key for the region of your search service."
189189
190190
Currently, billing for [built-in skills](cognitive-search-predefined-skills.md) requires a public connection from Azure AI Search to another Azure AI service. Disabling public network access breaks billing. If disabling public networks is a requirement, you can configure a [Custom Web API skill](cognitive-search-custom-skill-interface.md) implemented with an [Azure Function](cognitive-search-create-custom-skill-example.md) that supports [private endpoints](/azure/azure-functions/functions-create-vnet) and add the [Azure AI services resource to the same VNET](/azure/ai-services/cognitive-services-virtual-networks). In this way, you can call Azure AI services resource directly from the custom skill using private endpoints.
191191

articles/search/cognitive-search-concept-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ In Azure Storage, a [knowledge store](knowledge-store-concept-intro.md) can assu
106106

107107
## Availability and pricing
108108

109-
Enrichment is available in regions that have Azure AI services. You can check the availability of enrichment on the [Azure products available by region](https://azure.microsoft.com/global-infrastructure/services/?products=search) page.
109+
Enrichment is available in regions that have Azure AI services. You can check the availability of enrichment on the [regions list](search-region-support.md) page.
110110

111111
Billing follows a pay-as-you-go pricing model. The costs of using built-in skills are passed on when a multi-region Azure AI services key is specified in the skillset. There are also costs associated with image extraction, as metered by Azure AI Search. Text extraction and utility skills, however, aren't billable. For more information, see [How you're charged for Azure AI Search](search-sku-manage-costs.md#how-youre-charged-for-azure-ai-search).
112112

articles/search/search-security-manage-encryption-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Although double encryption is now available in all regions, support was rolled o
5757
+ US Gov Virginia
5858
+ US Gov Arizona
5959

60-
+ The second rollout on May 13, 2021 added encryption for temporary disks and extended CMK encryption to [all supported regions](https://azure.microsoft.com/global-infrastructure/services/?products=search#select-product).
60+
+ The second rollout on May 13, 2021 added encryption for temporary disks and extended CMK encryption to [all supported regions](search-region-support.md).
6161

6262
If you're using CMK from a service created during the first rollout and you also want CMK encryption over temporary disks, you need to create a new search service in your region of choice and redeploy your content.
6363

articles/search/semantic-how-to-configure.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: how-to
13-
ms.date: 08/05/2024
13+
ms.date: 09/24/2024
1414
---
1515

1616
# Configure semantic ranker and return captions in search results
1717

18-
This article explains how to configure a search index for semantic reranking.
19-
2018
Semantic ranking iterates over an initial result set, applying an L2 ranking methodology that promotes the most semantically relevant results to the top of the stack. You can also get semantic captions, with highlights over the most relevant terms and phrases, and [semantic answers](semantic-answers.md).
2119

20+
This article explains how to configure a search index for semantic reranking.
21+
2222
## Prerequisites
2323

24-
+ A search service on a basic tier or higher, subject to [region availability](https://azure.microsoft.com/global-infrastructure/services/?products=search).
24+
+ A search service on a Basic tier or higher, subject to [region availability](search-region-support.md).
2525

2626
+ Semantic ranker [enabled on your search service](semantic-how-to-enable-disable.md).
2727

articles/search/semantic-how-to-enable-disable.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: how-to
13-
ms.date: 02/08/2024
13+
ms.date: 09/24/2024
1414
---
1515

1616
# Enable or disable semantic ranker
1717

18-
Semantic ranker is a premium feature that's billed by usage. By default, semantic ranker is disabled on all services.
18+
Semantic ranker is a premium feature that's billed by usage. By default, semantic ranker is turned off on a new search service, but it can be enabled by anyone with **Contributor** permissions. If you don't want anyone enabling it inadvertently, you can [disable it using the REST API](#disable-semantic-ranker-using-the-rest-api).
1919

2020
## Check availability
2121

22-
Check the [Products Available by Region](https://azure.microsoft.com/global-infrastructure/services/?products=search) page on the Azure web site to see if your region is listed.
22+
Check the [regions list](search-region-support.md) to see if your region is listed.
2323

2424
## Enable semantic ranker
2525

@@ -37,7 +37,7 @@ Follow these steps to enable [semantic ranker](semantic-search-overview.md) at t
3737

3838
:::image type="content" source="media/semantic-search-overview/semantic-search-billing.png" alt-text="Screenshot of enabling semantic ranking in the Azure portal." border="true":::
3939

40-
The free plan is capped at 1,000 queries per month. After the first 1,000 queries in the free plan, you'll receive an error message letting you know you've exhausted your quota the next time you issue a semantic query. When this happens, you need to upgrade to the standard plan to continue using semantic ranking.
40+
The free plan is capped at 1,000 queries per month. After the first 1,000 queries in the free plan, an error message indicates you've exhausted your quota on the next semantic query. When quota is exhausted, you should upgrade to the standard plan to continue using semantic ranking.
4141

4242
### [**REST**](#tab/enable-rest)
4343

@@ -78,7 +78,7 @@ PATCH https://management.azure.com/subscriptions/{{subscriptionId}}/resourcegrou
7878
}
7979
```
8080

81-
To re-enable semantic ranker, rerun the above request, setting "semanticSearch" to either "free" (default) or "standard".
81+
To re-enable semantic ranker, rerun the previous request, setting "semanticSearch" to either "free" (default) or "standard".
8282

8383
## Next steps
8484

articles/search/semantic-how-to-query-request.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: how-to
13-
ms.date: 07/24/2024
13+
ms.date: 09/24/2024
1414
---
1515

1616
# Add semantic ranking to queries in Azure AI Search
1717

18-
This article explains how to invoke the semantic ranker on queries. You can apply semantic ranking to text queries, hybrid queries, and vector queries if your search documents contain string fields and the [vector query has a text representation](vector-search-how-to-query.md#query-with-integrated-vectorization).
18+
You can apply semantic ranking to text queries, hybrid queries, and vector queries if your search documents contain string fields and the [vector query has a text representation](vector-search-how-to-query.md#query-with-integrated-vectorization) in the search document.
1919

20-
Semantic ranker iterates over an initial result set, applying an L2 ranking methodology that promotes the most semantically relevant results to the top of the stack. You can also get semantic captions, with highlights over the most relevant terms and phrases, and [semantic answers](semantic-answers.md).
20+
This article explains how to invoke the semantic ranker on queries.
2121

2222
## Prerequisites
2323

24-
+ A search service, basic tier or higher, with [semantic ranker enabled](semantic-how-to-enable-disable.md).
24+
+ A search service, Basic tier or higher, with [semantic ranker enabled](semantic-how-to-enable-disable.md).
2525

2626
+ An existing search index with a [semantic configuration](semantic-how-to-configure.md) and rich text content.
2727

@@ -51,7 +51,7 @@ A few query capabilities bypass relevance scoring, which makes them incompatible
5151

5252
## Set up the query
5353

54-
In this step, add parameters to the query request. To be successful, your query should be full text search (using the `search` parameter to pass in a string), and the index should contain text fields with rich semantic content and a semantic configuration.
54+
In this step, add parameters to the query request. To be successful, your query should be full text search (using the `search` parameter to pass in a string) or a vector query, and the index should contain text fields with rich semantic content and a semantic configuration.
5555

5656
### [**Azure portal**](#tab/portal-query)
5757

@@ -189,9 +189,9 @@ Console.WriteLine($"Total number of search results:{count}");
189189

190190
## Evaluate the response
191191

192-
Only the top 50 matches from the initial results can be semantically ranked. As with all queries, a response is composed of all fields marked as retrievable, or just those fields listed in the select parameter. A response includes the original relevance score, and might also include a count, or batched results, depending on how you formulated the request.
192+
Only the top 50 matches from the initial results can be semantically ranked. As with all queries, a response is composed of all fields marked as retrievable, or just those fields listed in the `select` parameter. A response includes the original relevance score, and might also include a count, or batched results, depending on how you formulated the request.
193193

194-
In semantic ranking, the response has more elements: a new semantically ranked relevance score, an optional caption in plain text and with highlights, and an optional [answer](semantic-answers.md). If your results don't include these extra elements, then your query might be misconfigured. As a first step towards troubleshooting the problem, check the semantic configuration to ensure it's specified in both the index definition and query.
194+
In semantic ranking, the response has more elements: a new [semantically ranked relevance score](semantic-search-overview.md#how-ranking-is-scored), an optional caption in plain text and with highlights, and an optional [answer](semantic-answers.md). If your results don't include these extra elements, then your query might be misconfigured. As a first step towards troubleshooting the problem, check the semantic configuration to ensure it's specified in both the index definition and query.
195195

196196
In a client app, you can structure the search page to include a caption as the description of the match, rather than the entire contents of a specific field. This approach is useful when individual fields are too dense for the search results page.
197197

0 commit comments

Comments
 (0)