Skip to content

Commit fb08cc1

Browse files
committed
more semantic ranker fixes
1 parent 8cb1bce commit fb08cc1

17 files changed

+57
-72
lines changed

articles/search/includes/quickstarts/dotnet-semantic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Azure AI Search searches over content stored in the service. The code for upload
115115

116116
#### Search an index
117117

118-
Here's a query that invokes semantic ranking, with search options for specifying parameters:
118+
Here's a query that invokes semantic ranker, with search options for specifying parameters:
119119

120120
```csharp
121121
Console.WriteLine("Example of a semantic query.");

articles/search/includes/quickstarts/python-semantic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ for result in results:
285285

286286
In this final query, return semantic answers.
287287

288-
Semantic ranking can generate answers to a query string that has the characteristics of a question. The generated answer is extracted verbatim from your content. To get a semantic answer, the question and answer must be closely aligned, and the model must find content that clearly answers the question. If potential answers fail to meet a confidence threshold, the model doesn't return an answer. For demonstration purposes, the question in this example is designed to get a response so that you can see the syntax.
288+
Semantic ranker can generate answers to a query string that has the characteristics of a question. The generated answer is extracted verbatim from your content. To get a semantic answer, the question and answer must be closely aligned, and the model must find content that clearly answers the question. If potential answers fail to meet a confidence threshold, the model doesn't return an answer. For demonstration purposes, the question in this example is designed to get a response so that you can see the syntax.
289289

290290
```python
291291
# Run a semantic query that returns semantic answers

articles/search/search-get-started-rag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This quickstart shows you how to send queries to a Large Language Model (LLM) fo
1717

