Use Search explorer in the Azure portal for querying documents in Azure Cognitive Search

This article shows you how to query an existing Azure Cognitive Search index using Search explorer in the Azure portal. You can start Search explorer from the command bar to submit simple or full Lucene query expressions to any existing index in your service.

Search explorer command in portal

Basic search strings

The following examples assume the built-in real estate sample index. You can create this index using the Import data wizard in the portal, choosing Samples as the data source.

For a first look at your content, execute an empty search by clicking Search with no terms provided. An empty search is useful as a first query because it returns entire documents so that you can review document composition. On an empty search, there is no search rank and documents are returned in arbitrary order ("@search.score": 1 for all documents). By default, 50 documents are returned in a search request.

Equivalent syntax for an empty search is * or search=*.

search=*

Results

Empty query example

Free-form queries, with or without operators, are useful for simulating user-defined queries sent from a custom app to Azure Cognitive Search. Notice that when you provide query terms or expressions, search rank comes into play. The following example illustrates a free text search.

Seattle apartment "Lake Washington" miele OR thermador appliance

Results

You can use Ctrl-F to search within results for specific terms of interest.

Free text query example

Example 3 - count of matching documents

Add $count to get the number of matches found in an index. On an empty search, count is the total number of documents in the index. On a qualified search, it's the number of documents matching the query input.

$count=true

Results

Count of documents example

Example 4 - restrict fields in search results

Add $select to limit results to the explicitly named fields for more readable output in Search explorer. To keep the search string and $count=true, prefix arguments with &.

search=seattle condo&$select=listingId,beds,baths,description,street,city,price&$count=true

Results

Limit fields example

Example 5 - return next batch of results

Azure Cognitive Search returns the top 50 matches based on the search rank. To get the next set of matching documents, append $top=100,&$skip=50 to increase the result set to 100 documents (default is 50, maximum is 1000), skipping the first 50 documents. Recall that you need to provide search criteria, such as a query term or expression, to get ranked results. Notice that search scores decrease the deeper you reach into search results.

search=seattle condo&$select=listingId,beds,baths,description,street,city,price&$count=true&$top=100&$skip=50

Results

Batch search results

Filter expressions (greater than, less than, equal to)

Use the $filter parameter when you want to specify precise criteria rather than free text search. This example searches for bedrooms greater than 3:

search=seattle condo&$filter=beds gt 3&$count=true

Results

Filter expression

Order-by expressions

Add $orderby to sort results by another field besides search score. An example expression you can use to test this out is:

search=seattle condo&$select=listingId,beds,price&$filter=beds gt 3&$count=true&$orderby=price asc

Results

Orderby expression

Both $filter and $orderby expressions are OData constructions. For more information, see Filter OData syntax.

How to start Search explorer

  1. In the Azure portal, open the search service page from the dashboard or find your service in the service list.

  2. In the service overview page, click Search explorer.

    Search explorer command in portal

  3. Select the index to query.

    Select the index to query

  4. Optionally, set the API version. By default, the current generally available API version is selected, but you can choose a preview or older API if the syntax you want to use is version-specific.

  5. Once the index and API version is selected, enter search terms or fully qualified query expressions in the search bar and click Search to execute.

    Enter search terms and click Search

Tips for searching in Search explorer:

  • Results are returned as verbose JSON documents so that you can view document construction and content, in entirety. You can use query expressions, shown in the examples, to limit which fields are returned.

  • Documents are composed of all fields marked as Retrievable in the index. To view index attributes in the portal, click realestate-us-sample in the Indexes list on the search overview page.

  • Free-form queries, similar to what you might enter in a commercial web browser, are useful for testing an end-user experience. For example, assuming the built-in realestate sample index, you could enter "Seattle apartments lake washington", and then you can use Ctrl-F to find terms within the search results.

  • Query and filter expressions must be articulated in a syntax supported by Azure Cognitive Search. The default is a simple syntax, but you can optionally use full Lucene for more powerful queries. Filter expressions are an OData syntax.

Next steps

The following resources provide additional query syntax information and examples.