Skip to content

Commit

Permalink
Adding support for autocomplete functionality (Azure#73)
Browse files Browse the repository at this point in the history 
* implementation of the needed methods
* adding UTs
  • Loading branch information
@eladiw
eladiw authored Sep 16, 2019
1 parent 12085cd commit 282cd62
Show file tree
Hide file tree
Showing 19 changed files with 1,151 additions and 88 deletions.
6 changes: 3 additions & 3 deletions sdk/search/azure-search-data/src/main/java/com/azure/search/data/SearchIndexAsyncClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

import com.azure.core.http.rest.PagedFlux;
import com.azure.search.data.customization.Document;
import com.azure.search.data.generated.models.AutocompleteItem;
import com.azure.search.data.generated.models.AutocompleteParameters;
import com.azure.search.data.generated.models.AutocompleteResult;
import com.azure.search.data.generated.models.DocumentIndexResult;
import com.azure.search.data.generated.models.IndexBatch;
import com.azure.search.data.generated.models.SearchParameters;
Expand Down Expand Up @@ -148,7 +148,7 @@ public interface SearchIndexAsyncClient {
* @param suggesterName suggester name
* @return auto complete result
*/
Mono<AutocompleteResult> autocomplete(String searchText, String suggesterName);
PagedFlux<AutocompleteItem> autocomplete(String searchText, String suggesterName);

/**
* Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.
Expand All @@ -159,5 +159,5 @@ public interface SearchIndexAsyncClient {
* @param autocompleteParameters auto complete parameters
* @return auto complete result
*/
Mono<AutocompleteResult> autocomplete(String searchText, String suggesterName, SearchRequestOptions searchRequestOptions, AutocompleteParameters autocompleteParameters);
PagedFlux<AutocompleteItem> autocomplete(String searchText, String suggesterName, SearchRequestOptions searchRequestOptions, AutocompleteParameters autocompleteParameters);
}
6 changes: 3 additions & 3 deletions sdk/search/azure-search-data/src/main/java/com/azure/search/data/SearchIndexClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

import com.azure.core.http.rest.PagedIterable;
import com.azure.search.data.customization.Document;
import com.azure.search.data.generated.models.AutocompleteItem;
import com.azure.search.data.generated.models.AutocompleteParameters;
import com.azure.search.data.generated.models.AutocompleteResult;
import com.azure.search.data.generated.models.DocumentIndexResult;
import com.azure.search.data.generated.models.IndexBatch;
import com.azure.search.data.generated.models.SearchParameters;
Expand Down Expand Up @@ -146,7 +146,7 @@ public interface SearchIndexClient {
* @param suggesterName suggester name
* @return auto complete result
*/
AutocompleteResult autocomplete(String searchText, String suggesterName);
PagedIterable<AutocompleteItem> autocomplete(String searchText, String suggesterName);

/**
* Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.
Expand All @@ -157,5 +157,5 @@ public interface SearchIndexClient {
* @param autocompleteParameters auto complete parameters
* @return auto complete result
*/
AutocompleteResult autocomplete(String searchText, String suggesterName, SearchRequestOptions searchRequestOptions, AutocompleteParameters autocompleteParameters);
PagedIterable<AutocompleteItem> autocomplete(String searchText, String suggesterName, SearchRequestOptions searchRequestOptions, AutocompleteParameters autocompleteParameters);
}
35 changes: 35 additions & 0 deletions ...ure-search-data/src/main/java/com/azure/search/data/common/AutoCompletePagedResponse.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.search.data.common;

import com.azure.core.http.HttpHeaders;
import com.azure.core.http.rest.SimpleResponse;
import com.azure.core.implementation.http.PagedResponseBase;
import com.azure.search.data.generated.models.AutocompleteItem;
import com.azure.search.data.generated.models.AutocompleteResult;

import java.util.stream.Collectors;

public class AutoCompletePagedResponse extends PagedResponseBase<String, AutocompleteItem> {

/**
* Constructor
*
* @param autoCompleteResponse an http response with the results
*/
public AutoCompletePagedResponse(SimpleResponse<AutocompleteResult> autoCompleteResponse) {
super(autoCompleteResponse.request(),
autoCompleteResponse.statusCode(),
autoCompleteResponse.headers(),
autoCompleteResponse.value().results(),
null,
deserializeHeaders(autoCompleteResponse.headers()));
}

private static String deserializeHeaders(HttpHeaders headers) {
return headers.toMap().entrySet().stream().map((entry) ->
entry.getKey() + "," + entry.getValue()
).collect(Collectors.joining(","));
}
}
188 changes: 111 additions & 77 deletions ...ch-data/src/main/java/com/azure/search/data/customization/SearchIndexAsyncClientImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@
import com.azure.core.http.rest.PagedFlux;
import com.azure.core.http.rest.PagedResponse;
import com.azure.search.data.SearchIndexAsyncClient;
import com.azure.search.data.common.AutoCompletePagedResponse;
import com.azure.search.data.common.DocumentResponseConversions;
import com.azure.search.data.common.SearchPagedResponse;
import com.azure.search.data.common.SuggestPagedResponse;
import com.azure.search.data.generated.SearchIndexRestClient;
import com.azure.search.data.generated.implementation.SearchIndexRestClientBuilder;
import com.azure.search.data.generated.models.AutocompleteItem;
import com.azure.search.data.generated.models.AutocompleteParameters;
import com.azure.search.data.generated.models.AutocompleteResult;
import com.azure.search.data.generated.models.AutocompleteRequest;
import com.azure.search.data.generated.models.DocumentIndexResult;
import com.azure.search.data.generated.models.IndexBatch;
import com.azure.search.data.generated.models.SearchParameters;
Expand Down Expand Up @@ -75,9 +77,9 @@ public class SearchIndexAsyncClientImpl extends SearchIndexBaseClient implements
* Package private constructor to be used by {@link SearchIndexClientBuilder}
*/
SearchIndexAsyncClientImpl(
String searchServiceName, String searchDnsSuffix, String indexName, String apiVersion,
HttpClient httpClient,
List<HttpPipelinePolicy> policies) {
String searchServiceName, String searchDnsSuffix, String indexName, String apiVersion,
HttpClient httpClient,
List<HttpPipelinePolicy> policies) {
if (StringUtils.isBlank(searchServiceName)) {
throw new IllegalArgumentException("Invalid searchServiceName");
}
Expand Down Expand Up @@ -110,14 +112,14 @@ public class SearchIndexAsyncClientImpl extends SearchIndexBaseClient implements

private void initialize() {
restClient = new SearchIndexRestClientBuilder()
.searchServiceName(searchServiceName)
.indexName(indexName)
.searchDnsSuffix(searchDnsSuffix)
.apiVersion(apiVersion)
.pipeline(new HttpPipelineBuilder()
.httpClient(httpClient)
.policies(policies.toArray(new HttpPipelinePolicy[0])).build())
.build();
.searchServiceName(searchServiceName)
.indexName(indexName)
.searchDnsSuffix(searchDnsSuffix)
.apiVersion(apiVersion)
.pipeline(new HttpPipelineBuilder()
.httpClient(httpClient)
.policies(policies.toArray(new HttpPipelinePolicy[0])).build())
.build();
}

@Override
Expand Down Expand Up @@ -161,52 +163,52 @@ public Mono<Long> countDocuments() {
public PagedFlux<SearchResult> search() {
SearchRequest searchRequest = new SearchRequest();
Mono<PagedResponse<SearchResult>> first = restClient.documents()
.searchPostWithRestResponseAsync(searchRequest)
.map(res -> {
if (res.value().nextPageParameters() != null) {
skip = res.value().nextPageParameters().skip();
}
return new SearchPagedResponse(res);
});
.searchPostWithRestResponseAsync(searchRequest)
.map(res -> {
if (res.value().nextPageParameters() != null) {
skip = res.value().nextPageParameters().skip();
}
return new SearchPagedResponse(res);
});
return new PagedFlux<>(() -> first, nextLink -> searchPostNextWithRestResponseAsync(searchRequest, (String) nextLink));
}

@Override
public PagedFlux<SearchResult> search(String searchText, SearchParameters searchParameters, SearchRequestOptions searchRequestOptions) {
SearchRequest searchRequest = createSearchRequest(searchText, searchParameters);
Mono<PagedResponse<SearchResult>> first = restClient.documents()
.searchPostWithRestResponseAsync(searchRequest, searchRequestOptions)
.map(res -> {
if (res.value().nextPageParameters() != null) {
skip = res.value().nextPageParameters().skip();
}
return new SearchPagedResponse(res);
});
.searchPostWithRestResponseAsync(searchRequest, searchRequestOptions)
.map(res -> {
if (res.value().nextPageParameters() != null) {
skip = res.value().nextPageParameters().skip();
}
return new SearchPagedResponse(res);
});
return new PagedFlux(() -> first, nextLink -> searchPostNextWithRestResponseAsync(searchRequest, (String) nextLink));
}

@Override
public Mono<Document> getDocument(String key) {
return restClient
.documents()
.getAsync(key)
.map(DocumentResponseConversions::cleanupDocument)
.onErrorMap(DocumentResponseConversions::exceptionMapper)
.doOnSuccess(s -> System.out.println("Document with key: " + key + " was retrieved successfully"))
.doOnError(e -> System.out.println("An error occurred in getDocument(key): " + e.getMessage()));
.documents()
.getAsync(key)
.map(DocumentResponseConversions::cleanupDocument)
.onErrorMap(DocumentResponseConversions::exceptionMapper)
.doOnSuccess(s -> System.out.println("Document with key: " + key + " was retrieved successfully"))
.doOnError(e -> System.out.println("An error occurred in getDocument(key): " + e.getMessage()));
}

@Override
public Mono<Document> getDocument(
String key, List<String> selectedFields,
SearchRequestOptions searchRequestOptions) {
String key, List<String> selectedFields,
SearchRequestOptions searchRequestOptions) {
return restClient
.documents()
.getAsync(key, selectedFields, searchRequestOptions)
.map(DocumentResponseConversions::cleanupDocument)
.onErrorMap(DocumentResponseConversions::exceptionMapper)
.doOnSuccess(s -> System.out.println("Document with key: " + key + "and selectedFields: " + selectedFields.toString() + " was retrieved successfully"))
.doOnError(e -> System.out.println("An error occurred in getDocument(key, selectedFields, searchRequestOptions): " + e.getMessage()));
.documents()
.getAsync(key, selectedFields, searchRequestOptions)
.map(DocumentResponseConversions::cleanupDocument)
.onErrorMap(DocumentResponseConversions::exceptionMapper)
.doOnSuccess(s -> System.out.println("Document with key: " + key + "and selectedFields: " + selectedFields.toString() + " was retrieved successfully"))
.doOnError(e -> System.out.println("An error occurred in getDocument(key, selectedFields, searchRequestOptions): " + e.getMessage()));
}

@Override
Expand All @@ -216,10 +218,10 @@ public PagedFlux<SuggestResult> suggest(String searchText, String suggesterName)

@Override
public PagedFlux<SuggestResult> suggest(
String searchText,
String suggesterName,
SuggestParameters suggestParameters,
SearchRequestOptions searchRequestOptions) {
String searchText,
String suggesterName,
SuggestParameters suggestParameters,
SearchRequestOptions searchRequestOptions) {
SuggestRequest suggestRequest = createSuggestRequest(searchText, suggesterName, suggestParameters);
Mono<PagedResponse<SuggestResult>> first = restClient.documents()
.suggestPostWithRestResponseAsync(suggestRequest)
Expand All @@ -236,21 +238,24 @@ public Mono<DocumentIndexResult> index(IndexBatch batch) {
}

@Override
public Mono<AutocompleteResult> autocomplete(String searchText, String suggesterName) {
return restClient.documents().autocompleteGetAsync(searchText, suggesterName);
public PagedFlux<AutocompleteItem> autocomplete(String searchText, String suggesterName) {
return autocomplete(searchText, suggesterName, null, null);
}

@Override
public Mono<AutocompleteResult> autocomplete(
String searchText,
String suggesterName,
SearchRequestOptions searchRequestOptions,
AutocompleteParameters autocompleteParameters) {
return restClient.documents().autocompleteGetAsync(
searchText,
suggesterName,
searchRequestOptions,
autocompleteParameters);
public PagedFlux<AutocompleteItem> autocomplete(
String searchText,
String suggesterName,
SearchRequestOptions searchRequestOptions,
AutocompleteParameters autocompleteParameters) {

AutocompleteRequest autocompleteRequest = createAutoCompleteRequest(searchText, suggesterName, autocompleteParameters);
Mono<PagedResponse<AutocompleteItem>> first = restClient.documents()
.autocompletePostWithRestResponseAsync(autocompleteRequest)
.map(res -> {
return new AutoCompletePagedResponse(res);
});
return new PagedFlux<>(() -> first, nextLink -> Mono.empty());
}

/**
Expand All @@ -268,15 +273,15 @@ private Mono<PagedResponse<SearchResult>> searchPostNextWithRestResponseAsync(Se
return Mono.empty();
}
return restClient.documents()
.searchPostWithRestResponseAsync(searchRequest.skip(skip))
.map(res -> {
if (res.value().nextPageParameters() == null || res.value().nextPageParameters().skip() == null) {
skip = null;
} else {
skip = res.value().nextPageParameters().skip();
}
return new SearchPagedResponse(res);
});
.searchPostWithRestResponseAsync(searchRequest.skip(skip))
.map(res -> {
if (res.value().nextPageParameters() == null || res.value().nextPageParameters().skip() == null) {
skip = null;
} else {
skip = res.value().nextPageParameters().skip();
}
return new SearchPagedResponse(res);
});
}


Expand All @@ -291,18 +296,18 @@ private SearchRequest createSearchRequest(String searchText, SearchParameters se
SearchRequest searchRequest = new SearchRequest().searchText(searchText);
if (searchParameters != null) {
searchRequest.
searchMode(searchParameters.searchMode()).
facets(searchParameters.facets()).
filter(searchParameters.filter()).
highlightPostTag(searchParameters.highlightPostTag()).
highlightPreTag(searchParameters.highlightPreTag()).
includeTotalResultCount(searchParameters.includeTotalResultCount()).
minimumCoverage(searchParameters.minimumCoverage()).
queryType(searchParameters.queryType()).
scoringParameters(searchParameters.scoringParameters()).
scoringProfile(searchParameters.scoringProfile()).
skip(searchParameters.skip()).
top(searchParameters.top());
searchMode(searchParameters.searchMode()).
facets(searchParameters.facets()).
filter(searchParameters.filter()).
highlightPostTag(searchParameters.highlightPostTag()).
highlightPreTag(searchParameters.highlightPreTag()).
includeTotalResultCount(searchParameters.includeTotalResultCount()).
minimumCoverage(searchParameters.minimumCoverage()).
queryType(searchParameters.queryType()).
scoringParameters(searchParameters.scoringParameters()).
scoringProfile(searchParameters.scoringProfile()).
skip(searchParameters.skip()).
top(searchParameters.top());
if (searchParameters.highlightFields() != null) {
searchRequest.highlightFields(String.join(",", searchParameters.highlightFields()));
}
Expand Down Expand Up @@ -338,6 +343,7 @@ private SuggestRequest createSuggestRequest(String searchText, String suggesterN
highlightPreTag(suggestParameters.highlightPreTag()).
minimumCoverage(suggestParameters.minimumCoverage()).
top(suggestParameters.top());

List<String> searchFields = suggestParameters.searchFields();
if (searchFields != null) {
suggestRequest.searchFields(String.join(",", searchFields));
Expand All @@ -356,4 +362,32 @@ private SuggestRequest createSuggestRequest(String searchText, String suggesterN

return suggestRequest;
}

/**
* Create Autocomplete request from search text, suggester name, and parameters
*
* @param searchText search text
* @param suggesterName search text
* @param autocompleteParameters autocomplete parameters
* @return AutocompleteRequest
*/
private AutocompleteRequest createAutoCompleteRequest(String searchText, String suggesterName, AutocompleteParameters autocompleteParameters) {
AutocompleteRequest autoCompleteRequest = new AutocompleteRequest().searchText(searchText).suggesterName(suggesterName);
if (autocompleteParameters != null) {
autoCompleteRequest.
filter(autocompleteParameters.filter()).
useFuzzyMatching(autocompleteParameters.useFuzzyMatching()).
highlightPostTag(autocompleteParameters.highlightPostTag()).
highlightPreTag(autocompleteParameters.highlightPreTag()).
minimumCoverage(autocompleteParameters.minimumCoverage()).
top(autocompleteParameters.top()).
autocompleteMode(autocompleteParameters.autocompleteMode());
List<String> searchFields = autocompleteParameters.searchFields();
if (searchFields != null) {
autoCompleteRequest.searchFields(String.join(",", searchFields));
}
}

return autoCompleteRequest;
}
}
Loading

0 comments on commit 282cd62

Please sign in to comment.