SearchClient Class

Package:

com.azure.search.documents

Maven Artifact:

com.azure:azure-search-documents:11.6.0

• java.lang.Object
• • com.azure.search.documents.SearchClient

public final class SearchClient

This class provides a client that contains the operations for querying an index and uploading, merging, or deleting documents in an Azure Cognitive Search service.

Method Summary

Modifier and Type	Method and Description
T	getDocument(String key, Class<T> modelClass) Retrieves a document from the Azure Cognitive Search index.
Response<T>	getDocumentWithResponse(String key, Class<T> modelClass, List<String> selectedFields, Context context) Retrieves a document from the Azure Cognitive Search index.
AutocompletePagedIterable	autocomplete(String searchText, String suggesterName) Autocompletes incomplete query terms based on input text and matching terms in the index.
AutocompletePagedIterable	autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions, Context context) Autocompletes incomplete query terms based on input text and matching terms in the index.
IndexDocumentsResult	deleteDocuments(Iterable<?> documents) Deletes a collection of documents from the target index.
Response<IndexDocumentsResult>	deleteDocumentsWithResponse(Iterable<?> documents, IndexDocumentsOptions options, Context context) Deletes a collection of documents from the target index.
long	getDocumentCount() Queries the number of documents in the search index.
Response<Long>	getDocumentCountWithResponse(Context context) Queries the number of documents in the search index.
String	getEndpoint() Gets the endpoint for the Azure Cognitive Search service.
String	getIndexName() Gets the name of the Azure Cognitive Search index.
IndexDocumentsResult	indexDocuments(IndexDocumentsBatch<?> batch) Sends a batch of upload, merge, and/or delete actions to the search index.
Response<IndexDocumentsResult>	indexDocumentsWithResponse(IndexDocumentsBatch<?> batch, IndexDocumentsOptions options, Context context) Sends a batch of upload, merge, and/or delete actions to the search index.
IndexDocumentsResult	mergeDocuments(Iterable<?> documents) Merges a collection of documents with existing documents in the target index.
Response<IndexDocumentsResult>	mergeDocumentsWithResponse(Iterable<?> documents, IndexDocumentsOptions options, Context context) Merges a collection of documents with existing documents in the target index.
IndexDocumentsResult	mergeOrUploadDocuments(Iterable<?> documents) This action behaves like merge if a document with the given key already exists in the index.
Response<IndexDocumentsResult>	mergeOrUploadDocumentsWithResponse(Iterable<?> documents, IndexDocumentsOptions options, Context context) This action behaves like merge if a document with the given key already exists in the index.
SearchPagedIterable	search(String searchText) Searches for documents in the Azure Cognitive Search index.
SearchPagedIterable	search(String searchText, SearchOptions searchOptions, Context context) Searches for documents in the Azure Cognitive Search index.
SuggestPagedIterable	suggest(String searchText, String suggesterName) Suggests documents in the index that match the given partial query.
SuggestPagedIterable	suggest(String searchText, String suggesterName, SuggestOptions suggestOptions, Context context) Suggests documents in the index that match the given partial query.
IndexDocumentsResult	uploadDocuments(Iterable<?> documents) Uploads a collection of documents to the target index.
Response<IndexDocumentsResult>	uploadDocumentsWithResponse(Iterable<?> documents, IndexDocumentsOptions options, Context context) Uploads a collection of documents to the target index.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

getDocument

public T getDocument(String key, Class modelClass)

Retrieves a document from the Azure Cognitive Search index.

View naming rules for guidelines on constructing valid document keys.

Code Sample

Get dynamic SearchDocument.

SearchDocument result = SEARCH_CLIENT.getDocument("hotelId", SearchDocument.class);
 for (Map.Entry<String, Object> keyValuePair : result.entrySet()) {
     System.out.printf("Document key %s, Document value %s", keyValuePair.getKey(), keyValuePair.getValue());
 }

Parameters:

key - The key of the document to retrieve.

modelClass - The model class converts to.

Returns:

document object

getDocumentWithResponse

public Response getDocumentWithResponse(String key, Class modelClass, List selectedFields, Context context)

Retrieves a document from the Azure Cognitive Search index.

View naming rules for guidelines on constructing valid document keys.

Code Sample

Get dynamic SearchDocument.

