You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-modeling-multitenant-saas-applications.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ In the case of a multitenant scenario, the application developer consumes one or
80
80
81
81
In an index-per-tenant model, multiple tenants occupy a single Azure AI Search service where each tenant has their own index.
82
82
83
-
Tenants achieve data isolation because all search requests and document operations are issued at an index level in Azure AI Search. In the application layer, there's the need awareness to direct the various tenants’ traffic to the proper indexes while also managing resources at the service level across all tenants.
83
+
This approach works because all search requests and document operations are issued at an index level in Azure AI Search. In the application layer, there's the need awareness to direct the various tenants’ traffic to the proper indexes while also managing resources at the service level across all tenants.
84
84
85
85
A key attribute of the index-per-tenant model is the ability for the application developer to oversubscribe the capacity of a search service among the application’s tenants. If the tenants have an uneven distribution of workload, the optimal combination of tenants can be distributed across a search service’s indexes to accommodate a number of highly active, resource-intensive tenants while simultaneously serving a long tail of less active tenants. The trade-off is the inability of the model to handle situations where each tenant is concurrently highly active.
# OData full-text search functions in Azure AI Search - `search.ismatch` and `search.ismatchscoring`
27
17
28
-
Azure AI Search supports full-text search in the context of [OData filter expressions](query-odata-filter-orderby-syntax.md) via the `search.ismatch` and `search.ismatchscoring` functions. These functions allow you to combine full-text search with strict Boolean filtering in ways that are not possible just by using the top-level `search` parameter of the [Search API](/rest/api/searchservice/documents/search-post).
18
+
Azure AI Search supports full-text search in the context of [OData filter expressions](query-odata-filter-orderby-syntax.md) via the `search.ismatch` and `search.ismatchscoring` functions. These functions allow you to combine full-text search with strict Boolean filtering in ways that aren't possible just by using the top-level `search` parameter of the [Search API](/rest/api/searchservice/documents/search-post).
29
19
30
20
> [!NOTE]
31
-
> The `search.ismatch` and `search.ismatchscoring` functions are only supported in filters in the [Search API](/rest/api/searchservice/documents/search-post). They are not supported in the [Suggest](/rest/api/searchservice/documents/suggest-post) or [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) APIs.
21
+
> The `search.ismatch` and `search.ismatchscoring` functions are only supported in filters in the [Search API](/rest/api/searchservice/documents/search-post). They aren't supported in the [Suggest](/rest/api/searchservice/documents/suggest-post) or [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) APIs.
32
22
33
23
## Syntax
34
24
@@ -58,7 +48,7 @@ An interactive syntax diagram is also available:
58
48
59
49
### search.ismatch
60
50
61
-
The `search.ismatch` function evaluates a full-text search query as a part of a filter expression. The documents that match the search query will be returned in the result set. The following overloads of this function are available:
51
+
The `search.ismatch` function evaluates a full-text search query as a part of a filter expression. Matching documents are returned in the result set. The following overloads of this function are available:
62
52
63
53
-`search.ismatch(search)`
64
54
-`search.ismatch(search, searchFields)`
@@ -69,21 +59,20 @@ The parameters are defined in the following table:
69
59
| Parameter name | Type | Description |
70
60
| --- | --- | --- |
71
61
|`search`|`Edm.String`| The search query (in either [simple](query-simple-syntax.md) or [full](query-lucene-syntax.md) Lucene query syntax). |
72
-
|`searchFields`|`Edm.String`| Comma-separated list of searchable fields to search in; defaults to all searchable fields in the index. When using[fielded search](query-lucene-syntax.md#bkmk_fields) in the `search` parameter, the field specifiers in the Lucene query override any fields specified in this parameter. |
62
+
|`searchFields`|`Edm.String`| Comma-separated list of searchable fields to search in; defaults to all searchable fields in the index. When you use[fielded search](query-lucene-syntax.md#bkmk_fields) in the `search` parameter, the field specifiers in the Lucene query override any fields specified in this parameter. |
73
63
|`queryType`|`Edm.String`|`'simple'` or `'full'`; defaults to `'simple'`. Specifies what query language was used in the `search` parameter. |
74
-
|`searchMode`|`Edm.String`|`'any'` or `'all'`, defaults to `'any'`. Indicates whether any or all of the search terms in the `search` parameter must be matched in order to count the document as a match. When using the [Lucene Boolean operators](query-lucene-syntax.md#bkmk_boolean) in the `search` parameter, they will take precedence over this parameter. |
64
+
|`searchMode`|`Edm.String`|`'any'` or `'all'`, defaults to `'any'`. Indicates whether any or all of the search terms in the `search` parameter must be matched in order to count the document as a match. When you use the [Lucene Boolean operators](query-lucene-syntax.md#bkmk_boolean) in the `search` parameter, they take precedence over this parameter. |
75
65
76
66
All the above parameters are equivalent to the corresponding [search request parameters in the Search API](/rest/api/searchservice/documents/search-post).
77
67
78
-
The `search.ismatch` function returns a value of type `Edm.Boolean`, which allows you to compose it with other filter sub-expressions using the Boolean [logical operators](search-query-odata-logical-operators.md).
68
+
The `search.ismatch` function returns a value of type `Edm.Boolean`, which allows you to compose it with other filter subexpressions using the Boolean [logical operators](search-query-odata-logical-operators.md).
79
69
80
70
> [!NOTE]
81
-
> Azure AI Search does not support using `search.ismatch` or `search.ismatchscoring` inside lambda expressions. This means it is not possible to write filters over collections of objects that can correlate full-text search matches with strict filter matches on the same object. For more details on this limitation as well as examples, see [Troubleshooting collection filters in Azure AI Search](search-query-troubleshoot-collection-filters.md). For more in-depth information on why this limitation exists, see [Understanding collection filters in Azure AI Search](search-query-understand-collection-filters.md).
82
-
71
+
> Azure AI Search doesn't support using `search.ismatch` or `search.ismatchscoring` inside lambda expressions. This means it isn't possible to write filters over collections of objects that can correlate full-text search matches with strict filter matches on the same object. For more information on this limitation as well as examples, see [Troubleshooting collection filters in Azure AI Search](search-query-troubleshoot-collection-filters.md). For more in-depth information on why this limitation exists, see [Understanding collection filters in Azure AI Search](search-query-understand-collection-filters.md).
83
72
84
73
### search.ismatchscoring
85
74
86
-
The `search.ismatchscoring` function, like the `search.ismatch` function, returns `true` for documents that match the full-text search query passed as a parameter. The difference between them is that the relevance score of documents matching the `search.ismatchscoring` query will contribute to the overall document score, while in the case of `search.ismatch`, the document score won't be changed. The following overloads of this function are available with parameters identical to those of `search.ismatch`:
75
+
The `search.ismatchscoring` function, like the `search.ismatch` function, returns `true` for documents that match the full-text search query passed as a parameter. The difference between them is that the relevance score of documents matching the `search.ismatchscoring` query contributes to the overall document score, whereas for `search.ismatch`, the document score doesn't change. The following overloads of this function are available with parameters identical to those of `search.ismatch`:
87
76
88
77
-`search.ismatchscoring(search)`
89
78
-`search.ismatchscoring(search, searchFields)`
@@ -99,10 +88,36 @@ Find documents with the word "waterfront". This filter query is identical to a [
99
88
search.ismatchscoring('waterfront')
100
89
```
101
90
102
-
Find documents with the word "hostel" and rating greater or equal to 4, or documents with the word "motel" and rating equal to 5. Note, this request could not be expressed without the `search.ismatchscoring` function.
91
+
Here's the full query syntax for this request, which you can run in Search Explorer in the Azure portal. Output consists of matches on waterfront, water, and front.
92
+
93
+
```json
94
+
{
95
+
"search": "*",
96
+
"select": "HotelId, HotelName, Description",
97
+
"searchMode": "all",
98
+
"queryType": "simple",
99
+
"count": true,
100
+
"filter": "search.ismatchscoring('waterfront')"
101
+
}
102
+
```
103
+
104
+
Find documents with the word "pool" and rating greater or equal to 4, or documents with the word "motel" and equal to 3.2. Note, this request couldn't be expressed without the `search.ismatchscoring` function.
103
105
104
106
```odata-filter-expr
105
-
search.ismatchscoring('hostel') and Rating ge 4 or search.ismatchscoring('motel') and Rating eq 5
107
+
search.ismatchscoring('pool') and Rating ge 4 or search.ismatchscoring('motel') and Rating eq 3.2
108
+
```
109
+
110
+
Here's the full query syntax for this request for Search Explorer. Output consists of matches on hotels with pools having a rating greater than 4, *or* motels with a rating equal to 3.2.
"filter": "search.ismatchscoring('pool') and Rating ge 4 or search.ismatchscoring('motel') and Rating eq 3.2"
120
+
}
106
121
```
107
122
108
123
Find documents without the word "luxury".
@@ -111,26 +126,192 @@ Find documents without the word "luxury".
111
126
not search.ismatch('luxury')
112
127
```
113
128
114
-
Find documents with the phrase "ocean view" or rating equal to 5. The `search.ismatchscoring` query will be executed only against fields `HotelName` and `Rooms/Description`.
129
+
Here's the full query syntax for this request. Output consists of matches on the term luxury.
Documents that matched only the second clause of the disjunction will be returned too -- hotels with `Rating`equal to 5. To make it clear that those documents didn't match any of the scored parts of the expression, they will be returned with score equal to zero.
142
+
Find documents with the phrase "ocean" or rating equal to 3.2. The `search.ismatchscoring` query is executed only against fields `HotelName` and `Description`.
117
143
118
-
```odata-filter-expr
119
-
search.ismatchscoring('"ocean view"', 'Rooms/Description,HotelName') or Rating eq 5
144
+
Here's the full query syntax for this request. Documents that match only the second clause of the disjunction are returned too (specifically, hotels with `Rating` equal to `3.2`). To make it clear that those documents didn't match any of the scored parts of the expression, they're returned with score equal to zero.
"filter": "search.ismatchscoring('ocean', 'Description,HotelName') or Rating eq 3.2"
154
+
}
120
155
```
121
156
122
-
Find documents where the terms "hotel" and "airport" are within 5 words from each other in the description of the hotel, and where smoking is not allowed in at least some of the rooms. This query uses the [full Lucene query language](query-lucene-syntax.md).
157
+
Output consists of 4 matches: hotels that mention "ocean" in the Description or Hotel Name, or hotels with a rating of 3.2. Notice the search score of zero for matches on the second clause.
158
+
159
+
```json
160
+
{
161
+
"@odata.count": 4,
162
+
"value": [
163
+
{
164
+
"@search.score": 1.6076145,
165
+
"HotelId": "18",
166
+
"HotelName": "Ocean Water Resort & Spa",
167
+
"Description": "New Luxury Hotel for the vacation of a lifetime. Bay views from every room, location near the pier, rooftop pool, waterfront dining & more.",
168
+
"Rating": 4.2
169
+
},
170
+
{
171
+
"@search.score": 1.0594962,
172
+
"HotelId": "41",
173
+
"HotelName": "Windy Ocean Motel",
174
+
"Description": "Oceanfront hotel overlooking the beach features rooms with a private balcony and 2 indoor and outdoor pools. Inspired by the natural beauty of the island, each room includes an original painting of local scenes by the owner. Rooms include a mini fridge, Keurig coffee maker, and flatscreen TV. Various shops and art entertainment are on the boardwalk, just steps away.",
175
+
"Rating": 3.5
176
+
},
177
+
{
178
+
"@search.score": 0,
179
+
"HotelId": "40",
180
+
"HotelName": "Trails End Motel",
181
+
"Description": "Only 8 miles from Downtown. On-site bar/restaurant, Free hot breakfast buffet, Free wireless internet, All non-smoking hotel. Only 15 miles from airport.",
182
+
"Rating": 3.2
183
+
},
184
+
{
185
+
"@search.score": 0,
186
+
"HotelId": "26",
187
+
"HotelName": "Planetary Plaza & Suites",
188
+
"Description": "Extend Your Stay. Affordable home away from home, with amenities like free Wi-Fi, full kitchen, and convenient laundry service.",
189
+
"Rating": 3.2
190
+
}
191
+
]
192
+
}
193
+
```
194
+
195
+
Find documents where the terms "hotel" and "airport" are within 5 words from each other in the description of the hotel, and where smoking isn't allowed in at least some of the rooms.
123
196
124
197
```odata-filter-expr
125
198
search.ismatch('"hotel airport"~5', 'Description', 'full', 'any') and Rooms/any(room: not room/SmokingAllowed)
126
199
```
127
200
201
+
Here's the full query syntax. To run in Search Explorer, escape the interior quotation marks with a backslash character.
"filter": "search.ismatch('\"hotel airport\"~5', 'Description', 'full', 'any') and Rooms/any(room: not room/SmokingAllowed)"
211
+
}
212
+
```
213
+
214
+
Output consists of a single document where the terms "hotel" and "airport" are within 5 words distance. Smoking is allowed for several rooms in most hotels, including the one in this search result.
215
+
216
+
```json
217
+
{
218
+
"@odata.count": 1,
219
+
"value": [
220
+
{
221
+
"@search.score": 1,
222
+
"HotelId": "40",
223
+
"HotelName": "Trails End Motel",
224
+
"Description": "Only 8 miles from Downtown. On-site bar/restaurant, Free hot breakfast buffet, Free wireless internet, All non-smoking hotel. Only 15 miles from airport.",
225
+
"Tags": [
226
+
"bar",
227
+
"free wifi",
228
+
"restaurant"
229
+
],
230
+
"Rating": 3.2
231
+
}
232
+
]
233
+
}
234
+
```
235
+
128
236
Find documents that have a word that starts with the letters "lux" in the Description field. This query uses [prefix search](query-simple-syntax.md#prefix-queries) in combination with `search.ismatch`.
"Description": "New Luxury Hotel for the vacation of a lifetime. Bay views from every room, location near the pier, rooftop pool, waterfront dining & more.",
266
+
"Tags": [
267
+
"view",
268
+
"pool",
269
+
"restaurant"
270
+
],
271
+
"Rating": 4.2
272
+
},
273
+
{
274
+
"@search.score": 1,
275
+
"HotelId": "13",
276
+
"HotelName": "Luxury Lion Resort",
277
+
"Description": "Unmatched Luxury. Visit our downtown hotel to indulge in luxury accommodations. Moments from the stadium and transportation hubs, we feature the best in convenience and comfort.",
278
+
"Tags": [
279
+
"bar",
280
+
"concierge",
281
+
"restaurant"
282
+
],
283
+
"Rating": 4.1
284
+
},
285
+
{
286
+
"@search.score": 1,
287
+
"HotelId": "16",
288
+
"HotelName": "Double Sanctuary Resort",
289
+
"Description": "5 star Luxury Hotel - Biggest Rooms in the city. #1 Hotel in the area listed by Traveler magazine. Free WiFi, Flexible check in/out, Fitness Center & espresso in room.",
290
+
"Tags": [
291
+
"view",
292
+
"pool",
293
+
"restaurant",
294
+
"bar",
295
+
"continental breakfast"
296
+
],
297
+
"Rating": 4.2
298
+
},
299
+
{
300
+
"@search.score": 1,
301
+
"HotelId": "14",
302
+
"HotelName": "Twin Vortex Hotel",
303
+
"Description": "New experience in the making. Be the first to experience the luxury of the Twin Vortex. Reserve one of our newly-renovated guest rooms today.",
0 commit comments