1818
- An Azure subscription. [Create one for free](https://azure.microsoft.com/free/).
1919

20-
- [Azure AI Search](search-create-service-portal.md), Basic tier or higher so that you can [enable semantic ranking](semantic-how-to-enable-disable.md). Region must be the same one used for Azure OpenAI.
20+
- [Azure AI Search](search-create-service-portal.md), Basic tier or higher so that you can [enable semantic ranker](semantic-how-to-enable-disable.md). Region must be the same one used for Azure OpenAI.
2121

2222
- [Azure OpenAI](https://aka.ms/oai/access) resource with a deployment of `gpt-35-turbo`, `gpt-4`, or equivalent model, in the same region as Azure AI Search.
2323

@@ -124,7 +124,7 @@ We recommend the hotels-sample-index, which can be created in minutes and runs o
124124

125125
1. Run the following query in [Search Explorer](search-explorer.md) to test your index: `hotels near the ocean with beach access and good views`.
126126

127-
Output should look similar to the following example. Results that are returned directly from the search engine consist of fields and their verbatim values, along with metadata like a search score and a semantic ranking score and caption if you use semantic ranking.
127+
Output should look similar to the following example. Results that are returned directly from the search engine consist of fields and their verbatim values, along with metadata like a search score and a semantic ranking score and caption if you use semantic ranker.
128128

129129
```
130130
"@search.score": 5.600783,
@@ -183,7 +183,7 @@ This section uses Visual Studio Code and Python to call the chat completion APIs
183183
AZURE_DEPLOYMENT_MODEL: str = "gpt-35-turbo"
184184
```
185185

186-
1. Run the following code to set query parameters. The query is a keyword search using semantic ranking. In a keyword search, the search engine returns up to 50 matches, but only the top 5 are provided to the model. If you can't [enable semantic ranking](semantic-how-to-enable-disable.md) on your search service, set the value to false.
186+
1. Run the following code to set query parameters. The query is a keyword search using semantic ranking. In a keyword search, the search engine returns up to 50 matches, but only the top 5 are provided to the model. If you can't [enable semantic rankersemantic-how-to-enable-disable.md) on your search service, set the value to false.
187187

188188
```python
189189
# Set query parameters for grounding the conversation on your search index

articles/search/search-get-started-semantic.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: semantic ranking'
33
titleSuffix: Azure AI Search
4-
description: Change an existing index to use semantic ranking.
4+
description: Change an existing index to use semantic ranker.
55
author: HeidiSteen
66
manager: nitinme
77
ms.author: heidist
@@ -16,9 +16,9 @@ ms.date: 03/11/2024
1616

1717
# Quickstart: Semantic ranking with .NET or Python
1818

19-
In Azure AI Search, [semantic ranking](semantic-search-overview.md) is query-side functionality that uses machine reading comprehension from Microsoft to rescore search results, promoting the most semantically relevant matches to the top of the list. Depending on the content and the query, semantic ranking can [significantly improve search relevance](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/azure-cognitive-search-outperforming-vector-search-with-hybrid/ba-p/3929167), with minimal work for the developer.
19+
In Azure AI Search, [semantic ranker](semantic-search-overview.md) is query-side functionality that uses machine reading comprehension from Microsoft to rescore search results, promoting the most semantically relevant matches to the top of the list. Depending on the content and the query, semantic ranking can [significantly improve search relevance](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/azure-cognitive-search-outperforming-vector-search-with-hybrid/ba-p/3929167), with minimal work for the developer.
2020

21-
This quickstart walks you through the index and query modifications that invoke semantic ranking.
21+
This quickstart walks you through the index and query modifications that invoke semantic ranker.
2222

2323
> [!NOTE]
2424
> Looking for an Azure AI Search solution with ChatGPT interaction? See [this demo](https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/README.md) or [this accelerator](https://github.com/Azure-Samples/chat-with-your-data-solution-accelerator) for details.
@@ -27,7 +27,7 @@ This quickstart walks you through the index and query modifications that invoke
2727

2828
+ An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/).
2929

30-
+ Azure AI Search, at Basic tier or higher, with [semantic ranking enabled](semantic-how-to-enable-disable.md).
30+
+ Azure AI Search, at Basic tier or higher, with [semantic ranker enabled](semantic-how-to-enable-disable.md).
3131

3232
+ An API key and search service endpoint. Sign in to the [Azure portal](https://portal.azure.com) and [find your search service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices).
3333

@@ -39,11 +39,11 @@ This quickstart walks you through the index and query modifications that invoke
3939

4040
## Add semantic ranking
4141

42-
To use semantic ranking, add a *semantic configuration* to a search index, and add parameters to a query. If you have an existing index, you can make these changes without having to reindex your content because there's no impact on the structure of your searchable content.
42+
To use semantic ranker, add a *semantic configuration* to a search index, and add parameters to a query. If you have an existing index, you can make these changes without having to reindex your content because there's no impact on the structure of your searchable content.
4343

4444
+ A semantic configuration sets a priority order for fields that contribute a title, keywords, and content used in semantic reranking. Field prioritization allows for faster processing.
4545

46-
+ Queries that invoke semantic ranking include parameters for query type and whether captions and answers are returned. You can add these parameters to your existing query logic. There's no conflict with other parameters.
46+
+ Queries that invoke semantic ranker include parameters for query type and whether captions and answers are returned. You can add these parameters to your existing query logic. There's no conflict with other parameters.
4747

4848
### [**.NET**](#tab/dotnet)
4949

@@ -63,7 +63,7 @@ You can find and manage resources in the portal, using the **All resources** or
6363

6464
## Next steps
6565

66-
In this quickstart, you learned how to invoke semantic ranking on an existing index. We recommend trying semantic ranking on your own indexes as a next step. However, if you want to continue with demos, visit the following link.
66+
In this quickstart, you learned how to invoke semantic ranker on an existing index. We recommend trying semantic ranker on your own indexes as a next step. However, if you want to continue with demos, visit the following link.
6767

6868
> [!div class="nextstepaction"]
6969
> [Tutorial: Add search to web apps](tutorial-csharp-overview.md)

articles/search/search-get-started-vector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
3030

3131
Most existing services support vector search. For a small subset of services created prior to January 2019, an index that contains vector fields fails on creation. In this situation, a new service must be created.
3232

33-
- Optionally, to run the query example that invokes [semantic reranking](semantic-search-overview.md), your search service must be the Basic tier or higher, with [semantic ranking enabled](semantic-how-to-enable-disable.md).
33+
- Optionally, to run the query example that invokes [semantic reranking](semantic-search-overview.md), your search service must be the Basic tier or higher, with [semantic ranker enabled](semantic-how-to-enable-disable.md).
3434

3535
- Optionally, an [Azure OpenAI](https://aka.ms/oai/access) resource with a deployment of `text-embedding-ada-002`. The source `.rest` file includes an optional step for generating new text embeddings, but we provide pregenerated embeddings so that you can omit this dependency.
3636

articles/search/search-pagination-page-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ For either algorithm, a "@search.score" equal to 1.00 indicates an unscored or u
165165
166166
### Order by the semantic reranker
167167
168-
If you're using [semantic ranking](semantic-search-overview.md), the "@search.rerankerScore" determines the sort order of your results.
168+
If you're using [semantic ranker](semantic-search-overview.md), the "@search.rerankerScore" determines the sort order of your results.
169169
170170
The "@search.rerankerScore" range is 1 to 4.00, where a higher score indicates a stronger semantic match.
171171

articles/search/search-region-support.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,30 +27,15 @@ This article identifies the cloud regions in which Azure AI Search is available.
2727
| [Azure OpenAI integration](vector-search-integrated-vectorization.md) | Refers to skills and vectorizers that make internal calls to deployed embedding and chat models on Azure OpenAI. Check [Azure OpenAI model region availability](/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability) for the most current list of regions for each embedding and chat model. Specific Azure OpenAI models are in fewer regions, so be sure to check for joint regional availability before installing.|
2828
| [Azure AI Studio integration](vector-search-integrated-vectorization-ai-studio.md) | Refers to skills and vectorizers that make internal calls to the models hosted in the model catalog. Check [Azure AI Studio region availability](/azure/ai-studio/reference/region-support) for the most current list of regions. |
2929
| [Azure AI Vision 4.0 multimodal APIs for image vectorization](search-get-started-portal-image-search.md) | Refers to skills and vectorizers that call the multimodal embedding API. Check the [Azure AI Vision region list](/azure/ai-services/computer-vision/overview-image-analysis#region-availability) for joint regional availability. |
30-
| [Semantic ranking](semantic-search-overview.md) | Takes a dependency on Microsoft-hosted models in specific regions. Regional support is noted in this article. |
31-
32-
<!-- Each cloud region noted in this article includes a column indicating support for the following features.
33-
34-
- [Semantic ranking](semantic-search-overview.md) depends on models hosted in specific regions.
35-
- [AI enrichment](cognitive-search-concept-intro.md) refers to skills and vectorizers that make internal calls to Azure AI and Azure OpenAI. Integration requires that Azure AI Search coexist with an [Azure AI multi-service account](/azure/ai-services/multi-service-resource) in the same physical region.
36-
- [Availability zones](search-reliability.md#availability-zone-support) are an Azure platform capability that divides a region's data centers into distinct physical location groups to provide high-availability, within the same region.
37-
38-
We recommend that you check [Azure AI Studio region availability](/azure/ai-studio/reference/region-support) and [Azure OpenAI model region availability](/azure/reliability/availability-zones-service-support#azure-regions-with-availability-zone-support) for the most current list of regions for those features.
39-
40-
Also, if you plan to use Azure AI Vision 4.0 multimodal APIs for image vectorization, it's available in a reduced list of regions. [Check the Azure AI Vision region list for multimodal embeddings](/azure/ai-services/computer-vision/overview-image-analysis#region-availability) and be sure to create both your Azure AI multi-service account and Azure AI Search service in one of those supported regions.
41-
42-
> [!NOTE]
43-
> Higher capacity partitions became available in selected regions starting in April 2024. A second wave of higher capacity partitions released in May 2024. Currently, there are just a few regions that *don't* offer higher capacity patitions, and those are indicated in footnotes.
44-
>
45-
> If you're using an older search service, consider creating a new search service in a supported region to benefit from more capacity at the same billing rate as before. For more information, see [Service limits](search-limits-quotas-capacity.md#service-limits) and [How to check service creation date](vector-search-index-size.md#how-to-check-service-creation-date). -->
30+
| [Semantic ranker](semantic-search-overview.md) | Takes a dependency on Microsoft-hosted models in specific regions. Regional support is noted in this article. |
4631

4732
## Azure Public regions
4833

4934
You can create an Azure AI Search resource in any of the following Azure public regions. Almost all of these regions support [higher capacity tiers](search-limits-quotas-capacity.md#service-limits). Exceptions are noted where they apply.
5035

5136
### Americas
5237

53-
| Region | AI integration | Semantic ranking | Availability zones |
38+
| Region | AI integration | Semantic ranker | Availability zones |
5439
|--|--|--|--|
5540
| Brazil South​​ ​ ||| |
5641
| Canada Central​​ ||||
@@ -71,7 +56,7 @@ You can create an Azure AI Search resource in any of the following Azure public
7156

7257
### Europe
7358

74-
| Region | AI integration | Semantic ranking | Availability zones |
59+
| Region | AI integration | Semantic ranker | Availability zones |
7560
|--|--|--|--|
7661
| North Europe​​ ||||
7762
| West Europe​​ <sup>1, 2</sup>||||
@@ -93,7 +78,7 @@ You can create an Azure AI Search resource in any of the following Azure public
9378

9479
### Middle East
9580

96-
| Region | AI integration | Semantic ranking | Availability zones |
81+
| Region | AI integration | Semantic ranker | Availability zones |
9782
|--|--|--|--|
9883
| Israel Central​ <sup>2</sup> | | ||
9984
| Qatar Central​ <sup>1, 2</sup> | | ||
@@ -105,13 +90,13 @@ You can create an Azure AI Search resource in any of the following Azure public
10590

10691
### Africa
10792

108-
| Region | AI integration | Semantic ranking | Availability zones |
93+
| Region | AI integration | Semantic ranker | Availability zones |
10994
|--|--|--|--|
11095
| South Africa North​ || ||
11196

11297
### Asia Pacific
11398

114-
| Region | AI integration | Semantic ranking | Availability zones |
99+
| Region | AI integration | Semantic ranker | Availability zones |
115100
|--|--|--|--|
116101
| Australia East​ ​ ||||
117102
| Australia Southeast​​​ | || |
@@ -131,7 +116,7 @@ You can create an Azure AI Search resource in any of the following Azure public
131116

132117
## Azure Government regions
133118

134-
| Region | AI integration | Semantic ranking | Availability zones |
119+
| Region | AI integration | Semantic ranker | Availability zones |
135120
|--|--|--|--|
136121
| Arizona ||| |
137122
| Texas | | | |
@@ -141,7 +126,7 @@ You can create an Azure AI Search resource in any of the following Azure public
141126

142127
## Azure operated by 21Vianet
143128

144-
| Region | AI integration | Semantic ranking | Availability zones |
129+
| Region | AI integration | Semantic ranker | Availability zones |
145130
|--|--|--|--|
146131
| China East | | | |
147132
| China East 2 <sup>1</sup> || | |

articles/search/semantic-answers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Within @search.answers:
128128

129129
+ **"score"** is a confidence score that reflects the strength of the answer. If there are multiple answers in the response, this score is used to determine the order. Top answers and top captions can be derived from different search documents, where the top answer originates from one document, and the top caption from another, but in general the same documents appear in the top positions within each array.
130130

131-
Answers are followed by the **"value"** array, which always includes scores, captions, and any fields that are retrievable by default. If you specified the select parameter, the "value" array is limited to the fields that you specified. See [Configure semantic ranking](semantic-how-to-configure.md) for details.
131+
Answers are followed by the **"value"** array, which always includes scores, captions, and any fields that are retrievable by default. If you specified the select parameter, the "value" array is limited to the fields that you specified. See [Configure semantic ranker](semantic-how-to-configure.md) for details.
132132

133133
## Tips for producing high-quality answers
134134

@@ -144,4 +144,4 @@ For best results, return semantic answers on a document corpus having the follow
144144

145145
+ [Semantic ranking overview](semantic-search-overview.md)
146146
+ [Configure BM25 ranking](index-ranking-similarity.md)
147-
+ [Configure semantic ranking](semantic-how-to-configure.md)
147+
+ [Configure semantic ranker](semantic-how-to-configure.md)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.topic: how-to
1313
ms.date: 08/05/2024
1414
---
1515

16-
# Configure semantic ranking and return captions in search results
16+
# Configure semantic ranker and return captions in search results
1717

1818
This article explains how to configure a search index for semantic reranking.
1919

0 commit comments

Comments
 (0)