Skip to content

Commit f2880e5

Browse files
Merge pull request #231798 from HeidiSteen/heidist-refresh
[azure search] March refresh
2 parents e0b863d + c2589a4 commit f2880e5

7 files changed

+45
-36
lines changed

articles/search/search-api-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ author: HeidiSteen
88
ms.author: heidist
99
ms.service: cognitive-search
1010
ms.topic: conceptual
11-
ms.date: 03/22/2022
11+
ms.date: 03/22/2023
1212
---
1313

1414
# API versions in Azure Cognitive Search

articles/search/search-howto-index-azure-data-lake-storage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: nitinme
99

1010
ms.service: cognitive-search
1111
ms.topic: how-to
12-
ms.date: 02/11/2022
12+
ms.date: 03/22/2023
1313
---
1414

1515
# Index data from Azure Data Lake Storage Gen2
@@ -26,7 +26,7 @@ For a code sample in C#, see [Index Data Lake Gen2 using Azure AD](https://githu
2626

2727
+ [Access tiers](../storage/blobs/access-tiers-overview.md) for ADLS Gen2 include hot, cool, and archive. Only hot and cool can be accessed by search indexers.
2828

29-
+ Blobs containing text. If you have binary data, you can include [AI enrichment](cognitive-search-concept-intro.md) for image analysis. Blob content cannot exceed the [indexer limits](search-limits-quotas-capacity.md#indexer-limits) for your search service tier.
29+
+ Blobs containing text. If you have binary data, you can include [AI enrichment](cognitive-search-concept-intro.md) for image analysis. Blob content can't exceed the [indexer limits](search-limits-quotas-capacity.md#indexer-limits) for your search service tier.
3030

3131
+ Read permissions on Azure Storage. A "full access" connection string includes a key that grants access to the content, but if you're using Azure roles instead, make sure the [search service managed identity](search-howto-managed-identities-data-sources.md) has **Storage Blob Data Reader** permissions.
3232

articles/search/search-howto-index-json-blobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: heidist
99

1010
ms.service: cognitive-search
1111
ms.topic: how-to
12-
ms.date: 03/16/2022
12+
ms.date: 03/22/2023
1313
---
1414
# Index JSON blobs and files in Azure Cognitive Search
1515

articles/search/search-howto-indexing-azure-blob-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: nitinme
99

1010
ms.service: cognitive-search
1111
ms.topic: how-to
12-
ms.date: 03/30/2022
12+
ms.date: 03/30/2023
1313
---
1414

1515
# Index data from Azure Blob Storage

articles/search/search-howto-indexing-azure-tables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.author: magottei
99

1010
ms.service: cognitive-search
1111
ms.topic: how-to
12-
ms.date: 02/28/2022
12+
ms.date: 03/22/2023
1313
---
1414

1515
# Index data from Azure Table Storage
@@ -67,7 +67,7 @@ Indexers can connect to a table using the following connections.
6767
| Managed identity connection string |
6868
|------------------------------------|
6969
|`{ "connectionString" : "ResourceId=/subscriptions/<your subscription ID>/resourceGroups/<your resource group name>/providers/Microsoft.Storage/storageAccounts/<your storage account name>/;" }`|
70-
|This connection string does not require an account key, but you must have previously configured a search service to [connect using a managed identity](search-howto-managed-identities-data-sources.md).|
70+
|This connection string doesn't require an account key, but you must have previously configured a search service to [connect using a managed identity](search-howto-managed-identities-data-sources.md).|
7171

7272
| Storage account shared access signature** (SAS) connection string |
7373
|-------------------------------------------------------------------|

articles/search/search-query-create.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ author: HeidiSteen
88
ms.author: heidist
99
ms.service: cognitive-search
1010
ms.topic: conceptual
11-
ms.date: 03/16/2022
11+
ms.date: 03/22/2023
1212
---
1313

1414
# Creating queries in Azure Cognitive Search
1515

16-
If you are building a query for the first time, this article describes approaches and methods for setting up the request. It also introduces a query structure, and explains how field attributes and linguistic analyzers can impact query outcomes.
16+
If you're building a query for the first time, this article describes approaches and methods for setting up the request. It also introduces a query structure, and explains how field attributes and linguistic analyzers can impact query outcomes.
1717

1818
## What's a query request?
1919

2020
A query is a read-only request against the docs collection of a single search index. It specifies a 'search' parameter, which contains the query expression consisting of terms, quote-enclosed phrases, and operators.
2121

22-
Additional parameters on the request provide more definition to the query and response. For example, 'searchFields' scopes query execution to specific fields, 'select' specifies which fields are returned in results, and 'count' returns the number of matches found in the index.
22+
Other parameters on the request provide more definition to the query and response. For example, 'searchFields' scopes query execution to specific fields, 'select' specifies which fields are returned in results, and 'count' returns the number of matches found in the index.
2323

2424
The following example gives you a general idea of a query request by showing some of the available parameters. For more information about query composition, see [Query types and compositions](search-query-overview.md) and [Search Documents (REST)](/rest/api/searchservice/search-documents).
2525

@@ -37,17 +37,19 @@ POST https://[service name].search.windows.net/indexes/hotels-sample-index/docs/
3737

3838
## Choose a client
3939

40-
You'll need a tool like Azure portal or Postman, or code that instantiates a query client using APIs. We recommend the Azure portal or REST APIs for early development and proof-of-concept testing.
40+
For early development and proof-of-concept testing, we recommend starting with an interactive tool like Azure portal, or the Postman Desktop App for making REST API calls. With these approaches, you can test a query request in isolation and assess the effects of different properties without having to write any code.
41+
42+
To call search from within an app, we recommend the Azure.Document.Search client libraries in the Azure SDKs for .NET, Java, JavaScript, and Python.
4143

4244
### Permissions
4345

4446
A query request requires read permissions, granted via an API key passed in the header. Any operation, including query requests, will work under an [admin API key](search-security-api-keys.md), but query requests can optionally use a [query API key](search-security-api-keys.md#create-query-keys). Query API keys are strongly recommended. You can create up to 50 per service and assign different keys to different applications.
4547

46-
In Azure portal, access to tools, wizards, and objects require membership in the Contributor role or above on the service.
48+
In Azure portal, access to the built-in tools, wizards, and objects require membership in the Contributor role or higher on the search service.
4749

4850
### Use Azure portal to query an index
4951

50-
[Search explorer (portal)](search-explorer.md) is a query interface in the Azure portal that runs queries against indexes on the underlying search service. Internally, the portal makes [Search Documents](/rest/api/searchservice/search-documents) requests, but cannot invoke Autocomplete, Suggestions, or Document Lookup.
52+
[Search explorer (portal)](search-explorer.md) is a query interface in the Azure portal that runs queries against indexes on the underlying search service. Internally, the portal makes [Search Documents](/rest/api/searchservice/search-documents) requests, but can't invoke Autocomplete, Suggestions, or Document Lookup.
5153

5254
You can select any index and REST API version, including preview. A query string can use simple or full syntax, with support for all query parameters (filter, select, searchFields, and so on). In the portal, when you open an index, you can work with Search Explorer alongside the index JSON definition in side-by-side tabs for easy access to field attributes. Check what fields are searchable, sortable, filterable, and facetable while testing queries.
5355

@@ -59,7 +61,7 @@ Start with [Create a search index using REST and Postman](search-get-started-res
5961

6062
Each request is standalone, so you must provide the endpoint, index name, and API version on every request. Other properties, Content-Type and API key, are passed on the request header. For more information, see [Search Documents (REST)](/rest/api/searchservice/search-documents) for help with formulating query requests.
6163

62-
### Use an SDK
64+
### Use an Azure SDK
6365

6466
For Cognitive Search, the Azure SDKs implement generally available features. As such, you can use any of the SDKs to query an index. All of them provide a **SearchClient** that has methods to interacting with an index, from loading an index with search documents, to formulating query requests.
6567

@@ -72,7 +74,7 @@ For Cognitive Search, the Azure SDKs implement generally available features. As
7274

7375
## Choose a query type: simple | full
7476

75-
If your query is full text search, a query parser will be used to process any text that's passed as search terms and phrases. Azure Cognitive Search offers two query parsers.
77+
If your query is full text search, a query parser is used to process any text that's passed as search terms and phrases. Azure Cognitive Search offers two query parsers.
7678

7779
+ The simple parser understands the [simple query syntax](query-simple-syntax.md). This parser was selected as the default for its speed and effectiveness in free form text queries. The syntax supports common search operators (AND, OR, NOT) for term and phrase searches, and prefix (`*`) search (as in "sea*" for Seattle and Seaside). A general recommendation is to try the simple parser first, and then move on to full parser if application requirements call for more powerful queries.
7880

@@ -106,7 +108,7 @@ For field attribute definitions, see [Create Index (REST API)](/rest/api/searchs
106108

107109
During indexing, the search engine uses a text analyzer on strings to maximize the potential for finding a match at query time. At a minimum, strings are lower-cased, but depending on the analyzer, might also undergo lemmatization and stop word removal. Larger strings or compound words are typically broken up by whitespace, hyphens, or dashes, and indexed as separate tokens.
108110

109-
The point to take away here is that what you think your index contains, and what's actually in it, can be different. If queries do not return expected results, you can inspect the tokens created by the analyzer through the [Analyze Text (REST API)](/rest/api/searchservice/test-analyzer). For more information about tokenization and the impact on queries, see [Partial term search and patterns with special characters](search-query-partial-matching.md).
111+
The point to take away here's that what you think your index contains, and what's actually in it, can be different. If queries don't return expected results, you can inspect the tokens created by the analyzer through the [Analyze Text (REST API)](/rest/api/searchservice/test-analyzer). For more information about tokenization and the impact on queries, see [Partial term search and patterns with special characters](search-query-partial-matching.md).
110112

111113
## Next steps
112114

0 commit comments

Comments
 (0)