Response<SearchDocument> resultResponse = SEARCH_CLIENT.getDocumentWithResponse("hotelId",
     SearchDocument.class, null, new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + resultResponse.getStatusCode());
 for (Map.Entry<String, Object> keyValuePair : resultResponse.getValue().entrySet()) {
     System.out.printf("Document key %s, Document value %s", keyValuePair.getKey(), keyValuePair.getValue());
 }

Parameters:

key - The key of the document to retrieve.

modelClass - The model class converts to.

selectedFields - List of field names to retrieve for the document; Any field not retrieved will have null or default as its corresponding property value in the returned object.

context - additional context that is passed through the Http pipeline during the service call

Returns:

response containing a document object

autocomplete

public AutocompletePagedIterable autocomplete(String searchText, String suggesterName)

Autocompletes incomplete query terms based on input text and matching terms in the index.

Code Sample

Autocomplete text from documents in service.

AutocompletePagedIterable autocompletePagedIterable = SEARCH_CLIENT.autocomplete("searchText", "sg");
 for (AutocompleteItem result: autocompletePagedIterable) {
     System.out.printf("The complete term is %s", result.getText());
 }

Parameters:

searchText - search text

suggesterName - suggester name

Returns:

auto complete result.

autocomplete

public AutocompletePagedIterable autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions, Context context)

Autocompletes incomplete query terms based on input text and matching terms in the index.

Code Sample

Autocomplete text from documents in service with option.

AutocompletePagedIterable autocompletePagedIterable = SEARCH_CLIENT.autocomplete("searchText", "sg",
     new AutocompleteOptions().setAutocompleteMode(AutocompleteMode.ONE_TERM_WITH_CONTEXT),
     new Context(KEY_1, VALUE_1));
 for (AutocompleteItem result: autocompletePagedIterable) {
     System.out.printf("The complete term is %s", result.getText());
 }

Parameters:

searchText - search text

suggesterName - suggester name

autocompleteOptions - autocomplete options

context - additional context that is passed through the HTTP pipeline during the service call

Returns:

auto complete result.

deleteDocuments

public IndexDocumentsResult deleteDocuments(Iterable documents)

Deletes a collection of documents from the target index.

Code Sample

