Skip to content

Commit 3802df8

Browse files
committed
more formatting fixes
1 parent 6108058 commit 3802df8

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ A few query capabilities bypass relevance scoring, which makes them incompatible
5353

5454
By default, queries don't use semantic ranking. To use semantic ranking, two different parameters may be used. Each parameter supports a different set of scenarios:
5555

56-
1. Specify `queryType` as `"semantic"`:
56+
1. Set `queryType` to `semantic`:
5757
+ [Text search](search-lucene-query-architecture.md) with a simple plain text query. Empty queries result in no semantic ranking being applied to the results.
5858
+ [Hybrid search](hybrid-search-overview.md).
5959
+ [Simple](query-simple-syntax.md) or [full](query-lucene-syntax.md) syntax can't be used.
@@ -67,10 +67,10 @@ The following table illustrates the supported scenarios depending on which seman
6767

6868
| Semantic Ranker Parameter | Plain text search | [Simple text search syntax](query-simple-syntax.md) | [Full text search syntax](query-lucene-syntax.md) | [Vector search](vector-search-overview.md) | [Hybrid Search](hybrid-search-overview.md) | [Semantic answers](semantic-answers.md) and captions |
6969
|-|-|-|-|-|-|-|
70-
| Set "queryType" to "semantic" |||||||
71-
| Set "semanticQuery"<sup>1</sup> |||||||
70+
| Set `queryType` to `semantic` |||||||
71+
| Set `semanticQuery`<sup>1</sup> |||||||
7272

73-
<sup>1</sup> "semanticQuery" isn't supported in the portal [search explorer](search-explorer.md).
73+
<sup>1</sup> `semanticQuery` isn't supported in the portal [search explorer](search-explorer.md).
7474

7575
Regardless of the parameter chosen, the index should contain text fields with rich semantic content and a [semantic configuration](semantic-how-to-configure.md).
7676

@@ -88,7 +88,7 @@ Regardless of the parameter chosen, the index should contain text fields with ri
8888

8989
1. Enter a query, such as "historic hotel with good food", and select **Search**.
9090

91-
1. Alternatively, select **JSON view** and paste definitions into the query editor. The portal doesn't support using `"semanticQuery"`, so setting `"queryType"` to `"semantic"` is required:
91+
1. Alternatively, select **JSON view** and paste definitions into the query editor. The portal doesn't support using `semanticQuery`, so setting `queryType` to `"semantic"` is required:
9292

9393
:::image type="content" source="./media/semantic-search-overview/semantic-portal-json-query.png" alt-text="Screenshot showing JSON query syntax in the Azure portal." border="true":::
9494

@@ -112,11 +112,11 @@ Regardless of the parameter chosen, the index should contain text fields with ri
112112

113113
Use [Search Documents](/rest/api/searchservice/documents/search-post) to formulate the request.
114114

