Skip to content

Commit b9796fe

Browse files
committed
addressed more acorlinx issues for Correctness
1 parent 1e18203 commit b9796fe

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Results are tabular, composed of fields of either all "retrievable" fields, or l
3232

3333
You can choose which fields are in search results. While a search document might have a large number of fields, typically only a few are needed to represent each document in results. On a query request, append `$select=<field list>` to specify which "retrievable" fields should appear in the response.
3434

35-
Pick fields that offer contrast and differentiation among documents, providing sufficient information to invite a click-through response on the part of the user. On an e-commerce site, it might be a product name, description, brand, color, size, price, and rating. For the built-in hotels-sample index, it might be the "select" fields in the following example:
35+
Pick fields that offer contrast and differentiation among documents, providing sufficient information to invite a clickthrough response on the part of the user. On an e-commerce site, it might be a product name, description, brand, color, size, price, and rating. For the built-in hotels-sample index, it might be the "select" fields in the following example:
3636

3737
```http
3838
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
@@ -55,7 +55,7 @@ Occasionally, query output isn't what you're expecting to see. For example, you
5555

5656
The count parameter returns the number of documents in the index that are considered a match for the query. To return the count, add **`$count=true`** to the query request. There's no maximum value imposed by the search service. Depending on your query and the content of your documents, the count could be as high as every document in the index.
5757

58-
Count is accurate when the index is stable. If the system is actively adding, updating, or deleting documents, the count will be approximate, excluding any documents that aren't fully indexed.
58+
Count is accurate when the index is stable. If the system is actively adding, updating, or deleting documents, the count is approximate, excluding any documents that aren't fully indexed.
5959

6060
Count won't be affected by routine maintenance or other workloads on the search service. However if you have multiple partitions and a single replica, you could experience short-term fluctuations in document count (several minutes) as the partitions are restarted.
6161

@@ -70,7 +70,7 @@ By default, the search engine returns up to the first 50 matches. The top 50 are
7070

7171
The upper limit is 1,000 documents returned per page of search results, so you can set top to return up to 1000 document in the first result. In newer preview APIs, if you're using a hybrid query, you can [specify maxTextRecallSize](hybrid-search-how-to-query.md#set-maxtextrecallsize-and-countandfacetmode-preview) to return up to 10,000 documents.
7272

73-
To control the paging of all documents returned in a result set, add `$top` and `$skip` parameters to the GET query request, or `top` and `skip` to the POST query request. The following list explains the logic.
73+
To control the paging of all documents returned in a result set, add `$top` and `$skip` parameters to a GET request, or `top` and `skip` to a POST request. The following list explains the logic.
7474

7575
+ Return the first set of 15 matching documents plus a count of total matches: `GET /indexes/<INDEX-NAME>/docs?search=<QUERY STRING>&$top=15&$skip=0&$count=true`
7676

@@ -120,15 +120,15 @@ In this workaround, sort and filter are applied to a document ID field or anothe
120120
}
121121
```
122122
123-
1. Choose the last result returned by the search query. An example result with only an "id" value is shown here.
123+
1. Choose the last result returned by the search query. An example result with only an ID value is shown here.
124124
125125
```json
126126
{
127127
"id": "50"
128128
}
129129
```
130130
131-
1. Use that "id" value in a range query to fetch the next page of results. This "id" field should have unique values, otherwise pagination may include duplicate results.
131+
1. Use that ID value in a range query to fetch the next page of results. This ID field should have unique values, otherwise pagination might include duplicate results.
132132
133133
```http
134134
POST /indexes/good-books/docs/search?api-version=2024-07-01
@@ -181,7 +181,7 @@ String fields (`Edm.String`, `Edm.ComplexType` subfields) are sorted in either [
181181
182182
+ Numeric content in string fields is sorted alphabetically (1, 10, 11, 2, 20).
183183
184-
+ Upper case strings are sorted ahead of lower case (APPLE, Apple, BANANA, Banana, apple, banana). You can assign a [text normalizer](search-normalizers.md) to preprocess the text before sorting to change this behavior. Using the lowercase tokenizer on a field will have no effect on sorting behavior because Azure AI Search sorts on a non-analyzed copy of the field.
184+
+ Upper case strings are sorted ahead of lower case (APPLE, Apple, BANANA, Banana, apple, banana). You can assign a [text normalizer](search-normalizers.md) to preprocess the text before sorting to change this behavior. Using the lowercase tokenizer on a field has no effect on sorting behavior because Azure AI Search sorts on a nonanalyzed copy of the field.
185185
186186
+ Strings that lead with diacritics appear last (Äpfel, Öffnen, Üben)
187187
@@ -193,7 +193,7 @@ Another approach that promotes order consistency is using a [custom scoring prof
193193
194194
Hit highlighting refers to text formatting (such as bold or yellow highlights) applied to matching terms in a result, making it easy to spot the match. Highlighting is useful for longer content fields, such as a description field, where the match isn't immediately obvious.
195195
196-
Notice that highlighting is applied to individual terms. There's no highlight capability for the contents of an entire field. If you want to highlight over a phrase, you'll have to provide the matching terms (or phrase) in a quote-enclosed query string. This technique is described further on in this section.
196+
Notice that highlighting is applied to individual terms. There's no highlight capability for the contents of an entire field. If you want to highlight over a phrase, you have to provide the matching terms (or phrase) in a quote-enclosed query string. This technique is described further on in this section.
197197
198198
Hit highlighting instructions are provided on the [query request](/rest/api/searchservice/documents/search-post). Queries that trigger query expansion in the engine, such as fuzzy and wildcard search, have limited support for hit highlighting.
199199
@@ -224,7 +224,7 @@ By default, Azure AI Search returns up to five highlights per field. You can adj
224224

225225
When highlighting is added to the query, the response includes an "@search.highlights" for each result so that your application code can target that structure. The list of fields specified for "highlight" are included in the response.
226226

227-
In a keyword search, each term is scanned for independently. A query for "divine secrets" will return matches on any document containing either term.
227+
In a keyword search, each term is scanned for independently. A query for "divine secrets" returns matches on any document containing either term.
228228

229229
:::image type="content" source="media/search-pagination-page-layout/highlighting-example.png" alt-text="Screenshot of highlighting over a phrase query." border="true":::
230230

articles/search/search-query-lucene-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ POST /indexes/hotel-samples-index/docs/search?api-version=2024-07-01
317317
}
318318
```
319319