Delete dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelId", "1");
 searchDocument.put("hotelName", "test");
 IndexDocumentsResult result = SEARCH_CLIENT.deleteDocuments(Collections.singletonList(searchDocument));
 for (IndexingResult indexingResult : result.getResults()) {
     System.out.printf("Does document with key %s delete successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to delete from the target Index. Fields other than the key are ignored.

Returns:

document index result.

deleteDocumentsWithResponse

public Response deleteDocumentsWithResponse(Iterable documents, IndexDocumentsOptions options, Context context)

Deletes a collection of documents from the target index.

Code Sample

Delete dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelId", "1");
 searchDocument.put("hotelName", "test");
 Response<IndexDocumentsResult> resultResponse = SEARCH_CLIENT.deleteDocumentsWithResponse(
     Collections.singletonList(searchDocument), null, new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + resultResponse.getStatusCode());
 for (IndexingResult indexingResult : resultResponse.getValue().getResults()) {
     System.out.printf("Does document with key %s delete successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to delete from the target Index. Fields other than the key are ignored.

options - Options that allow specifying document indexing behavior.

context - additional context that is passed through the Http pipeline during the service call

Returns:

response containing a document index result.

getDocumentCount

public long getDocumentCount()

Queries the number of documents in the search index.

Code Sample

Get document count.

long count = SEARCH_CLIENT.getDocumentCount();
 System.out.printf("There are %d documents in service.", count);

Returns:

the number of documents.

getDocumentCountWithResponse

public Response getDocumentCountWithResponse(Context context)

Queries the number of documents in the search index.

Code Sample

Get document count.

Response<Long> countResponse = SEARCH_CLIENT.getDocumentCountWithResponse(new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + countResponse.getStatusCode());
 System.out.printf("There are %d documents in service.", countResponse.getValue());

Parameters:

context - additional context that is passed through the Http pipeline during the service call

Returns:

response containing the number of documents.

getEndpoint

public String getEndpoint()

Gets the endpoint for the Azure Cognitive Search service.

Returns:

the endpoint value.

getIndexName

public String getIndexName()

Gets the name of the Azure Cognitive Search index.

Returns:

the indexName value.

indexDocuments

public IndexDocumentsResult indexDocuments(IndexDocumentsBatch batch)

Sends a batch of upload, merge, and/or delete actions to the search index.

Code Sample

Index batch operation on dynamic SearchDocument.

SearchDocument searchDocument1 = new SearchDocument();
 searchDocument1.put("hotelId", "1");
 searchDocument1.put("hotelName", "test1");
 SearchDocument searchDocument2 = new SearchDocument();
 searchDocument2.put("hotelId", "2");
 searchDocument2.put("hotelName", "test2");
 IndexDocumentsBatch<SearchDocument> indexDocumentsBatch = new IndexDocumentsBatch<>();
 indexDocumentsBatch.addUploadActions(Collections.singletonList(searchDocument1));
 indexDocumentsBatch.addDeleteActions(Collections.singletonList(searchDocument2));
 IndexDocumentsResult result = SEARCH_CLIENT.indexDocuments(indexDocumentsBatch);
 for (IndexingResult indexingResult : result.getResults()) {
     System.out.printf("Does document with key %s finish successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

batch - The batch of index actions

Returns:

Response containing the status of operations for all actions in the batch

indexDocumentsWithResponse

public Response indexDocumentsWithResponse(IndexDocumentsBatch batch, IndexDocumentsOptions options, Context context)

Sends a batch of upload, merge, and/or delete actions to the search index.

Code Sample

Index batch operation on dynamic SearchDocument.

SearchDocument searchDocument1 = new SearchDocument();
 searchDocument1.put("hotelId", "1");
 searchDocument1.put("hotelName", "test1");
 SearchDocument searchDocument2 = new SearchDocument();
 searchDocument2.put("hotelId", "2");
 searchDocument2.put("hotelName", "test2");
 IndexDocumentsBatch<SearchDocument> indexDocumentsBatch = new IndexDocumentsBatch<>();
 indexDocumentsBatch.addUploadActions(Collections.singletonList(searchDocument1));
 indexDocumentsBatch.addDeleteActions(Collections.singletonList(searchDocument2));
 Response<IndexDocumentsResult> resultResponse = SEARCH_CLIENT.indexDocumentsWithResponse(indexDocumentsBatch,
     null, new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + resultResponse.getStatusCode());
 for (IndexingResult indexingResult : resultResponse.getValue().getResults()) {
     System.out.printf("Does document with key %s finish successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

batch - The batch of index actions

options - Options that allow specifying document indexing behavior.

context - additional context that is passed through the Http pipeline during the service call

Returns:

Response containing the status of operations for all actions in the batch

mergeDocuments

public IndexDocumentsResult mergeDocuments(Iterable documents)

Merges a collection of documents with existing documents in the target index.

If the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for boolean), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type Integer instead of int).

Code Sample

Merge dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelName", "merge");
 IndexDocumentsResult result = SEARCH_CLIENT.mergeDocuments(Collections.singletonList(searchDocument));
 for (IndexingResult indexingResult : result.getResults()) {
     System.out.printf("Does document with key %s merge successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to be merged

Returns:

document index result

mergeDocumentsWithResponse

public Response mergeDocumentsWithResponse(Iterable documents, IndexDocumentsOptions options, Context context)

Merges a collection of documents with existing documents in the target index.

If the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for boolean), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type Integer instead of int).

Code Sample

Merge dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelName", "test");
 Response<IndexDocumentsResult> resultResponse = SEARCH_CLIENT.mergeDocumentsWithResponse(
     Collections.singletonList(searchDocument), null, new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + resultResponse.getStatusCode());
 for (IndexingResult indexingResult : resultResponse.getValue().getResults()) {
     System.out.printf("Does document with key %s merge successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to be merged.

options - Options that allow specifying document indexing behavior.

context - additional context that is passed through the Http pipeline during the service call

Returns:

response containing the document index result.

mergeOrUploadDocuments

public IndexDocumentsResult mergeOrUploadDocuments(Iterable documents)

This action behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document.

If the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for boolean), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type Integer instead of int).

Code Sample

Merge or upload dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelId", "1");
 searchDocument.put("hotelName", "test");
 IndexDocumentsResult result = SEARCH_CLIENT.mergeOrUploadDocuments(Collections.singletonList(searchDocument));
 for (IndexingResult indexingResult : result.getResults()) {
     System.out.printf("Does document with key %s mergeOrUpload successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to be merged, if exists, otherwise uploaded

Returns:

document index result

mergeOrUploadDocumentsWithResponse

public Response mergeOrUploadDocumentsWithResponse(Iterable documents, IndexDocumentsOptions options, Context context)

This action behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document.

If the type of the document contains non-nullable primitive-typed properties, these properties may not merge correctly. If you do not set such a property, it will automatically take its default value (for example, 0 for int or false for boolean), which will override the value of the property currently stored in the index, even if this was not your intent. For this reason, it is strongly recommended that you always declare primitive-typed properties with their class equivalents (for example, an integer property should be of type Integer instead of int).

Code Sample

Merge or upload dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelId", "1");
 searchDocument.put("hotelName", "test");
 Response<IndexDocumentsResult> resultResponse = SEARCH_CLIENT.mergeOrUploadDocumentsWithResponse(
     Collections.singletonList(searchDocument), null, new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + resultResponse.getStatusCode());
 for (IndexingResult indexingResult : resultResponse.getValue().getResults()) {
     System.out.printf("Does document with key %s mergeOrUpload successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to be merged, if exists, otherwise uploaded

options - Options that allow specifying document indexing behavior.

context - additional context that is passed through the Http pipeline during the service call

Returns:

response containing a document index result

search

public SearchPagedIterable search(String searchText)

Searches for documents in the Azure Cognitive Search index.

If searchText is set to null or "*" all documents will be matched, see simple query syntax in Azure Cognitive Search for more information about search query syntax.

The SearchPagedIterable will iterate through search result pages until all search results are returned. Each page is determined by the $skip and $top values and the Search service has a limit on the number of documents that can be skipped, more information about the $skip limit can be found at Search Documents REST API and reading the $skip description. If the total number of results exceeds the $skip limit the SearchPagedIterable won't prevent you from exceeding the $skip limit. To prevent exceeding the limit you can track the number of documents returned and stop requesting new pages when the limit is reached.

Code Sample

Search text from documents in service.

SearchPagedIterable searchPagedIterable = SEARCH_CLIENT.search("searchText");
 System.out.printf("There are around %d results.", searchPagedIterable.getTotalCount());

 long numberOfDocumentsReturned = 0;
 for (SearchPagedResponse resultResponse: searchPagedIterable.iterableByPage()) {
     System.out.println("The status code of the response is " + resultResponse.getStatusCode());
     numberOfDocumentsReturned += resultResponse.getValue().size();
     resultResponse.getValue().forEach(searchResult -> {
         for (Map.Entry<String, Object> keyValuePair: searchResult
             .getDocument(SearchDocument.class).entrySet()) {
             System.out.printf("Document key %s, document value %s", keyValuePair.getKey(),
                 keyValuePair.getValue());
         }
     });

     if (numberOfDocumentsReturned >= SEARCH_SKIP_LIMIT) {
         // Reached the $skip limit, stop requesting more documents.
         break;
     }
 }

Parameters:

searchText - A full-text search query expression.

Returns:

A SearchPagedIterable that iterates over SearchResult objects and provides access to the SearchPagedResponse object for each page containing HTTP response and count, facet, and coverage information.

search

public SearchPagedIterable search(String searchText, SearchOptions searchOptions, Context context)

Searches for documents in the Azure Cognitive Search index.

If searchText is set to null or "*" all documents will be matched, see simple query syntax in Azure Cognitive Search for more information about search query syntax.

The SearchPagedIterable will iterate through search result pages until all search results are returned. Each page is determined by the $skip and $top values and the Search service has a limit on the number of documents that can be skipped, more information about the $skip limit can be found at Search Documents REST API and reading the $skip description. If the total number of results exceeds the $skip limit the SearchPagedIterable won't prevent you from exceeding the $skip limit. To prevent exceeding the limit you can track the number of documents returned and stop requesting new pages when the limit is reached.

Code Sample

Search text from documents in service with option.

SearchPagedIterable searchPagedIterable = SEARCH_CLIENT.search("searchText",
     new SearchOptions().setOrderBy("hotelId desc"), new Context(KEY_1, VALUE_1));
 System.out.printf("There are around %d results.", searchPagedIterable.getTotalCount());

 long numberOfDocumentsReturned = 0;
 for (SearchPagedResponse resultResponse: searchPagedIterable.iterableByPage()) {
     System.out.println("The status code of the response is " + resultResponse.getStatusCode());
     numberOfDocumentsReturned += resultResponse.getValue().size();
     resultResponse.getValue().forEach(searchResult -> {
         for (Map.Entry<String, Object> keyValuePair: searchResult
             .getDocument(SearchDocument.class).entrySet()) {
             System.out.printf("Document key %s, document value %s", keyValuePair.getKey(),
                 keyValuePair.getValue());
         }
     });

     if (numberOfDocumentsReturned >= SEARCH_SKIP_LIMIT) {
         // Reached the $skip limit, stop requesting more documents.
         break;
     }
 }

Parameters:

searchText - A full-text search query expression.

searchOptions - Parameters to further refine the search query

context - additional context that is passed through the Http pipeline during the service call

Returns:

A SearchPagedIterable that iterates over SearchResult objects and provides access to the SearchPagedResponse object for each page containing HTTP response and count, facet, and coverage information.

suggest

public SuggestPagedIterable suggest(String searchText, String suggesterName)

Suggests documents in the index that match the given partial query.

Code Sample

Suggest text from documents in service.

SuggestPagedIterable suggestPagedIterable = SEARCH_CLIENT.suggest("searchText", "sg");
 for (SuggestResult result: suggestPagedIterable) {
     SearchDocument searchDocument = result.getDocument(SearchDocument.class);
     for (Map.Entry<String, Object> keyValuePair: searchDocument.entrySet()) {
         System.out.printf("Document key %s, document value %s", keyValuePair.getKey(), keyValuePair.getValue());
     }
 }

Parameters:

searchText - The search text on which to base suggestions

suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition

Returns:

A SuggestPagedIterable that iterates over SuggestResult objects and provides access to the SuggestPagedResponse object for each page containing HTTP response and coverage information.

suggest

public SuggestPagedIterable suggest(String searchText, String suggesterName, SuggestOptions suggestOptions, Context context)

Suggests documents in the index that match the given partial query.

Code Sample

Suggest text from documents in service with option.

SuggestPagedIterable suggestPagedIterable = SEARCH_CLIENT.suggest("searchText", "sg",
     new SuggestOptions().setOrderBy("hotelId desc"), new Context(KEY_1, VALUE_1));
 for (SuggestResult result: suggestPagedIterable) {
     SearchDocument searchDocument = result.getDocument(SearchDocument.class);
     for (Map.Entry<String, Object> keyValuePair: searchDocument.entrySet()) {
         System.out.printf("Document key %s, document value %s", keyValuePair.getKey(), keyValuePair.getValue());
     }
 }

Parameters:

searchText - The search text on which to base suggestions

suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition

suggestOptions - Parameters to further refine the suggestion query.

context - additional context that is passed through the Http pipeline during the service call

Returns:

A SuggestPagedIterable that iterates over SuggestResult objects and provides access to the SuggestPagedResponse object for each page containing HTTP response and coverage information.

uploadDocuments

public IndexDocumentsResult uploadDocuments(Iterable documents)

Uploads a collection of documents to the target index.

Code Sample

Upload dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelId", "1");
 searchDocument.put("hotelName", "test");
 IndexDocumentsResult result = SEARCH_CLIENT.uploadDocuments(Collections.singletonList(searchDocument));
 for (IndexingResult indexingResult : result.getResults()) {
     System.out.printf("Does document with key %s upload successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to upload to the target Index.

Returns:

document index result.

uploadDocumentsWithResponse

public Response uploadDocumentsWithResponse(Iterable documents, IndexDocumentsOptions options, Context context)

Uploads a collection of documents to the target index.

Code Sample

Upload dynamic SearchDocument.

SearchDocument searchDocument = new SearchDocument();
 searchDocument.put("hotelId", "1");
 searchDocument.put("hotelName", "test");
 Response<IndexDocumentsResult> resultResponse = SEARCH_CLIENT.uploadDocumentsWithResponse(
     Collections.singletonList(searchDocument), null, new Context(KEY_1, VALUE_1));
 System.out.println("The status code of the response is " + resultResponse.getStatusCode());
 for (IndexingResult indexingResult : resultResponse.getValue().getResults()) {
     System.out.printf("Does document with key %s upload successfully? %b%n", indexingResult.getKey(),
         indexingResult.isSucceeded());
 }

Parameters:

documents - collection of documents to upload to the target Index.

options - Options that allow specifying document indexing behavior.

context - additional context that is passed through the Http pipeline during the service call

Returns:

response containing the document index result.