115-
A response includes an `@search.rerankerScore` automatically. If you want captions or answers in the response, enable semantic ranking by setting `"queryType"` to `"semantic"` or setting ``"semanticQuery"` and adding captions and answers to the request
115+
A response includes an `@search.rerankerScore` automatically. If you want captions or answers in the response, enable semantic ranking by setting `queryType` to `semantic` or setting `semanticQuery` and adding captions and answers to the request.
116116

117117
The following example in this section uses the [hotels-sample-index](search-get-started-portal.md) to demonstrate semantic ranking with semantic answers and captions.
118118

119-
If you want to set `"queryType"` to `"semantic"`, paste the following request into a web client as a template. Replace `search-service-name` with your search service name and replace `hotels-sample-index` if you have a different index name.
119+
If you want to set `queryType` to `semantic`, paste the following request into a web client as a template. Replace `search-service-name` with your search service name and replace `hotels-sample-index` if you have a different index name.
120120

121121
```http
122122
POST https://[search-service-name].search.windows.net/indexes/hotels-sample-index/docs/search?api-version=2024-07-01
@@ -133,25 +133,25 @@ POST https://[search-service-name].search.windows.net/indexes/hotels-sample-inde
133133
}
134134
```
135135

136-
1. Set `"queryType"` to `"semantic"`.
136+
1. Set `queryType` to `semantic`.
137137

138-
1. Set "search" to a simple plain text query. Since the "queryType" is set to semantic, [simple syntax](query-simple-syntax.md) or [full Lucene syntax](query-lucene-syntax.md) aren't supported. Supplying `*` or an empty string results in no semantic ranking being applied to the query.
138+
1. Set `search` to a simple plain text query. Since the `queryType` is set to `semantic`, [simple syntax](query-simple-syntax.md) or [full Lucene syntax](query-lucene-syntax.md) aren't supported. Supplying `*` or an empty string results in no semantic ranking being applied to the query.
139139

140-
1. Set "semanticConfiguration" to a [predefined semantic configuration](semantic-how-to-configure.md) that's embedded in your index.
140+
1. Set `semanticConfiguration` to a [predefined semantic configuration](semantic-how-to-configure.md) that's embedded in your index.
141141

142-
1. Set "answers" to specify whether [semantic answers](semantic-answers.md) are included in the result. Currently, the only valid value for this parameter is `extractive`. Answers can be configured to return a maximum of 10. The default is one. This example shows a count of three answers: `extractive|count-3`.
142+
1. Set `answers` to specify whether [semantic answers](semantic-answers.md) are included in the result. Currently, the only valid value for this parameter is `extractive`. Answers can be configured to return a maximum of 10. The default is one. This example shows a count of three answers: `extractive|count-3`.
143143

144144
Answers aren't guaranteed on every request. To get an answer, the query must look like a question and the content must include text that looks like an answer.
145145

146-
1. Set "captions" to specify whether semantic captions are included in the result. Currently, the only valid value for this parameter is `extractive`. Captions can be configured to return results with or without highlights. The default is for highlights to be returned. This example returns captions without highlights: `extractive|highlight-false`.
146+
1. Set `captions` to specify whether semantic captions are included in the result. Currently, the only valid value for this parameter is `extractive`. Captions can be configured to return results with or without highlights. The default is for highlights to be returned. This example returns captions without highlights: `extractive|highlight-false`.
147147

148148
The basis for captions and answers are the fields referenced in the "semanticConfiguration". These fields are under a combined limit in the range of 2,000 tokens or approximately 20,000 characters. If you anticipate a token count exceeding this limit, consider a [data chunking step](vector-search-how-to-chunk-documents.md) using the [Text split skill](cognitive-search-skill-textsplit.md). This approach introduces a dependency on an [AI enrichment pipeline](cognitive-search-concept-intro.md) and [indexers](search-indexer-overview.md).
149149

150-
1. Set "highlightPreTag" and "highlightPostTag" if you want to override the default highlight formatting that's applied to captions.
150+
1. Set `highlightPreTag` and `highlightPostTag` if you want to override the default highlight formatting that's applied to captions.
151151

152152
Captions apply highlight formatting over key passages in the document that summarize the response. The default is `<em>`. If you want to specify the type of formatting (for example, yellow background), you can set the highlightPreTag and highlightPostTag.
153153

154-
1. Set ["select"](search-query-odata-select.md) to specify which fields are returned in the response, and "count" to return the number of matches in the index. These parameters improve the quality of the request and readability of the response.
154+
1. Set [select](search-query-odata-select.md) to specify which fields are returned in the response, and "count" to return the number of matches in the index. These parameters improve the quality of the request and readability of the response.
155155

156156
1. Send the request to execute the query and return results.
157157

@@ -173,9 +173,9 @@ POST https://[search-service-name].search.windows.net/indexes/hotels-sample-inde
173173
}
174174
```
175175
176-
1. Set `"queryType"` to the search syntax you're using, either [simple](query-simple-syntax.md) or [full](query-lucene-syntax.md)
176+
1. Set `queryType` to the search syntax you're using, either [simple](query-simple-syntax.md) or [full](query-lucene-syntax.md)
177177
178-
1. Set `"semanticQuery"` to the simple plain text query you want to use for semantic ranking. Empty queries aren't supported.
178+
1. Set `semanticQuery` to the simple plain text query you want to use for semantic ranking. Empty queries aren't supported.
179179
180180
181181
### [**.NET SDK**](#tab/dotnet-query)
@@ -228,7 +228,7 @@ await foreach (SearchResult<Hotel> result in response.GetResultsAsync())
228228
Console.WriteLine($"Total number of search results:{count}");
229229
```
230230

231-
To use `"semanticQuery"` instead of setting `"queryType"` to `"semantic"`, the search code snippet can be replaced with the following code snippet:
231+
To use `semanticQuery` instead of setting `queryType` to `semantic`, the search code snippet can be replaced with the following code snippet:
232232

233233
```csharp
234234
SearchResults<Hotel> response = await searchClient.SearchAsync<Hotel>(

0 commit comments

Comments
 (0)