320-
After boosting the term *beach*, the match on Campus Commander Hotel moves down to fifth place.
320+
After you boost the term *beach*, the match on Campus Commander Hotel moves down to fifth place.
321321

322322
```json
323323
{

articles/search/search-query-simple-examples.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,13 @@ Uniform scores of *1.0* occur when there's no rank, either because the search wa
119119

120120
## Example 2: Look up by ID
121121

122-
When returning search results in a query, a logical next step is to provide a details page that includes more fields from the document. This example shows you how to return a single document using [Get Document](/rest/api/searchservice/documents/get) by passing in the document ID.
122+
After search results are returned, a logical next step is to provide a details page that includes more fields from the document. This example shows you how to return a single document using [Get Document](/rest/api/searchservice/documents/get) by passing in the document ID.
123123

124124
```http
125125
GET /indexes/hotels-sample-index/docs/41?api-version=2024-07-01
126126
```
127127

128-
All documents have a unique identifier. If you're using the portal, select the index from the **Indexes** tab and then look at the field definitions to determine which field is the key. Using REST, the [Get Index](/rest/api/searchservice/indexes/get) call returns the index definition in the response body.
128+
All documents have a unique identifier. If you're using the portal, select the index from the **Indexes** tab and then look at the field definitions to determine which field is the key. In the REST API, the [GET Index](/rest/api/searchservice/indexes/get) call returns the index definition in the response body.
129129

130130
The response for the preceding query consists of the document whose key is *41*. Any field that is marked as *retrievable* in the index definition can be returned in search results and rendered in your app.
131131

@@ -169,7 +169,7 @@ The response for the preceding query consists of the document whose key is *41*.
169169

170170
## Example 3: Filter on text
171171

172-
[Filter syntax](search-query-odata-filter.md) is an OData expression that you can use by itself or with `search`. Used together, `filter` is applied first to the entire index, and then the search is performed on the results of the filter. Filters can therefore be a useful technique to improve query performance since they reduce the set of documents that the search query needs to process.
172+
[Filter syntax](search-query-odata-filter.md) is an OData expression that you can use by itself or with `search`. When used together in the same request, `filter` is applied first to the entire index, and then the `search` is performed on the results of the filter. Filters can therefore be a useful technique to improve query performance since they reduce the set of documents that the search query needs to process.
173173

174174
Filters can be defined on any field marked as `filterable` in the index definition. For hotels-sample-index, filterable fields include *Category*, *Tags*, *ParkingIncluded*, *Rating*, and most *Address* fields.
175175

@@ -414,7 +414,7 @@ In a Boolean search, consider adding the `searchMode` parameter as a mechanism f
414414

415415
In the context of a Boolean search, the default `"searchMode": "any"` can be confusing if you're stacking a query with multiple operators and getting broader instead of narrower results. This is particularly true with NOT, where results include all documents *not containing* a specific term or phrase.
416416

417-
The following example provides an illustration. The query looks for matches on *restaurant* that exclude the phrase *air conditioning*. Running the following query with searchMode (any), 43 documents are returned: those containing the term *restaurant*, plus all documents that *don't* have the phrase *air conditioning.
417+
The following example provides an illustration. The query looks for matches on *restaurant* that exclude the phrase *air conditioning*. If you run the following query with searchMode (any), 43 documents are returned: those containing the term *restaurant*, plus all documents that *don't* have the phrase *air conditioning.
418418

419419
Notice that there's no space between the boolean operator (`-`) and the phrase *air conditioning*. The quotation marks are escaped (`\"`).
420420

0 commit comments

Comments
 (0)