- * Conceptually, a document is an entity in your index. Mapping this concept to more familiar database equivalents: - * a search index equates to a table, and documents are roughly equivalent to rows in a table. Documents exist only - * in an index, and are retrieved only through queries that target the documents collection (/docs) of an index. All - * operations performed on the collection such as uploading, merging, deleting, or querying documents take place in - * the context of a single index, so the URL format document operations will always include /indexes/[index name]/docs - * for a given index name. - *
- * - *- * This client provides an asynchronous API for accessing and performing operations on indexed documents. This client - * assists with searching your indexed documents, autocompleting partially typed search terms based on documents within the index, - * suggesting the most likely matching text in documents as a user types. The client provides operations for adding, updating, and deleting - * documents from an index. - *
- * - *- * Authenticating and building instances of this client are handled by {@link SearchClientBuilder}. This sample shows - * you how to authenticate and create an instance of the client: - *
- * - * - *
- * SearchAsyncClient searchAsyncClient = new SearchClientBuilder()
- * .credential(new AzureKeyCredential("{key}"))
- * .endpoint("{endpoint}")
- * .indexName("{indexName}")
- * .buildAsyncClient();
- *
- *
- *
- * - * For more information on authentication and building, see the {@link SearchClientBuilder} documentation. - *
- * - *- * The following examples all use a simple Hotel - * data set that you can - * import into your own index from the Azure portal. - * These are just a few of the basics - please check out our Samples for much more. - *
- * - *- * The following sample uploads a new document to an index. - *
- * - * - *
- * List<Hotel> hotels = new ArrayList<>();
- * hotels.add(new Hotel().setHotelId("100"));
- * hotels.add(new Hotel().setHotelId("200"));
- * hotels.add(new Hotel().setHotelId("300"));
- * searchAsyncClient.uploadDocuments(hotels).block();
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#uploadDocuments(Iterable)}.
- *
- *
- * - * The following sample merges documents in an index. - *
- * - * - *
- * List<Hotel> hotels = new ArrayList<>();
- * hotels.add(new Hotel().setHotelId("100"));
- * hotels.add(new Hotel().setHotelId("200"));
- * searchAsyncClient.mergeDocuments(hotels).block();
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#mergeDocuments(Iterable)}.
- *
- *
- * - * The following sample deletes a document from an index. - *
- * - * - *
- * SearchDocument documentId = new SearchDocument();
- * documentId.put("hotelId", "100");
- * searchAsyncClient.deleteDocuments(Collections.singletonList(documentId));
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#deleteDocuments(Iterable)}.
- *
- *
- * - * The following sample gets a document from an index. - *
- * - * - *
- * Hotel hotel = searchAsyncClient.getDocument("100", Hotel.class).block();
- * if (hotel != null) {
- * System.out.printf("Retrieved Hotel %s%n", hotel.getHotelId());
- * }
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#getDocument(String, Class)}.
- *
- *
- * - * The following sample searches for documents within an index. - *
- * - * - *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "8");
- * searchDocument.put("description", "budget");
- * searchDocument.put("descriptionFr", "motel");
- *
- * SearchDocument searchDocument1 = new SearchDocument();
- * searchDocument1.put("hotelId", "9");
- * searchDocument1.put("description", "budget");
- * searchDocument1.put("descriptionFr", "motel");
- *
- * List<SearchDocument> searchDocuments = new ArrayList<>();
- * searchDocuments.add(searchDocument);
- * searchDocuments.add(searchDocument1);
- * searchAsyncClient.uploadDocuments(searchDocuments);
- *
- * SearchPagedFlux results = searchAsyncClient.search("SearchText");
- * results.getTotalCount().subscribe(total -> System.out.printf("There are %s results", total));
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#search(String)}.
- *
- *
- * - * The following sample suggests the most likely matching text in documents. - *
- * - * - *
- * SuggestPagedFlux results = searchAsyncClient.suggest("searchText", "sg");
- * results.subscribe(item -> {
- * System.out.printf("The text '%s' was found.%n", item.getText());
- * });
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#suggest(String, String)}.
- *
- *
- * - * The following sample provides autocompletion for a partially typed query. - *
- * - * - *
- * AutocompletePagedFlux results = searchAsyncClient.autocomplete("searchText", "sg");
- * results.subscribe(item -> {
- * System.out.printf("The text '%s' was found.%n", item.getText());
- * });
- *
- *
- *
- *
- * For a synchronous sample see {@link SearchClient#autocomplete(String, String)}.
- *
- *
- * @see SearchClient
- * @see SearchClientBuilder
- * @see com.azure.search.documents
+ * Initializes a new instance of the asynchronous SearchClient type.
*/
@ServiceClient(builder = SearchClientBuilder.class, isAsync = true)
public final class SearchAsyncClient {
- private static final ClientLogger LOGGER = new ClientLogger(SearchAsyncClient.class);
-
- /**
- * Search REST API Version
- */
- private final SearchServiceVersion serviceVersion;
-
- /**
- * The endpoint for the Azure AI Search service.
- */
- private final String endpoint;
-
- /**
- * The name of the Azure AI Search index.
- */
- private final String indexName;
-
- /**
- * The underlying AutoRest client used to interact with the Azure AI Search service
- */
- private final SearchIndexClientImpl restClient;
-
- /**
- * The pipeline that powers this client.
- */
- private final HttpPipeline httpPipeline;
-
- final JsonSerializer serializer;
-
- /**
- * Package private constructor to be used by {@link SearchClientBuilder}
- */
- SearchAsyncClient(String endpoint, String indexName, SearchServiceVersion serviceVersion, HttpPipeline httpPipeline,
- JsonSerializer serializer, SearchIndexClientImpl restClient) {
- this.endpoint = endpoint;
- this.indexName = indexName;
- this.serviceVersion = serviceVersion;
- this.httpPipeline = httpPipeline;
- this.serializer = serializer;
- this.restClient = restClient;
- }
-
- /**
- * Gets the name of the Azure AI Search index.
- *
- * @return the indexName value.
- */
- public String getIndexName() {
- return this.indexName;
- }
-
- /**
- * Gets the {@link HttpPipeline} powering this client.
- *
- * @return the pipeline.
- */
- HttpPipeline getHttpPipeline() {
- return this.httpPipeline;
- }
+ @Generated
+ private final SearchClientImpl serviceClient;
/**
- * Gets the endpoint for the Azure AI Search service.
- *
- * @return the endpoint value.
+ * Initializes an instance of SearchAsyncClient class.
+ *
+ * @param serviceClient the service client implementation.
*/
- public String getEndpoint() {
- return this.endpoint;
+ @Generated
+ SearchAsyncClient(SearchClientImpl serviceClient) {
+ this.serviceClient = serviceClient;
}
/**
- * Uploads a collection of documents to the target index.
- *
- * Code Sample
- * - *Upload dynamic SearchDocument.
- * - * + * Queries the number of documents in the index. + *Response Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "1");
- * searchDocument.put("hotelName", "test");
- * SEARCH_ASYNC_CLIENT.uploadDocuments(Collections.singletonList(searchDocument))
- * .subscribe(result -> {
- * for (IndexingResult indexingResult : result.getResults()) {
- * System.out.printf("Does document with key %s upload successfully? %b%n",
- * indexingResult.getKey(), indexingResult.isSucceeded());
- * }
- * });
+ * {@code
+ * long
+ * }
*
- *
- *
- * @param documents collection of documents to upload to the target Index.
- * @return The result of the document indexing actions.
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a 64-bit integer along with {@link Response} on successful completion of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public MonoCode Sample
- * - *Upload dynamic SearchDocument.
- * - * + * Searches for documents in the index. + *Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| search | String | No | A full-text search query expression; Use "*" or omit this + * parameter to match all documents. |
| $count | Boolean | No | A value that specifies whether to fetch the total count of + * results. Default is false. Setting this value to true may have a performance impact. Note that the count returned + * is an approximation. |
| facet | List<String> | No | The list of facet expressions to apply to the search + * query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value + * pairs. Call {@link RequestOptions#addQueryParam} to add string to array. |
| $filter | String | No | The OData $filter expression to apply to the search + * query. |
| highlight | List<String> | No | The list of field names to use for hit + * highlights. Only searchable fields can be used for hit highlighting. In the form of "," separated + * string. |
| highlightPostTag | String | No | A string tag that is appended to hit highlights. Must + * be set with highlightPreTag. Default is </em>. |
| highlightPreTag | String | No | A string tag that is prepended to hit highlights. Must + * be set with highlightPostTag. Default is <em>. |
| minimumCoverage | Double | No | A number between 0 and 100 indicating the percentage of + * the index that must be covered by a search query in order for the query to be reported as a success. This + * parameter can be useful for ensuring search availability even for services with only one replica. The default is + * 100. |
| $orderby | List<String> | No | The list of OData $orderby expressions by which to + * sort the results. Each expression can be either a field name or a call to either the geo.distance() or the + * search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate + * descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy + * is specified, the default sort order is descending by document match score. There can be at most 32 $orderby + * clauses. In the form of "," separated string. |
| queryType | String | No | A value that specifies the syntax of the search query. The + * default is 'simple'. Use 'full' if your query uses the Lucene query syntax. Allowed values: "simple", "full", + * "semantic". |
| scoringParameter | List<String> | No | The list of parameter values to be used in + * scoring functions (for example, referencePointParameter) using the format name-values. For example, if the + * scoring profile defines a function with a parameter called 'mylocation' the parameter string would be + * "mylocation--122.2,44.8" (without the quotes). Call {@link RequestOptions#addQueryParam} to add string to + * array. |
| scoringProfile | String | No | The name of a scoring profile to evaluate match scores + * for matching documents in order to sort the results. |
| searchFields | List<String> | No | The list of field names to which to scope the + * full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names + * of each fielded search expression take precedence over any field names listed in this parameter. In the form of + * "," separated string. |
| searchMode | String | No | A value that specifies whether any or all of the search + * terms must be matched in order to count the document as a match. Allowed values: "any", "all". |
| scoringStatistics | String | No | A value that specifies whether we want to calculate + * scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower + * latency. Allowed values: "local", "global". |
| sessionId | String | No | A value to be used to create a sticky session, which can help + * to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to + * target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the + * load balancing of the requests across replicas and adversely affect the performance of the search service. The + * value used as sessionId cannot start with a '_' character. |
| $select | List<String> | No | The list of fields to retrieve. If unspecified, all + * fields marked as retrievable in the schema are included. In the form of "," separated string. |
| $skip | Integer | No | The number of search results to skip. This value cannot be + * greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, + * consider using $orderby on a totally-ordered key and $filter with a range query instead. |
| $top | Integer | No | The number of search results to retrieve. This can be used in + * conjunction with $skip to implement client-side paging of search results. If results are truncated due to + * server-side paging, the response will include a continuation token that can be used to issue another Search + * request for the next page of results. |
| semanticConfiguration | String | No | The name of the semantic configuration that lists + * which fields should be used for semantic ranking, captions, highlights, and answers |
| semanticErrorHandling | String | No | Allows the user to choose whether a semantic call + * should fail completely, or to return partial results (default). Allowed values: "partial", "fail". |
| semanticMaxWaitInMilliseconds | Integer | No | Allows the user to set an upper bound on + * the amount of time it takes for semantic enrichment to finish processing before the request fails. |
| answers | String | No | This parameter is only valid if the query type is `semantic`. + * If set, the query returns answers extracted from key passages in the highest ranked documents. The number of + * answers returned can be configured by appending the pipe character `|` followed by the `count-<number of + * answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The + * confidence threshold can be configured by appending the pipe character `|` followed by the + * `threshold-<confidence threshold>` option after the answers parameter value, such as + * `extractive|threshold-0.9`. Default threshold is 0.7. The maximum character length of answers can be configured + * by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as + * 'extractive|maxcharlength-600'. Allowed values: "none", "extractive". |
| captions | String | No | This parameter is only valid if the query type is `semantic`. + * If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is + * set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character + * `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to + * `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed + * by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'. Allowed + * values: "none", "extractive". |
| semanticQuery | String | No | Allows setting a separate search query that will be + * solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there + * is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic + * phase. |
| queryRewrites | String | No | When QueryRewrites is set to `generative`, the query + * terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the + * request. The requested count can be configured by appending the pipe character `|` followed by the + * `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. This parameter is + * only valid if the query type is `semantic`. Allowed values: "none", "generative". |
| debug | String | No | Enables a debugging tool that can be used to further explore your + * search results. Allowed values: "disabled", "semantic", "vector", "queryRewrites", "innerHits", "all". |
| queryLanguage | String | No | The language of the query. Allowed values: "none", + * "en-us", "en-gb", "en-in", "en-ca", "en-au", "fr-fr", "fr-ca", "de-de", "es-es", "es-mx", "zh-cn", "zh-tw", + * "pt-br", "pt-pt", "it-it", "ja-jp", "ko-kr", "ru-ru", "cs-cz", "nl-be", "nl-nl", "hu-hu", "pl-pl", "sv-se", + * "tr-tr", "hi-in", "ar-sa", "ar-eg", "ar-ma", "ar-kw", "ar-jo", "da-dk", "no-no", "bg-bg", "hr-hr", "hr-ba", + * "ms-my", "ms-bn", "sl-sl", "ta-in", "vi-vn", "el-gr", "ro-ro", "is-is", "id-id", "th-th", "lt-lt", "uk-ua", + * "lv-lv", "et-ee", "ca-es", "fi-fi", "sr-ba", "sr-me", "sr-rs", "sk-sk", "nb-no", "hy-am", "bn-in", "eu-es", + * "gl-es", "gu-in", "he-il", "ga-ie", "kn-in", "ml-in", "mr-in", "fa-ae", "pa-in", "te-in", "ur-pk". |
| speller | String | No | Improve search recall by spell-correcting individual search + * query terms. Allowed values: "none", "lexicon". |
| semanticFields | List<String> | No | The list of field names used for semantic + * ranking. In the form of "," separated string. |
Header Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-query-source-authorization | String | No | Token identifying the user for which + * the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-enable-elevated-read | Boolean | No | A value that enables elevated read that + * bypass document level permission checks for the query operation. |
Response Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "1");
- * searchDocument.put("hotelName", "test");
- * searchAsyncClient.uploadDocumentsWithResponse(Collections.singletonList(searchDocument), null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
+ * {@code
+ * {
+ * @odata.count: Long (Optional)
+ * @search.coverage: Double (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (Required){
+ * count: Long (Optional)
+ * avg: Double (Optional)
+ * min: Double (Optional)
+ * max: Double (Optional)
+ * sum: Double (Optional)
+ * cardinality: Long (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * }
+ * @search.answers (Optional): [
+ * (Optional){
+ * score: Double (Optional)
+ * key: String (Optional)
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.debug (Optional): {
+ * queryRewrites (Optional): {
+ * text (Optional): {
+ * inputQuery: String (Optional)
+ * rewrites (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * vectors (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * }
+ * @search.nextPageParameters (Optional): {
+ * count: Boolean (Optional)
+ * facets (Optional): [
+ * String (Optional)
+ * ]
+ * filter: String (Optional)
+ * highlight (Optional): [
+ * String (Optional)
+ * ]
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * queryType: String(simple/full/semantic) (Optional)
+ * scoringStatistics: String(local/global) (Optional)
+ * sessionId: String (Optional)
+ * scoringParameters (Optional): [
+ * String (Optional)
+ * ]
+ * scoringProfile: String (Optional)
+ * debug: String(disabled/semantic/vector/queryRewrites/innerHits/all) (Optional)
+ * search: String (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * searchMode: String(any/all) (Optional)
+ * queryLanguage: String(none/en-us/en-gb/en-in/en-ca/en-au/fr-fr/fr-ca/de-de/es-es/es-mx/zh-cn/zh-tw/pt-br/pt-pt/it-it/ja-jp/ko-kr/ru-ru/cs-cz/nl-be/nl-nl/hu-hu/pl-pl/sv-se/tr-tr/hi-in/ar-sa/ar-eg/ar-ma/ar-kw/ar-jo/da-dk/no-no/bg-bg/hr-hr/hr-ba/ms-my/ms-bn/sl-sl/ta-in/vi-vn/el-gr/ro-ro/is-is/id-id/th-th/lt-lt/uk-ua/lv-lv/et-ee/ca-es/fi-fi/sr-ba/sr-me/sr-rs/sk-sk/nb-no/hy-am/bn-in/eu-es/gl-es/gu-in/he-il/ga-ie/kn-in/ml-in/mr-in/fa-ae/pa-in/te-in/ur-pk) (Optional)
+ * speller: String(none/lexicon) (Optional)
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * skip: Integer (Optional)
+ * top: Integer (Optional)
+ * semanticConfiguration: String (Optional)
+ * semanticErrorHandling: String(partial/fail) (Optional)
+ * semanticMaxWaitInMilliseconds: Integer (Optional)
+ * semanticQuery: String (Optional)
+ * answers: String(none/extractive) (Optional)
+ * captions: String(none/extractive) (Optional)
+ * queryRewrites: String(none/generative) (Optional)
+ * semanticFields (Optional): [
+ * String (Optional)
+ * ]
+ * vectorQueries (Optional): [
+ * (Optional){
+ * kind: String(vector/text/imageUrl/imageBinary) (Required)
+ * k: Integer (Optional)
+ * fields: String (Optional)
+ * exhaustive: Boolean (Optional)
+ * oversampling: Double (Optional)
+ * weight: Double (Optional)
+ * threshold (Optional): {
+ * kind: String(vectorSimilarity/searchScore) (Required)
+ * }
+ * filterOverride: String (Optional)
+ * perDocumentVectorLimit: Integer (Optional)
+ * }
+ * ]
+ * vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
+ * hybridSearch (Optional): {
+ * maxTextRecallSize: Integer (Optional)
+ * countAndFacetMode: String(countRetrievableResults/countAllResults) (Optional)
+ * }
+ * }
+ * value (Required): [
+ * (Required){
+ * @search.score: double (Required)
+ * @search.rerankerScore: Double (Optional)
+ * @search.rerankerBoostedScore: Double (Optional)
+ * @search.highlights (Optional): {
+ * String (Required): [
+ * String (Required)
+ * ]
+ * }
+ * @search.captions (Optional): [
+ * (Optional){
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.documentDebugInfo (Optional): {
+ * semantic (Optional): {
+ * titleField (Optional): {
+ * name: String (Optional)
+ * state: String(used/unused/partial) (Optional)
+ * }
+ * contentFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * keywordFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * rerankerInput (Optional): {
+ * title: String (Optional)
+ * content: String (Optional)
+ * keywords: String (Optional)
+ * }
+ * }
+ * vectors (Optional): {
+ * subscores (Optional): {
+ * text (Optional): {
+ * searchScore: Double (Optional)
+ * }
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): {
+ * searchScore: Double (Optional)
+ * vectorSimilarity: Double (Optional)
+ * }
+ * }
+ * ]
+ * documentBoost: Double (Optional)
+ * }
+ * }
+ * innerHits (Optional): {
+ * String (Required): [
+ * (Required){
+ * ordinal: Long (Optional)
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): (recursive schema, see String above)
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @odata.nextLink: String (Optional)
+ * @search.semanticPartialResponseReason: String(maxWaitExceeded/capacityOverloaded/transient) (Optional)
+ * @search.semanticPartialResponseType: String(baseResults/rerankedResults) (Optional)
+ * @search.semanticQueryRewritesResultType: String(originalQueryOnly) (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to upload to the target Index.
- * @param options Options that allow specifying document indexing behavior.
- * @return A response containing the result of the document indexing actions.
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing search results from an index along with {@link Response} on successful completion of
+ * {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono- * 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, - * {@code 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}). - * - *
Code Sample
- * - *Merge dynamic SearchDocument.
- * - * + * Searches for documents in the index. + *Header Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-query-source-authorization | String | No | Token identifying the user for which + * the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-enable-elevated-read | Boolean | No | A value that enables elevated read that + * bypass document level permission checks for the query operation. |
Request Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelName", "merge");
- * SEARCH_ASYNC_CLIENT.mergeDocuments(Collections.singletonList(searchDocument))
- * .subscribe(result -> {
- * for (IndexingResult indexingResult : result.getResults()) {
- * System.out.printf("Does document with key %s merge successfully? %b%n", indexingResult.getKey(),
- * indexingResult.isSucceeded());
- * }
- * });
+ * {@code
+ * {
+ * count: Boolean (Optional)
+ * facets (Optional): [
+ * String (Optional)
+ * ]
+ * filter: String (Optional)
+ * highlight (Optional): [
+ * String (Optional)
+ * ]
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * queryType: String(simple/full/semantic) (Optional)
+ * scoringStatistics: String(local/global) (Optional)
+ * sessionId: String (Optional)
+ * scoringParameters (Optional): [
+ * String (Optional)
+ * ]
+ * scoringProfile: String (Optional)
+ * debug: String(disabled/semantic/vector/queryRewrites/innerHits/all) (Optional)
+ * search: String (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * searchMode: String(any/all) (Optional)
+ * queryLanguage: String(none/en-us/en-gb/en-in/en-ca/en-au/fr-fr/fr-ca/de-de/es-es/es-mx/zh-cn/zh-tw/pt-br/pt-pt/it-it/ja-jp/ko-kr/ru-ru/cs-cz/nl-be/nl-nl/hu-hu/pl-pl/sv-se/tr-tr/hi-in/ar-sa/ar-eg/ar-ma/ar-kw/ar-jo/da-dk/no-no/bg-bg/hr-hr/hr-ba/ms-my/ms-bn/sl-sl/ta-in/vi-vn/el-gr/ro-ro/is-is/id-id/th-th/lt-lt/uk-ua/lv-lv/et-ee/ca-es/fi-fi/sr-ba/sr-me/sr-rs/sk-sk/nb-no/hy-am/bn-in/eu-es/gl-es/gu-in/he-il/ga-ie/kn-in/ml-in/mr-in/fa-ae/pa-in/te-in/ur-pk) (Optional)
+ * speller: String(none/lexicon) (Optional)
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * skip: Integer (Optional)
+ * top: Integer (Optional)
+ * semanticConfiguration: String (Optional)
+ * semanticErrorHandling: String(partial/fail) (Optional)
+ * semanticMaxWaitInMilliseconds: Integer (Optional)
+ * semanticQuery: String (Optional)
+ * answers: String(none/extractive) (Optional)
+ * captions: String(none/extractive) (Optional)
+ * queryRewrites: String(none/generative) (Optional)
+ * semanticFields (Optional): [
+ * String (Optional)
+ * ]
+ * vectorQueries (Optional): [
+ * (Optional){
+ * kind: String(vector/text/imageUrl/imageBinary) (Required)
+ * k: Integer (Optional)
+ * fields: String (Optional)
+ * exhaustive: Boolean (Optional)
+ * oversampling: Double (Optional)
+ * weight: Double (Optional)
+ * threshold (Optional): {
+ * kind: String(vectorSimilarity/searchScore) (Required)
+ * }
+ * filterOverride: String (Optional)
+ * perDocumentVectorLimit: Integer (Optional)
+ * }
+ * ]
+ * vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
+ * hybridSearch (Optional): {
+ * maxTextRecallSize: Integer (Optional)
+ * countAndFacetMode: String(countRetrievableResults/countAllResults) (Optional)
+ * }
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged
- * @return document index result
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
- */
- @ServiceMethod(returns = ReturnType.SINGLE)
- public Mono- * 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, - * {@code 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}). - * - *
Code Sample
- * - *Merge dynamic SearchDocument.
- * - * + * + *Response Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelName", "test");
- * searchAsyncClient.mergeDocumentsWithResponse(Collections.singletonList(searchDocument), null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
+ * {@code
+ * {
+ * @odata.count: Long (Optional)
+ * @search.coverage: Double (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (Required){
+ * count: Long (Optional)
+ * avg: Double (Optional)
+ * min: Double (Optional)
+ * max: Double (Optional)
+ * sum: Double (Optional)
+ * cardinality: Long (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * }
+ * @search.answers (Optional): [
+ * (Optional){
+ * score: Double (Optional)
+ * key: String (Optional)
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.debug (Optional): {
+ * queryRewrites (Optional): {
+ * text (Optional): {
+ * inputQuery: String (Optional)
+ * rewrites (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * vectors (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * }
+ * @search.nextPageParameters (Optional): {
+ * count: Boolean (Optional)
+ * facets (Optional): [
+ * String (Optional)
+ * ]
+ * filter: String (Optional)
+ * highlight (Optional): [
+ * String (Optional)
+ * ]
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * queryType: String(simple/full/semantic) (Optional)
+ * scoringStatistics: String(local/global) (Optional)
+ * sessionId: String (Optional)
+ * scoringParameters (Optional): [
+ * String (Optional)
+ * ]
+ * scoringProfile: String (Optional)
+ * debug: String(disabled/semantic/vector/queryRewrites/innerHits/all) (Optional)
+ * search: String (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * searchMode: String(any/all) (Optional)
+ * queryLanguage: String(none/en-us/en-gb/en-in/en-ca/en-au/fr-fr/fr-ca/de-de/es-es/es-mx/zh-cn/zh-tw/pt-br/pt-pt/it-it/ja-jp/ko-kr/ru-ru/cs-cz/nl-be/nl-nl/hu-hu/pl-pl/sv-se/tr-tr/hi-in/ar-sa/ar-eg/ar-ma/ar-kw/ar-jo/da-dk/no-no/bg-bg/hr-hr/hr-ba/ms-my/ms-bn/sl-sl/ta-in/vi-vn/el-gr/ro-ro/is-is/id-id/th-th/lt-lt/uk-ua/lv-lv/et-ee/ca-es/fi-fi/sr-ba/sr-me/sr-rs/sk-sk/nb-no/hy-am/bn-in/eu-es/gl-es/gu-in/he-il/ga-ie/kn-in/ml-in/mr-in/fa-ae/pa-in/te-in/ur-pk) (Optional)
+ * speller: String(none/lexicon) (Optional)
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * skip: Integer (Optional)
+ * top: Integer (Optional)
+ * semanticConfiguration: String (Optional)
+ * semanticErrorHandling: String(partial/fail) (Optional)
+ * semanticMaxWaitInMilliseconds: Integer (Optional)
+ * semanticQuery: String (Optional)
+ * answers: String(none/extractive) (Optional)
+ * captions: String(none/extractive) (Optional)
+ * queryRewrites: String(none/generative) (Optional)
+ * semanticFields (Optional): [
+ * String (Optional)
+ * ]
+ * vectorQueries (Optional): [
+ * (Optional){
+ * kind: String(vector/text/imageUrl/imageBinary) (Required)
+ * k: Integer (Optional)
+ * fields: String (Optional)
+ * exhaustive: Boolean (Optional)
+ * oversampling: Double (Optional)
+ * weight: Double (Optional)
+ * threshold (Optional): {
+ * kind: String(vectorSimilarity/searchScore) (Required)
+ * }
+ * filterOverride: String (Optional)
+ * perDocumentVectorLimit: Integer (Optional)
+ * }
+ * ]
+ * vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
+ * hybridSearch (Optional): {
+ * maxTextRecallSize: Integer (Optional)
+ * countAndFacetMode: String(countRetrievableResults/countAllResults) (Optional)
+ * }
+ * }
+ * value (Required): [
+ * (Required){
+ * @search.score: double (Required)
+ * @search.rerankerScore: Double (Optional)
+ * @search.rerankerBoostedScore: Double (Optional)
+ * @search.highlights (Optional): {
+ * String (Required): [
+ * String (Required)
+ * ]
+ * }
+ * @search.captions (Optional): [
+ * (Optional){
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.documentDebugInfo (Optional): {
+ * semantic (Optional): {
+ * titleField (Optional): {
+ * name: String (Optional)
+ * state: String(used/unused/partial) (Optional)
+ * }
+ * contentFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * keywordFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * rerankerInput (Optional): {
+ * title: String (Optional)
+ * content: String (Optional)
+ * keywords: String (Optional)
+ * }
+ * }
+ * vectors (Optional): {
+ * subscores (Optional): {
+ * text (Optional): {
+ * searchScore: Double (Optional)
+ * }
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): {
+ * searchScore: Double (Optional)
+ * vectorSimilarity: Double (Optional)
+ * }
+ * }
+ * ]
+ * documentBoost: Double (Optional)
+ * }
+ * }
+ * innerHits (Optional): {
+ * String (Required): [
+ * (Required){
+ * ordinal: Long (Optional)
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): (recursive schema, see String above)
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @odata.nextLink: String (Optional)
+ * @search.semanticPartialResponseReason: String(maxWaitExceeded/capacityOverloaded/transient) (Optional)
+ * @search.semanticPartialResponseType: String(baseResults/rerankedResults) (Optional)
+ * @search.semanticQueryRewritesResultType: String(originalQueryOnly) (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged
- * @param options Options that allow specifying document indexing behavior.
- * @return response containing the document index result.
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param searchPostRequest The searchPostRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing search results from an index along with {@link Response} on successful completion of
+ * {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono- * 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, - * {@code 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}). - * - *
Code Sample
- * - *Merge or upload dynamic SearchDocument.
- * - * + * Retrieves a document from the index. + *Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $select | List<String> | No | List of field names to retrieve for the document; + * Any field not retrieved will be missing from the returned document. In the form of "," separated + * string. |
Header Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-query-source-authorization | String | No | Token identifying the user for which + * the query is being executed. This token is used to enforce security restrictions on documents. |
| x-ms-enable-elevated-read | Boolean | No | A value that enables elevated read that + * bypass document level permission checks for the query operation. |
Response Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "1");
- * searchDocument.put("hotelName", "test");
- * SEARCH_ASYNC_CLIENT.mergeOrUploadDocuments(Collections.singletonList(searchDocument))
- * .subscribe(result -> {
- * for (IndexingResult indexingResult : result.getResults()) {
- * System.out.printf("Does document with key %s mergeOrUpload successfully? %b%n",
- * indexingResult.getKey(), indexingResult.isSucceeded());
- * }
- * });
+ * {@code
+ * {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged, if exists, otherwise uploaded
- * @return document index result
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param key The key of the document to retrieve.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a document retrieved via a document lookup operation along with {@link Response} on successful completion
+ * of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono- * 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, - * {@code 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}). - * - *
Code Sample
- * - *Merge or upload dynamic SearchDocument.
- * - * + * Suggests documents in the index that match the given partial query text. + *Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $filter | String | No | An OData expression that filters the documents considered for + * suggestions. |
| fuzzy | Boolean | No | A value indicating whether to use fuzzy matching for the + * suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or + * missing character in the search text. While this provides a better experience in some scenarios, it comes at a + * performance cost as fuzzy suggestions queries are slower and consume more resources. |
| highlightPostTag | String | No | A string tag that is appended to hit highlights. Must + * be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. |
| highlightPreTag | String | No | A string tag that is prepended to hit highlights. Must + * be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled. |
| minimumCoverage | Double | No | A number between 0 and 100 indicating the percentage of + * the index that must be covered by a suggestions query in order for the query to be reported as a success. This + * parameter can be useful for ensuring search availability even for services with only one replica. The default is + * 80. |
| $orderby | List<String> | No | The list of OData $orderby expressions by which to + * sort the results. Each expression can be either a field name or a call to either the geo.distance() or the + * search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate + * descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby + * is specified, the default sort order is descending by document match score. There can be at most 32 $orderby + * clauses. In the form of "," separated string. |
| searchFields | List<String> | No | The list of field names to search for the + * specified search text. Target fields must be included in the specified suggester. In the form of "," separated + * string. |
| $select | List<String> | No | The list of fields to retrieve. If unspecified, + * only the key field will be included in the results. In the form of "," separated string. |
| $top | Integer | No | The number of suggestions to retrieve. The value must be a number + * between 1 and 100. The default is 5. |
Response Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "1");
- * searchDocument.put("hotelName", "test");
- * searchAsyncClient.mergeOrUploadDocumentsWithResponse(Collections.singletonList(searchDocument), null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * @search.text: String (Required)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.coverage: Double (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged, if exists, otherwise uploaded
- * @param options Options that allow specifying document indexing behavior.
- * @return document index result
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param searchText The search text to use to suggest documents. Must be at least 1 character, and no more than 100
+ * characters.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing suggestion query results from an index along with {@link Response} on successful
+ * completion of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public MonoCode Sample
- * - *Delete dynamic SearchDocument.
- * - * + * Suggests documents in the index that match the given partial query text. + *Request Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "1");
- * searchDocument.put("hotelName", "test");
- * SEARCH_ASYNC_CLIENT.deleteDocuments(Collections.singletonList(searchDocument))
- * .subscribe(result -> {
- * for (IndexingResult indexingResult : result.getResults()) {
- * System.out.printf("Does document with key %s delete successfully? %b%n", indexingResult.getKey(),
- * indexingResult.isSucceeded());
- * }
- * });
+ * {@code
+ * {
+ * filter: String (Optional)
+ * fuzzy: Boolean (Optional)
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * search: String (Required)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * suggesterName: String (Required)
+ * top: Integer (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to delete from the target Index. Fields other than the key are ignored.
- * @return document index result.
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
- */
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoCode Sample
- * - *Delete dynamic SearchDocument.
- * - * + * + *Response Body Schema
+ * *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "1");
- * searchDocument.put("hotelName", "test");
- * searchAsyncClient.deleteDocumentsWithResponse(Collections.singletonList(searchDocument), null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * @search.text: String (Required)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.coverage: Double (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to delete from the target Index. Fields other than the key are ignored.
- * @param options Options that allow specifying document indexing behavior.
- * @return response containing the document index result.
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param suggestPostRequest The suggestPostRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing suggestion query results from an index along with {@link Response} on successful
+ * completion of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public MonoCode Sample
- * - *Index batch operation on dynamic SearchDocument.
- * - * + * Sends a batch of document write actions to the index. + *Request Body Schema
+ * *
- * 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));
- * SEARCH_ASYNC_CLIENT.indexDocuments(indexDocumentsBatch)
- * .subscribe(result -> {
- * for (IndexingResult indexingResult : result.getResults()) {
- * System.out.printf("Does document with key %s finish successfully? %b%n", indexingResult.getKey(),
- * indexingResult.isSucceeded());
- * }
- * });
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * @search.action: String(upload/merge/mergeOrUpload/delete) (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * }
+ * }
*
- *
- *
- * @param batch The batch of index actions
- * @return Response containing the status of operations for all actions in the batch.
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
- */
- @ServiceMethod(returns = ReturnType.SINGLE)
- public MonoCode Sample
- * - *Index batch operation on dynamic SearchDocument.
- * - * + * + *Response Body Schema
+ * *
- * 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));
- * searchAsyncClient.indexDocumentsWithResponse(indexDocumentsBatch, null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * key: String (Required)
+ * errorMessage: String (Optional)
+ * status: boolean (Required)
+ * statusCode: int (Required)
+ * }
+ * ]
+ * }
+ * }
*
- *
- *
- * @param batch The batch of index actions
- * @param options Options that allow specifying document indexing behavior.
- * @return Response containing the status of operations for all actions in the batch
- * @throws IndexBatchException If an indexing action fails but other actions succeed and modify the state of the
- * index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly catch
- * this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing result
- * reports the status of each indexing action in the batch, making it possible to determine the state of the index
- * after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param batch The batch of index actions.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing the status of operations for all documents in the indexing request along with
+ * {@link Response} on successful completion of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono- * View naming rules for guidelines on - * constructing valid document keys. - * - *
Code Sample
- * - *Get dynamic SearchDocument.
- * - * + * Autocompletes incomplete query terms based on input text and matching terms in the index. + *Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| autocompleteMode | String | No | Specifies the mode for Autocomplete. The default is + * 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing + * auto-completed terms. Allowed values: "oneTerm", "twoTerms", "oneTermWithContext". |
| $filter | String | No | An OData expression that filters the documents used to produce + * completed terms for the Autocomplete result. |
| fuzzy | Boolean | No | A value indicating whether to use fuzzy matching for the + * autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted + * or missing character in the search text. While this provides a better experience in some scenarios, it comes at a + * performance cost as fuzzy autocomplete queries are slower and consume more resources. |
| highlightPostTag | String | No | A string tag that is appended to hit highlights. Must + * be set with highlightPreTag. If omitted, hit highlighting is disabled. |
| highlightPreTag | String | No | A string tag that is prepended to hit highlights. Must + * be set with highlightPostTag. If omitted, hit highlighting is disabled. |
| minimumCoverage | Double | No | A number between 0 and 100 indicating the percentage of + * the index that must be covered by an autocomplete query in order for the query to be reported as a success. This + * parameter can be useful for ensuring search availability even for services with only one replica. The default is + * 80. |
| searchFields | List<String> | No | The list of field names to consider when + * querying for auto-completed terms. Target fields must be included in the specified suggester. In the form of "," + * separated string. |
| $top | Integer | No | The number of auto-completed terms to retrieve. This must be a + * value between 1 and 100. The default is 5. |
Response Body Schema
+ * *
- * SEARCH_ASYNC_CLIENT.getDocument("hotelId", SearchDocument.class)
- * .subscribe(result -> {
- * for (Map.Entry<String, Object> keyValuePair : result.entrySet()) {
- * System.out.printf("Document key %s, Document value %s", keyValuePair.getKey(),
- * keyValuePair.getValue());
- * }
- * });
+ * {@code
+ * {
+ * @search.coverage: Double (Optional)
+ * value (Required): [
+ * (Required){
+ * text: String (Required)
+ * queryPlusText: String (Required)
+ * }
+ * ]
+ * }
+ * }
*
- *
- *
- * @param key The key of the document to retrieve.
- * @param modelClass The model class converts to.
- * @param - * View naming rules for guidelines on - * constructing valid document keys. - * - *
Code Sample
- * - *Get dynamic SearchDocument.
- * - * + * Autocompletes incomplete query terms based on input text and matching terms in the index. + *Request Body Schema
+ * *
- * SEARCH_ASYNC_CLIENT.getDocument("hotelId", SearchDocument.class)
- * .subscribe(result -> {
- * for (Map.Entry<String, Object> keyValuePair : result.entrySet()) {
- * System.out.printf("Document key %s, Document value %s", keyValuePair.getKey(),
- * keyValuePair.getValue());
- * }
- * });
+ * {@code
+ * {
+ * search: String (Required)
+ * autocompleteMode: String(oneTerm/twoTerms/oneTermWithContext) (Optional)
+ * filter: String (Optional)
+ * fuzzy: Boolean (Optional)
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * suggesterName: String (Required)
+ * top: Integer (Optional)
+ * }
+ * }
*
- *
- *
- * @param key The key of the document to retrieve.
- * @param modelClass The model class converts to.
- * @param querySourceAuthorization Token identifying the user for which the query is being executed.
- * This token is used to enforce security restrictions on documents.
- * @param - * View naming rules for guidelines on - * constructing valid document keys. - * - *
Code Sample
- * - *Get dynamic SearchDocument.
- * - * + * + *Response Body Schema
+ * *
- * SEARCH_ASYNC_CLIENT.getDocumentWithResponse("hotelId", SearchDocument.class, null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
+ * {@code
+ * {
+ * @search.coverage: Double (Optional)
+ * value (Required): [
+ * (Required){
+ * text: String (Required)
+ * queryPlusText: String (Required)
+ * }
+ * ]
+ * }
+ * }
*
- *
- *
- * @param - * View naming rules for guidelines on - * constructing valid document keys. - * - *
Code Sample
- * - *Get dynamic SearchDocument.
- * - * - *
- * SEARCH_ASYNC_CLIENT.getDocumentWithResponse("hotelId", SearchDocument.class, null)
- * .subscribe(resultResponse -> {
- * 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());
- * }
- * });
- *
- *
- *
- * @param
- * View naming rules for guidelines on
- * constructing valid document keys.
- *
- * @param options Additional options for retrieving the document.
- * @param Code Sample Get document count. Code Sample Get document count.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedFlux} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedFlux} won't prevent you from exceeding the {@code $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.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedFlux} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedFlux} won't prevent you from exceeding the {@code $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.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedFlux} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedFlux} won't prevent you from exceeding the {@code $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.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedFlux} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedFlux} won't prevent you from exceeding the {@code $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. Code Sample Suggest text from documents in service. Code Sample Suggest text from documents in service with option. Code Sample Autocomplete text from documents in service. Code Sample Autocomplete text from documents in service with option.
- * Conceptually, a document is an entity in your index. Mapping this concept to more familiar database equivalents:
- * a search index equates to a table, and documents are roughly equivalent to rows in a table. Documents exist only
- * in an index, and are retrieved only through queries that target the documents collection (/docs) of an index. All
- * operations performed on the collection such as uploading, merging, deleting, or querying documents take place in
- * the context of a single index, so the URL format document operations will always include /indexes/[index name]/docs
- * for a given index name.
- *
- * This client provides a synchronous API for accessing and performing operations on indexed documents. This client
- * assists with searching your indexed documents, autocompleting partially typed search terms based on documents within the index,
- * suggesting the most likely matching text in documents as a user types. The client provides operations for adding, updating, and deleting
- * documents from an index.
- *
- * Authenticating and building instances of this client are handled by {@link SearchClientBuilder}. This sample shows
- * you how to authenticate and create an instance of the client:
- *
- * For more information on authentication and building, see the {@link SearchClientBuilder} documentation.
- *
- * The following examples all use a simple Hotel
- * data set that you can
- * import into your own index from the Azure portal.
- * These are just a few of the basics - please check out our Samples for much more.
- *
- * The following sample uploads a new document to an index.
- *
- * The following sample merges documents in an index.
- *
- * The following sample deletes a document from an index.
- *
- * The following sample gets a document from an index.
- *
- * The following sample searches for documents within an index.
- *
- * The following sample suggests the most likely matching text in documents.
- *
- * The following sample provides autocompletion for a partially typed query.
- * Code Sample Upload dynamic SearchDocument. Response Body Schema Code Sample Upload dynamic SearchDocument. Query Parameters Header Parameters Response Body Schema
- * 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, {@code
- * 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}).
- *
- * Code Sample Merge dynamic SearchDocument. Header Parameters Request Body Schema
- * 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, {@code
- * 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}).
- *
- * Code Sample Merge dynamic SearchDocument. Response Body Schema
- * 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, {@code
- * 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}).
- *
- * Code Sample Merge or upload dynamic SearchDocument. Query Parameters Header Parameters Response Body Schema
- * 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, {@code
- * 0} for {@code int} or false for {@code 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 {@code Integer} instead of {@code int}).
- *
- * Code Sample Merge or upload dynamic SearchDocument. Query Parameters Response Body Schema Code Sample Delete dynamic SearchDocument. Request Body Schema Response Body Schema Code Sample Delete dynamic SearchDocument. Request Body Schema Response Body Schema Code Sample Index batch operation on dynamic SearchDocument. Query Parameters Response Body Schema Code Sample Index batch operation on dynamic SearchDocument. Request Body Schema Response Body Schema
- * View naming rules for guidelines on
- * constructing valid document keys.
- *
- * Code Sample Get dynamic SearchDocument.
- * View naming rules for guidelines on
- * constructing valid document keys.
- *
- * Code Sample Get dynamic SearchDocument.
- * View naming rules for guidelines on
- * constructing valid document keys.
- *
- * Code Sample Get dynamic SearchDocument.
- * View naming rules for guidelines on
- * constructing valid document keys.
- *
- * @param options Additional options for retrieving the document.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @param Code Sample Get document count. Code Sample Get document count.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedIterable} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedIterable} won't prevent you from exceeding the {@code $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.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedIterable} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedIterable} won't prevent you from exceeding the {@code $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.
- * If {@code searchText} is set to null or {@code "*"} all documents will be matched, see
- * simple query
- * syntax in Azure AI Search for more information about search query syntax.
- *
- * The {@link SearchPagedIterable} will iterate through search result pages until all search results are returned.
- * Each page is determined by the {@code $skip} and {@code $top} values and the Search service has a limit on the
- * number of documents that can be skipped, more information about the {@code $skip} limit can be found at
- * Search Documents REST API and
- * reading the {@code $skip} description. If the total number of results exceeds the {@code $skip} limit the
- * {@link SearchPagedIterable} won't prevent you from exceeding the {@code $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. Code Sample Suggest text from documents in service. Code Sample Suggest text from documents in service with option. Code Sample Autocomplete text from documents in service. Code Sample Autocomplete text from documents in service with option.
- * This client allows you to create instances of {@link SearchClient} and {@link SearchAsyncClient} to
- * utilize synchronous and asynchronous APIs respectively to interact with Azure AI Search.
- *
- * Azure AI Search supports
- * Microsoft Entra ID (role-based) authentication and API keys for authentication.
- *
- * For more information about the scopes of authorization, see the Azure AI Search Security Overview documentation.
- *
- * To build an instance of {@link SearchClient} or {@link SearchAsyncClient} using API keys, call
- * {@link #buildClient() buildClient} and {@link #buildAsyncClient() buildAsyncClient} respectively from the
- * {@link SearchClientBuilder}.
- *
- * The following must be provided to construct a client instance.
- * Instantiating a synchronous Search Client Instantiating an asynchronous Search Client
- * You can also create a {@link SearchClient} or {@link SearchAsyncClient} using Microsoft Entra ID
- * authentication. Your user or service principal must be assigned the "Search Index Data Reader" role. Using the
- * DefaultAzureCredential you can authenticate a service using Managed Identity or a service principal, authenticate
- * as a developer working on an application, and more all without changing code. Please refer the documentation for
- * instructions on how to connect to Azure AI Search using Azure role-based access control (Azure RBAC).
- *
- * Before you can use the `DefaultAzureCredential`, or any credential type from Azure.Identity, you'll first need to install the Azure.Identity package.
- *
- * To use DefaultAzureCredential with a client ID and secret, you'll need to set the `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`,
- * and `AZURE_CLIENT_SECRET` environment variables; alternatively, you can pass those values to the
- * `ClientSecretCredential` also in azure-identity.
- *
- * Make sure you use the right namespace for DefaultAzureCredential at the top of your source file:
- *
- * Then you can create an instance of DefaultAzureCredential and pass it to a new instance of your client:
- * The following sample builds a SearchClient using DefaultAzureCredential. Instantiating a synchronous Search Client Instantiating an asynchronous Search Client
- * If {@link #pipeline(HttpPipeline) pipeline} is set, then only the {@code pipeline}, {@link #endpoint(String)
- * endpoint}, and {@link #indexName(String) indexName} are used to create the {@link SearchClient client}. All other
- * builder settings are ignored.
- *
- * @return A SearchClient with the options set from the builder.
- * @throws NullPointerException If {@code indexName} or {@code endpoint} are null.
- * @throws IllegalStateException If both {@link #retryOptions(RetryOptions)}
- * and {@link #retryPolicy(RetryPolicy)} have been set.
+ /*
+ * The HTTP client used to send the request.
*/
- public SearchClient buildClient() {
- validateIndexNameAndEndpoint();
- SearchServiceVersion buildVersion
- = (serviceVersion == null) ? SearchServiceVersion.getLatest() : serviceVersion;
-
- HttpPipeline pipeline = getHttpPipeline();
- JsonSerializer serializer
- = (jsonSerializer == null) ? JsonSerializerProviders.createInstance(true) : jsonSerializer;
- return new SearchClient(endpoint, indexName, buildVersion, pipeline, serializer,
- Utility.buildRestClient(buildVersion, endpoint, indexName, pipeline));
- }
+ @Generated
+ private HttpClient httpClient;
/**
- * Creates a {@link SearchAsyncClient} based on options set in the builder. Every time {@code buildAsyncClient()} is
- * called a new instance of {@link SearchAsyncClient} is created.
- *
- * If {@link #pipeline(HttpPipeline) pipeline} is set, then only the {@code pipeline}, {@link #endpoint(String)
- * endpoint}, and {@link #indexName(String) indexName} are used to create the {@link SearchAsyncClient client}. All
- * other builder settings are ignored.
- *
- * @return A SearchClient with the options set from the builder.
- * @throws NullPointerException If {@code indexName} or {@code endpoint} are null.
- * @throws IllegalStateException If both {@link #retryOptions(RetryOptions)}
- * and {@link #retryPolicy(RetryPolicy)} have been set.
+ * {@inheritDoc}.
*/
- public SearchAsyncClient buildAsyncClient() {
- validateIndexNameAndEndpoint();
- SearchServiceVersion buildVersion
- = (serviceVersion == null) ? SearchServiceVersion.getLatest() : serviceVersion;
-
- HttpPipeline pipeline = getHttpPipeline();
- JsonSerializer serializer
- = (jsonSerializer == null) ? JsonSerializerProviders.createInstance(true) : jsonSerializer;
- return new SearchAsyncClient(endpoint, indexName, buildVersion, pipeline, serializer,
- Utility.buildRestClient(buildVersion, endpoint, indexName, pipeline));
+ @Generated
+ @Override
+ public SearchClientBuilder httpClient(HttpClient httpClient) {
+ this.httpClient = httpClient;
+ return this;
}
- /**
- * Create a new instance of {@link SearchIndexingBufferedSenderBuilder} used to configure {@link
- * SearchIndexingBufferedSender SearchIndexingBufferedSenders} and {@link SearchIndexingBufferedAsyncSender
- * SearchIndexingBufferedAsyncSenders}.
- *
- * @param documentType The {@link TypeReference} representing the document type associated with the sender.
- * @param
- * The audience is not considered when using a {@link #credential(AzureKeyCredential) shared key}.
- *
- * If {@code audience} is null the public cloud audience will be assumed.
- *
- * @param audience The Audience to use for authentication with Microsoft Entra ID.
- * @return The updated SearchClientBuilder object.
+ /*
+ * The retry options to configure retry policy for failed requests.
*/
- public SearchClientBuilder audience(SearchAudience audience) {
- this.audience = audience;
- return this;
- }
+ @Generated
+ private RetryOptions retryOptions;
/**
- * Sets the name of the index.
- *
- * @param indexName Name of the index.
- * @return The updated SearchClientBuilder object.
- * @throws IllegalArgumentException If {@code indexName} is null or empty.
+ * {@inheritDoc}.
*/
- public SearchClientBuilder indexName(String indexName) {
- if (CoreUtils.isNullOrEmpty(indexName)) {
- throw LOGGER.logExceptionAsError(new IllegalArgumentException("'indexName' cannot be null or empty."));
- }
- this.indexName = indexName;
+ @Generated
+ @Override
+ public SearchClientBuilder retryOptions(RetryOptions retryOptions) {
+ this.retryOptions = retryOptions;
return this;
}
/**
- * Sets the {@link HttpLogOptions logging configuration} to use when sending and receiving requests to and from
- * the service. If a {@code logLevel} is not provided, default value of {@link HttpLogDetailLevel#NONE} is set.
- *
- * Note: It is important to understand the precedence order of the HttpTrait APIs. In
- * particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
- * they will be ignored. If no {@link HttpPipeline} is specified, a HTTP pipeline will be constructed internally
- * based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
- * trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
- * documentation of types that implement this trait to understand the full set of implications. Note: It is important to understand the precedence order of the HttpTrait APIs. In
- * particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
- * they will be ignored. If no {@link HttpPipeline} is specified, a HTTP pipeline will be constructed internally
- * based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
- * trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
- * documentation of types that implement this trait to understand the full set of implications. Note: It is important to understand the precedence order of the HttpTrait APIs. In
- * particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
- * they will be ignored. If no {@link HttpPipeline} is specified, a HTTP pipeline will be constructed internally
- * based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
- * trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
- * documentation of types that implement this trait to understand the full set of implications. Note: It is important to understand the precedence order of the HttpTrait APIs. In
- * particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
- * they will be ignored. If no {@link HttpPipeline} is specified, a HTTP pipeline will be constructed internally
- * based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
- * trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
- * documentation of types that implement this trait to understand the full set of implications. Note: It is important to understand the precedence order of the HttpTrait APIs. In
- * particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
- * they will be ignored. If no {@link HttpPipeline} is specified, a HTTP pipeline will be constructed internally
- * based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
- * trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
- * documentation of types that implement this trait to understand the full set of implications.
- * If {@code pipeline} is set, all other settings are ignored, aside from {@link #endpoint(String) endpoint} and
- * {@link #indexName(String) index} when building a {@link SearchClient} or {@link SearchAsyncClient}.
- *
- * @param httpPipeline {@link HttpPipeline} to use for sending service requests and receiving responses.
- * @return The updated SearchClientBuilder object.
+ /*
+ * The service endpoint
*/
- @Override
- public SearchClientBuilder pipeline(HttpPipeline httpPipeline) {
- if (this.httpPipeline != null && httpPipeline == null) {
- LOGGER.info("HttpPipeline is being set to 'null' when it was previously configured.");
- }
-
- this.httpPipeline = httpPipeline;
- return this;
- }
+ @Generated
+ private String endpoint;
/**
- * Sets the configuration store that is used during construction of the service client.
- *
- * The default configuration store is a clone of the {@link Configuration#getGlobalConfiguration() global
- * configuration store}, use {@link Configuration#NONE} to bypass using configuration settings during construction.
- *
- * @param configuration The configuration store that will be used.
- * @return The updated SearchClientBuilder object.
+ * {@inheritDoc}.
*/
+ @Generated
@Override
- public SearchClientBuilder configuration(Configuration configuration) {
- this.configuration = configuration;
+ public SearchClientBuilder endpoint(String endpoint) {
+ this.endpoint = endpoint;
return this;
}
- /**
- * Sets the {@link HttpPipelinePolicy} that will attempt to retry requests when needed.
- *
- * A default retry policy will be supplied if one isn't provided.
- *
- * Setting this is mutually exclusive with using {@link #retryOptions(RetryOptions)}.
- *
- * @param retryPolicy The {@link RetryPolicy} that will attempt to retry requests when needed.
- * @return The updated SearchClientBuilder object.
+ /*
+ * The name of the index.
*/
- public SearchClientBuilder retryPolicy(RetryPolicy retryPolicy) {
- this.retryPolicy = retryPolicy;
- return this;
- }
+ @Generated
+ private String indexName;
/**
- * Sets the {@link RetryOptions} for all the requests made through the client.
- *
- * Note: It is important to understand the precedence order of the HttpTrait APIs. In
- * particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
- * they will be ignored. If no {@link HttpPipeline} is specified, a HTTP pipeline will be constructed internally
- * based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
- * trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
- * documentation of types that implement this trait to understand the full set of implications.
- * Setting this is mutually exclusive with using {@link #retryPolicy(RetryPolicy)}.
- *
- * @param retryOptions The {@link RetryOptions} to use for all the requests made through the client.
- * @return The updated SearchClientBuilder object.
+ * Sets The name of the index.
+ *
+ * @param indexName the indexName value.
+ * @return the SearchClientBuilder.
*/
- @Override
- public SearchClientBuilder retryOptions(RetryOptions retryOptions) {
- this.retryOptions = retryOptions;
+ @Generated
+ public SearchClientBuilder indexName(String indexName) {
+ this.indexName = indexName;
return this;
}
+ /*
+ * Service version
+ */
+ @Generated
+ private SearchServiceVersion serviceVersion;
+
/**
- * Sets the {@link SearchServiceVersion} that is used when making API requests.
- *
- * If a service version is not provided, {@link SearchServiceVersion#getLatest()} will be used as a default. When
- * the default is used, updating to a newer client library may implicitly use a newer version of the service.
- *
- * @param serviceVersion The version of the service to be used when making requests.
- * @return The updated SearchClientBuilder object.
+ * Sets Service version.
+ *
+ * @param serviceVersion the serviceVersion value.
+ * @return the SearchClientBuilder.
*/
+ @Generated
public SearchClientBuilder serviceVersion(SearchServiceVersion serviceVersion) {
this.serviceVersion = serviceVersion;
return this;
}
- /**
- * This class provides a fluent builder API to help aid the configuration and instantiation of {@link
- * SearchIndexingBufferedSender SearchIndexingBufferedSenders} and {@link SearchIndexingBufferedAsyncSender
- * SearchIndexingBufferedAsyncSenders}. Call {@link #buildSender()} and {@link #buildAsyncSender()} respectively to
- * construct an instance of the desired sender.
- *
- * @param
- * The buffered sender will reset the duration when documents are sent for indexing, either by reaching {@link
- * #initialBatchActionCount(int)} or by a manual trigger.
- *
- * If {@code autoFlushInterval} is negative or zero and {@link #autoFlush(boolean)} is enabled the buffered
- * sender will only flush when {@link #initialBatchActionCount(int)} is met.
- *
- * @param autoFlushInterval Duration between document batches being sent for indexing.
- * @return The updated SearchIndexingBufferedSenderBuilder object.
- * @throws NullPointerException If {@code autoFlushInterval} is null.
- */
- public SearchIndexingBufferedSenderBuilder
- * This will only trigger a batch to be sent automatically if {@link #autoFlushInterval} is configured. Default
- * value is {@code 512}.
- *
- * @param initialBatchActionCount The number of documents in a batch that will trigger it to be indexed.
- * @return The updated SearchIndexingBufferedSenderBuilder object.
- * @throws IllegalArgumentException If {@code batchSize} is less than one.
- */
- public SearchIndexingBufferedSenderBuilder
- // * By default the batch size will halve when a 413 is returned with a minimum allowed value of one.
- // *
- // * @param scaleDownFunction The batch size scale down function.
- // * @return The updated SearchIndexingBufferedSenderOptions object.
- // * @throws NullPointerException If {@code scaleDownFunction} is null.
- // */
- // public SearchIndexingBufferedSenderOptions
- // * By default the batch size will halve when a 413 is returned with a minimum allowed value of one.
- // *
- // * @return The batch size scale down function.
- // */
- // public Function
- * Documents are only retried on retryable status codes.
- *
- * Default value is {@code 3}.
- *
- * @param maxRetriesPerAction The number of times a document will retry indexing before it is considered
- * failed.
- * @return The updated SearchIndexingBufferedSenderBuilder object.
- * @throws IllegalArgumentException If {@code maxRetriesPerAction} is less than one.
- */
- public SearchIndexingBufferedSenderBuilder
- * Default value is {@code Duration.ofMillis(800)}.
- *
- * @param throttlingDelay The initial duration requests will delay when the service is throttling.
- * @return The updated SearchIndexingBufferedSenderBuilder object.
- * @throws IllegalArgumentException If {@code throttlingDelay.isNegative()} or {@code throttlingDelay.isZero()}
- * is true.
- * @throws NullPointerException If {@code throttlingDelay} is null.
- */
- public SearchIndexingBufferedSenderBuilder
- * If {@code maxThrottlingDelay} is less than {@link #throttlingDelay(Duration)} then {@link
- * #throttlingDelay(Duration)} will be used as the maximum delay.
- *
- * Default value is {@code Duration.ofMinutes(1)}.
- *
- * @param maxThrottlingDelay The maximum duration requests will delay when the service is throttling.
- * @return The updated SearchIndexingBufferedSenderBuilder object.
- * @throws IllegalArgumentException If {@code maxThrottlingDelay.isNegative()} or {@code
- * maxThrottlingDelay.isZero()} is true.
- * @throws NullPointerException If {@code maxThrottlingDelay} is null.
- */
- public SearchIndexingBufferedSenderBuilder
- * The constructed OData filter expression is used by {@link AutocompleteOptions#setFilter(String)}, {@link
- * SearchOptions#setFilter(String)}, and {@link SuggestOptions#setFilter(String)}.
- *
- * For more information, see Filters in Azure Cognitive
- * Search.
- */
-public final class SearchFilter {
- private static final ClientLogger LOGGER;
- private static final Set
- * The format argument values will be quoted and escaped as necessary.
- *
- * @param formattableString The formattable string.
- * @param args The arguments for the formattable string.
- * @return A valid OData filter expression.
- */
- public static String create(String formattableString, Object... args) {
- if (formattableString == null) {
- return null;
- }
-
- if (CoreUtils.isNullOrEmpty(args)) {
- return formattableString;
- }
-
- return String.format(formattableString, cleanseArguments(args));
- }
-
- @SuppressWarnings("UseOfObsoleteDateTimeApi")
- private static Object[] cleanseArguments(Object... args) {
- Object[] cleanedArgs = new Object[args.length];
- for (int i = 0; i < args.length; i++) {
- Object arg = args[i];
- if (arg == null) {
- cleanedArgs[i] = null;
- continue;
- }
-
- Class argClass = arg.getClass();
- if (Objects.equals(arg, Float.NEGATIVE_INFINITY) || Objects.equals(arg, Double.NEGATIVE_INFINITY)) {
- cleanedArgs[i] = "-INF";
- } else if (Objects.equals(arg, Float.POSITIVE_INFINITY) || Objects.equals(arg, Double.POSITIVE_INFINITY)) {
- cleanedArgs[i] = "INF";
- } else if (SAFE_CLASSES.contains(argClass)) {
- cleanedArgs[i] = arg;
- } else if (arg instanceof Date) {
- cleanedArgs[i] = DateTimeFormatter.ISO_OFFSET_DATE_TIME
- .format(OffsetDateTime.ofInstant(((Date) arg).toInstant(), ZoneOffset.UTC));
- } else if (arg instanceof OffsetDateTime) {
- cleanedArgs[i] = DateTimeFormatter.ISO_OFFSET_DATE_TIME.format((OffsetDateTime) arg);
- } else if (arg instanceof CharSequence) {
- cleanedArgs[i] = quote(((CharSequence) arg).toString());
- } else if (argClass.isAssignableFrom(char.class) || arg instanceof Character) {
- cleanedArgs[i] = quote(((Character) arg).toString());
- } else if (arg instanceof GeoPosition) {
- GeoPosition position = (GeoPosition) arg;
- cleanedArgs[i] = SpatialFormatter.encodePoint(position.getLongitude(), position.getLatitude());
- } else if (arg instanceof GeoPoint) {
- GeoPosition position = ((GeoPoint) arg).getCoordinates();
- cleanedArgs[i] = SpatialFormatter.encodePoint(position.getLongitude(), position.getLatitude());
- } else if (arg instanceof GeoLineString) {
- cleanedArgs[i] = SpatialFormatter.encodePolygon((GeoLineString) arg, LOGGER);
- } else if (arg instanceof GeoPolygon) {
- cleanedArgs[i] = SpatialFormatter.encodePolygon((GeoPolygon) arg, LOGGER);
- } else {
- throw LOGGER.logExceptionAsError(new IllegalArgumentException(String.format(
- "Unable to convert argument %s from type %s to an OData literal.", arg, argClass.getName())));
- }
- }
-
- return cleanedArgs;
- }
-
- /*
- * Quote and escape OData strings.
- */
- private static String quote(String text) {
- if (text == null) {
- return "null";
- }
-
- // Optimistically allocate an extra 5% for escapes
- StringBuilder builder = new StringBuilder(2 + (int) (text.length() * 1.05)).append("'");
-
- for (char ch : text.toCharArray()) {
- builder.append(ch);
- if (ch == '\'') {
- builder.append(ch);
- }
- }
-
- return builder.append("'").toString();
- }
-
- private SearchFilter() {
- }
-}
diff --git a/sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchIndexingBufferedAsyncSender.java b/sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchIndexingBufferedAsyncSender.java
deleted file mode 100644
index 42bd2f4236f1..000000000000
--- a/sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchIndexingBufferedAsyncSender.java
+++ /dev/null
@@ -1,259 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-package com.azure.search.documents;
-
-import com.azure.core.annotation.ServiceClient;
-import com.azure.core.util.Context;
-import com.azure.core.util.logging.ClientLogger;
-import com.azure.core.util.serializer.JsonSerializer;
-import com.azure.search.documents.implementation.SearchIndexClientImpl;
-import com.azure.search.documents.implementation.batching.SearchIndexingAsyncPublisher;
-import com.azure.search.documents.models.IndexAction;
-import com.azure.search.documents.models.IndexActionType;
-import com.azure.search.documents.options.OnActionAddedOptions;
-import com.azure.search.documents.options.OnActionErrorOptions;
-import com.azure.search.documents.options.OnActionSentOptions;
-import com.azure.search.documents.options.OnActionSucceededOptions;
-import reactor.core.publisher.Mono;
-
-import java.time.Duration;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Timer;
-import java.util.TimerTask;
-import java.util.concurrent.atomic.AtomicReference;
-import java.util.concurrent.locks.ReentrantLock;
-import java.util.function.Consumer;
-import java.util.function.Function;
-
-import static com.azure.core.util.FluxUtil.withContext;
-
-/**
- * This class provides a buffered sender that contains operations for conveniently indexing documents to an Azure Search
- * index.
- *
- * @param
- * This configuration is only taken into account if auto flushing is enabled.
- *
- * @return The number of documents required before a flush is triggered.
- */
- int getBatchActionCount() {
- return publisher.getBatchSize();
- }
-
- /**
- * Adds upload document actions to the batch.
- *
- * If the client is enabled for automatic batch sending, adding documents may trigger the batch to be sent for
- * indexing.
- *
- * @param documents Documents to be uploaded.
- * @return A reactive response indicating that the documents have been added to the batch.
- */
- public Mono
- * If the client is enabled for automatic batch sending, adding documents may trigger the batch to be sent for
- * indexing.
- *
- * @param documents Documents to be deleted.
- * @return A reactive response indicating that the documents have been added to the batch.
- */
- public Mono
- * If the client is enabled for automatic batch sending, adding documents may trigger the batch to be sent for
- * indexing.
- *
- * @param documents Documents to be merged.
- * @return A reactive response indicating that the documents have been added to the batch.
- */
- public Mono
- * If the client is enabled for automatic batch sending, adding documents may trigger the batch to be sent for
- * indexing.
- *
- * @param documents Documents to be merged or uploaded.
- * @return A reactive response indicating that the documents have been added to the batch.
- */
- public Mono
- * If the client is enabled for automatic batch sending, adding documents may trigger the batch to be sent for
- * indexing.
- *
- * @param actions Index actions.
- * @return A reactive response indicating that the documents have been added to the batch.
- */
- public Mono
- * Once the buffered sender has been closed any attempts to add documents or flush it will cause an {@link
- * IllegalStateException} to be thrown.
- *
- * @return A reactive response indicating that the buffered sender has been closed.
- */
- public Mono
- * SEARCH_ASYNC_CLIENT.getDocumentCount()
- * .subscribe(count -> System.out.printf("There are %d documents in service.", count));
- *
- *
- *
- * @return the number of documents.
+ * Searches for documents in the index.
+ *
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing search results from an index on successful completion of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono
- * SEARCH_ASYNC_CLIENT.getDocumentCountWithResponse()
- * .subscribe(countResponse -> {
- * System.out.println("The status code of the response is " + countResponse.getStatusCode());
- * System.out.printf("There are %d documents in service.", countResponse.getValue());
- * });
- *
- *
- *
- * @return response containing the number of documents.
+ * Searches for documents in the index.
+ *
+ * @param options Options for searchPost API.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing search results from an index on successful completion of {@link Mono}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono
- * SearchPagedFlux searchPagedFlux = SEARCH_ASYNC_CLIENT.search("searchText");
- * searchPagedFlux.getTotalCount().subscribe(
- * count -> System.out.printf("There are around %d results.", count));
- *
- * AtomicLong numberOfDocumentsReturned = new AtomicLong();
- * searchPagedFlux.byPage()
- * .takeUntil(page -> {
- * // Reached the $skip limit, stop requesting more documents.
- * return numberOfDocumentsReturned.addAndGet(page.getValue().size()) >= SEARCH_SKIP_LIMIT;
- * })
- * .subscribe(resultResponse -> {
- * for (SearchResult result: resultResponse.getValue()) {
- * 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());
- * }
- * }
- * });
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @return A {@link SearchPagedFlux} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
- */
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedFlux search(String searchText) {
- return this.search(searchText, null, null);
- }
-
- /**
- * Searches for documents in the Azure AI Search index.
- *
- * SearchPagedFlux searchPagedFlux = SEARCH_ASYNC_CLIENT.search("searchText");
- * searchPagedFlux.getTotalCount().subscribe(
- * count -> System.out.printf("There are around %d results.", count));
- *
- * AtomicLong numberOfDocumentsReturned = new AtomicLong();
- * searchPagedFlux.byPage()
- * .takeUntil(page -> {
- * // Reached the $skip limit, stop requesting more documents.
- * return numberOfDocumentsReturned.addAndGet(page.getValue().size()) >= SEARCH_SKIP_LIMIT;
- * })
- * .subscribe(resultResponse -> {
- * for (SearchResult result: resultResponse.getValue()) {
- * 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());
- * }
- * }
- * });
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @param querySourceAuthorization Token identifying the user for which the query is being executed.
- * This token is used to enforce security restrictions on documents.
- * @return A {@link SearchPagedFlux} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
+ * Retrieves a document from the index.
+ *
+ * @param key The key of the document to retrieve.
+ * @param querySourceAuthorization Token identifying the user for which the query is being executed. This token is
+ * used to enforce security restrictions on documents.
+ * @param enableElevatedRead A value that enables elevated read that bypass document level permission checks for the
+ * query operation.
+ * @param selectedFields List of field names to retrieve for the document; Any field not retrieved will be missing
+ * from the returned document.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return a document retrieved via a document lookup operation on successful completion of {@link Mono}.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedFlux search(String searchText, String querySourceAuthorization) {
- return this.search(searchText, null, querySourceAuthorization, null);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono
- * SearchPagedFlux pagedFlux = SEARCH_ASYNC_CLIENT.search("searchText",
- * new SearchOptions().setOrderBy("hotelId desc"));
- *
- * pagedFlux.getTotalCount().subscribe(count -> System.out.printf("There are around %d results.", count));
- *
- * AtomicLong numberOfDocumentsReturned = new AtomicLong();
- * pagedFlux.byPage()
- * .takeUntil(page -> {
- * // Reached the $skip limit, stop requesting more documents.
- * return numberOfDocumentsReturned.addAndGet(page.getValue().size()) >= SEARCH_SKIP_LIMIT;
- * })
- * .subscribe(searchResultResponse -> searchResultResponse.getValue().forEach(searchDocument -> {
- * for (Map.Entry<String, Object> keyValuePair
- * : searchDocument.getDocument(SearchDocument.class).entrySet()) {
- * System.out.printf("Document key %s, document value %s", keyValuePair.getKey(),
- * keyValuePair.getValue());
- * }
- * }));
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @param searchOptions Parameters to further refine the search query
- * @return A {@link SearchPagedFlux} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
+ * Retrieves a document from the index.
+ *
+ * @param key The key of the document to retrieve.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return a document retrieved via a document lookup operation on successful completion of {@link Mono}.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedFlux search(String searchText, SearchOptions searchOptions) {
- return search(searchText, searchOptions, null);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono
- * SearchPagedFlux pagedFlux = SEARCH_ASYNC_CLIENT.search("searchText",
- * new SearchOptions().setOrderBy("hotelId desc"));
- *
- * pagedFlux.getTotalCount().subscribe(count -> System.out.printf("There are around %d results.", count));
- *
- * AtomicLong numberOfDocumentsReturned = new AtomicLong();
- * pagedFlux.byPage()
- * .takeUntil(page -> {
- * // Reached the $skip limit, stop requesting more documents.
- * return numberOfDocumentsReturned.addAndGet(page.getValue().size()) >= SEARCH_SKIP_LIMIT;
- * })
- * .subscribe(searchResultResponse -> searchResultResponse.getValue().forEach(searchDocument -> {
- * for (Map.Entry<String, Object> keyValuePair
- * : searchDocument.getDocument(SearchDocument.class).entrySet()) {
- * System.out.printf("Document key %s, document value %s", keyValuePair.getKey(),
- * keyValuePair.getValue());
- * }
- * }));
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @param searchOptions Parameters to further refine the search query
- * @param querySourceAuthorization Token identifying the user for which the query is being executed.
- * @return A {@link SearchPagedFlux} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
+ * Suggests documents in the index that match the given partial query text.
+ *
+ * @param searchText The search text to use to suggest documents. Must be at least 1 character, and no more than 100
+ * characters.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @param filter An OData expression that filters the documents considered for suggestions.
+ * @param useFuzzyMatching A value indicating whether to use fuzzy matching for the suggestions query. Default is
+ * false. When set to true, the query will find terms even if there's a substituted or missing character in the
+ * search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy
+ * suggestions queries are slower and consume more resources.
+ * @param highlightPostTag A string tag that is appended to hit highlights. Must be set with highlightPreTag. If
+ * omitted, hit highlighting of suggestions is disabled.
+ * @param highlightPreTag A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If
+ * omitted, hit highlighting of suggestions is disabled.
+ * @param minimumCoverage A number between 0 and 100 indicating the percentage of the index that must be covered by
+ * a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring
+ * search availability even for services with only one replica. The default is 80.
+ * @param orderBy The list of OData $orderby expressions by which to sort the results. Each expression can be either
+ * a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
+ * followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will
+ * be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
+ * document match score. There can be at most 32 $orderby clauses.
+ * @param searchFields The list of field names to search for the specified search text. Target fields must be
+ * included in the specified suggester.
+ * @param select The list of fields to retrieve. If unspecified, only the key field will be included in the results.
+ * @param top The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing suggestion query results from an index on successful completion of {@link Mono}.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedFlux search(String searchText, SearchOptions searchOptions, String querySourceAuthorization) {
- SearchRequest request = createSearchRequest(searchText, searchOptions);
- // The firstPageResponse shared among all functional calls below.
- // Do not initial new instance directly in func call.
- final SearchFirstPageResponseWrapper firstPageResponse = new SearchFirstPageResponseWrapper();
- Boolean enableElevatedRead = (searchOptions != null) ? searchOptions.isElevatedReadEnabled() : null;
- Function
- * SEARCH_ASYNC_CLIENT.suggest("searchText", "sg")
- * .subscribe(results -> {
- * for (Map.Entry<String, Object> keyValuePair: results.getDocument(SearchDocument.class).entrySet()) {
- * System.out.printf("Document key %s, document value %s", keyValuePair.getKey(),
- * keyValuePair.getValue());
- * }
- * });
- *
- *
- *
- * @param searchText The search text.
- * @param suggesterName The name of the suggester.
- * @return A {@link SuggestPagedFlux} that iterates over {@link SuggestResult} objects and provides access to the
- * {@link SuggestPagedResponse} object for each page containing HTTP response and coverage information.
- * @see Suggestions
+ * Suggests documents in the index that match the given partial query text.
+ *
+ * @param searchText The search text to use to suggest documents. Must be at least 1 character, and no more than 100
+ * characters.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing suggestion query results from an index on successful completion of {@link Mono}.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SuggestPagedFlux suggest(String searchText, String suggesterName) {
- return suggest(searchText, suggesterName, null);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ Mono
- * SEARCH_ASYNC_CLIENT.suggest("searchText", "sg",
- * new SuggestOptions().setOrderBy("hotelId desc"))
- * .subscribe(results -> {
- * for (Map.Entry<String, Object> keyValuePair: results.getDocument(SearchDocument.class).entrySet()) {
- * System.out.printf("Document key %s, document value %s", keyValuePair.getKey(),
- * keyValuePair.getValue());
- * }
- * });
- *
- *
- *
- * @param searchText The search text.
- * @param suggesterName The name of the suggester.
- * @param suggestOptions Parameters to further refine the suggestion query.
- * @return A {@link SuggestPagedFlux} that iterates over {@link SuggestResult} objects and provides access to the
- * {@link SuggestPagedResponse} object for each page containing HTTP response and coverage information.
- * @see Suggestions
+ * Suggests documents in the index that match the given partial query text.
+ *
+ * @param options Options for suggestPost API.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing suggestion query results from an index on successful completion of {@link Mono}.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SuggestPagedFlux suggest(String searchText, String suggesterName, SuggestOptions suggestOptions) {
- SuggestRequest suggestRequest
- = createSuggestRequest(searchText, suggesterName, Utility.ensureSuggestOptions(suggestOptions));
-
- return new SuggestPagedFlux(() -> withContext(context -> suggest(suggestRequest, context)));
- }
-
- private Mono
- * SEARCH_ASYNC_CLIENT.autocomplete("searchText", "sg")
- * .subscribe(result -> System.out.printf("The complete term is %s", result.getText()));
- *
- *
- *
- * @param searchText search text
- * @param suggesterName suggester name
- * @return auto complete result.
+ * Sends a batch of document write actions to the index.
+ *
+ * @param batch The batch of index actions.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing the status of operations for all documents in the indexing request on successful
+ * completion of {@link Mono}.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public AutocompletePagedFlux autocomplete(String searchText, String suggesterName) {
- return autocomplete(searchText, suggesterName, null);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ Mono
- * SEARCH_ASYNC_CLIENT.autocomplete("searchText", "sg",
- * new AutocompleteOptions().setAutocompleteMode(AutocompleteMode.ONE_TERM_WITH_CONTEXT))
- * .subscribe(result ->
- * System.out.printf("The complete term is %s", result.getText())
- * );
- *
- *
- *
- * @param searchText search text
- * @param suggesterName suggester name
- * @param autocompleteOptions autocomplete options
- * @return auto complete result.
- */
- public AutocompletePagedFlux autocomplete(String searchText, String suggesterName,
- AutocompleteOptions autocompleteOptions) {
- AutocompleteRequest request = createAutoCompleteRequest(searchText, suggesterName, autocompleteOptions);
-
- return new AutocompletePagedFlux(() -> withContext(context -> autocomplete(request, context)));
- }
-
- AutocompletePagedFlux autocomplete(String searchText, String suggesterName, AutocompleteOptions autocompleteOptions,
- Context context) {
- AutocompleteRequest request = createAutoCompleteRequest(searchText, suggesterName, autocompleteOptions);
-
- return new AutocompletePagedFlux(() -> autocomplete(request, context));
- }
-
- private Mono
- * Overview
- *
- *
- *
- * Getting Started
- *
- *
- *
- * SearchClient searchClient = new SearchClientBuilder()
- * .credential(new AzureKeyCredential("{key}"))
- * .endpoint("{endpoint}")
- * .indexName("{indexName}")
- * .buildClient();
- *
- *
- *
- *
- *
- *
- * Examples
- *
- *
- *
- * Upload a Document
- *
- *
- *
- * List<Hotel> hotels = new ArrayList<>();
- * hotels.add(new Hotel().setHotelId("100"));
- * hotels.add(new Hotel().setHotelId("200"));
- * hotels.add(new Hotel().setHotelId("300"));
- * searchClient.uploadDocuments(hotels);
- *
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#uploadDocuments(Iterable)}.
- *
- *
- *
- * Merge a Document
- *
- *
- *
- * List<Hotel> hotels = new ArrayList<>();
- * hotels.add(new Hotel().setHotelId("100"));
- * hotels.add(new Hotel().setHotelId("200"));
- * searchClient.mergeDocuments(hotels);
- *
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#mergeDocuments(Iterable)}.
- *
- *
- *
- * Delete a Document
- *
- *
- *
- * SearchDocument documentId = new SearchDocument();
- * documentId.put("hotelId", "100");
- * searchClient.deleteDocuments(Collections.singletonList(documentId));
- *
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#deleteDocuments(Iterable)}.
- *
- *
- *
- * Get a Document
- *
- *
- *
- * Hotel hotel = searchClient.getDocument("100", Hotel.class);
- * System.out.printf("Retrieved Hotel %s%n", hotel.getHotelId());
- *
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#getDocument(String, Class)}.
- *
- *
- *
- * Search Documents
- *
- *
- *
- * SearchDocument searchDocument = new SearchDocument();
- * searchDocument.put("hotelId", "8");
- * searchDocument.put("description", "budget");
- * searchDocument.put("descriptionFr", "motel");
- *
- * SearchDocument searchDocument1 = new SearchDocument();
- * searchDocument1.put("hotelId", "9");
- * searchDocument1.put("description", "budget");
- * searchDocument1.put("descriptionFr", "motel");
- *
- * List<SearchDocument> searchDocuments = new ArrayList<>();
- * searchDocuments.add(searchDocument);
- * searchDocuments.add(searchDocument1);
- * searchClient.uploadDocuments(searchDocuments);
- *
- * SearchPagedIterable results = searchClient.search("SearchText");
- * System.out.printf("There are %s results.%n", results.getTotalCount());
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#search(String)}.
- *
- *
- *
- * Make a Suggestion
- *
- *
- *
- * SuggestPagedIterable suggestPagedIterable = searchClient.suggest("searchText", "sg");
- * for (SuggestResult result: suggestPagedIterable) {
- * System.out.printf("The suggested text is %s", result.getText());
- * }
- *
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#suggest(String, String)}.
- *
- *
- *
- * Provide an Autocompletion
- *
- *
- *
- * AutocompletePagedIterable autocompletePagedIterable = searchClient.autocomplete("searchText", "sg");
- * for (AutocompleteItem result: autocompletePagedIterable) {
- * System.out.printf("The complete term is %s", result.getText());
- * }
- *
- *
- *
- *
- * For an asynchronous sample see {@link SearchAsyncClient#autocomplete(String, String)}.
- *
- *
- * @see SearchAsyncClient
- * @see SearchClientBuilder
- * @see com.azure.search.documents
+ * Initializes a new instance of the synchronous SearchClient type.
*/
@ServiceClient(builder = SearchClientBuilder.class)
public final class SearchClient {
- private static final ClientLogger LOGGER = new ClientLogger(SearchClient.class);
+ @Generated
+ private final SearchClientImpl serviceClient;
/**
- * Search REST API Version
+ * Initializes an instance of SearchClient class.
+ *
+ * @param serviceClient the service client implementation.
*/
- private final SearchServiceVersion serviceVersion;
-
- /**
- * The endpoint for the Azure AI Search service.
- */
- private final String endpoint;
-
- /**
- * The name of the Azure AI Search index.
- */
- private final String indexName;
-
- /**
- * The underlying AutoRest client used to interact with the Azure AI Search service
- */
- private final SearchIndexClientImpl restClient;
-
- /**
- * The pipeline that powers this client.
- */
- private final HttpPipeline httpPipeline;
-
- final JsonSerializer serializer;
-
- /**
- * Package private constructor to be used by {@link SearchClientBuilder}
- */
- SearchClient(String endpoint, String indexName, SearchServiceVersion serviceVersion, HttpPipeline httpPipeline,
- JsonSerializer serializer, SearchIndexClientImpl restClient) {
- this.endpoint = endpoint;
- this.indexName = indexName;
- this.serviceVersion = serviceVersion;
- this.httpPipeline = httpPipeline;
- this.serializer = serializer;
- this.restClient = restClient;
- }
-
- /**
- * Gets the name of the Azure AI Search index.
- *
- * @return the indexName value.
- */
- public String getIndexName() {
- return this.indexName;
- }
-
- /**
- * Gets the {@link HttpPipeline} powering this client.
- *
- * @return the pipeline.
- */
- HttpPipeline getHttpPipeline() {
- return this.httpPipeline;
+ @Generated
+ SearchClient(SearchClientImpl serviceClient) {
+ this.serviceClient = serviceClient;
}
/**
- * Gets the endpoint for the Azure AI Search service.
- *
- * @return the endpoint value.
- */
- public String getEndpoint() {
- return this.endpoint;
- }
-
- /**
- * Uploads a collection of documents to the target index.
- *
- *
- * 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());
- * }
+ * {@code
+ * long
+ * }
*
- *
- *
- * @param documents collection of documents to upload to the target Index.
- * @return document index result.
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a 64-bit integer along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public IndexDocumentsResult uploadDocuments(Iterable documents) {
- return uploadDocumentsWithResponse(documents, null, Context.NONE).getValue();
+ public Response
+ *
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Name Type Required Description search String No A full-text search query expression; Use "*" or omit this
+ * parameter to match all documents. $count Boolean No A value that specifies whether to fetch the total count of
+ * results. Default is false. Setting this value to true may have a performance impact. Note that the count returned
+ * is an approximation. facet List<String> No The list of facet expressions to apply to the search
+ * query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value
+ * pairs. Call {@link RequestOptions#addQueryParam} to add string to array. $filter String No The OData $filter expression to apply to the search
+ * query. highlight List<String> No The list of field names to use for hit
+ * highlights. Only searchable fields can be used for hit highlighting. In the form of "," separated
+ * string. highlightPostTag String No A string tag that is appended to hit highlights. Must
+ * be set with highlightPreTag. Default is </em>. highlightPreTag String No A string tag that is prepended to hit highlights. Must
+ * be set with highlightPostTag. Default is <em>. minimumCoverage Double No A number between 0 and 100 indicating the percentage of
+ * the index that must be covered by a search query in order for the query to be reported as a success. This
+ * parameter can be useful for ensuring search availability even for services with only one replica. The default is
+ * 100. $orderby List<String> No The list of OData $orderby expressions by which to
+ * sort the results. Each expression can be either a field name or a call to either the geo.distance() or the
+ * search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate
+ * descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy
+ * is specified, the default sort order is descending by document match score. There can be at most 32 $orderby
+ * clauses. In the form of "," separated string. queryType String No A value that specifies the syntax of the search query. The
+ * default is 'simple'. Use 'full' if your query uses the Lucene query syntax. Allowed values: "simple", "full",
+ * "semantic". scoringParameter List<String> No The list of parameter values to be used in
+ * scoring functions (for example, referencePointParameter) using the format name-values. For example, if the
+ * scoring profile defines a function with a parameter called 'mylocation' the parameter string would be
+ * "mylocation--122.2,44.8" (without the quotes). Call {@link RequestOptions#addQueryParam} to add string to
+ * array. scoringProfile String No The name of a scoring profile to evaluate match scores
+ * for matching documents in order to sort the results. searchFields List<String> No The list of field names to which to scope the
+ * full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names
+ * of each fielded search expression take precedence over any field names listed in this parameter. In the form of
+ * "," separated string. searchMode String No A value that specifies whether any or all of the search
+ * terms must be matched in order to count the document as a match. Allowed values: "any", "all". scoringStatistics String No A value that specifies whether we want to calculate
+ * scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower
+ * latency. Allowed values: "local", "global". sessionId String No A value to be used to create a sticky session, which can help
+ * to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to
+ * target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the
+ * load balancing of the requests across replicas and adversely affect the performance of the search service. The
+ * value used as sessionId cannot start with a '_' character. $select List<String> No The list of fields to retrieve. If unspecified, all
+ * fields marked as retrievable in the schema are included. In the form of "," separated string. $skip Integer No The number of search results to skip. This value cannot be
+ * greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation,
+ * consider using $orderby on a totally-ordered key and $filter with a range query instead. $top Integer No The number of search results to retrieve. This can be used in
+ * conjunction with $skip to implement client-side paging of search results. If results are truncated due to
+ * server-side paging, the response will include a continuation token that can be used to issue another Search
+ * request for the next page of results. semanticConfiguration String No The name of the semantic configuration that lists
+ * which fields should be used for semantic ranking, captions, highlights, and answers semanticErrorHandling String No Allows the user to choose whether a semantic call
+ * should fail completely, or to return partial results (default). Allowed values: "partial", "fail". semanticMaxWaitInMilliseconds Integer No Allows the user to set an upper bound on
+ * the amount of time it takes for semantic enrichment to finish processing before the request fails. answers String No This parameter is only valid if the query type is `semantic`.
+ * If set, the query returns answers extracted from key passages in the highest ranked documents. The number of
+ * answers returned can be configured by appending the pipe character `|` followed by the `count-<number of
+ * answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The
+ * confidence threshold can be configured by appending the pipe character `|` followed by the
+ * `threshold-<confidence threshold>` option after the answers parameter value, such as
+ * `extractive|threshold-0.9`. Default threshold is 0.7. The maximum character length of answers can be configured
+ * by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as
+ * 'extractive|maxcharlength-600'. Allowed values: "none", "extractive". captions String No This parameter is only valid if the query type is `semantic`.
+ * If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is
+ * set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character
+ * `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to
+ * `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed
+ * by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'. Allowed
+ * values: "none", "extractive". semanticQuery String No Allows setting a separate search query that will be
+ * solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there
+ * is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic
+ * phase. queryRewrites String No When QueryRewrites is set to `generative`, the query
+ * terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the
+ * request. The requested count can be configured by appending the pipe character `|` followed by the
+ * `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. This parameter is
+ * only valid if the query type is `semantic`. Allowed values: "none", "generative". debug String No Enables a debugging tool that can be used to further explore your
+ * search results. Allowed values: "disabled", "semantic", "vector", "queryRewrites", "innerHits", "all". queryLanguage String No The language of the query. Allowed values: "none",
+ * "en-us", "en-gb", "en-in", "en-ca", "en-au", "fr-fr", "fr-ca", "de-de", "es-es", "es-mx", "zh-cn", "zh-tw",
+ * "pt-br", "pt-pt", "it-it", "ja-jp", "ko-kr", "ru-ru", "cs-cz", "nl-be", "nl-nl", "hu-hu", "pl-pl", "sv-se",
+ * "tr-tr", "hi-in", "ar-sa", "ar-eg", "ar-ma", "ar-kw", "ar-jo", "da-dk", "no-no", "bg-bg", "hr-hr", "hr-ba",
+ * "ms-my", "ms-bn", "sl-sl", "ta-in", "vi-vn", "el-gr", "ro-ro", "is-is", "id-id", "th-th", "lt-lt", "uk-ua",
+ * "lv-lv", "et-ee", "ca-es", "fi-fi", "sr-ba", "sr-me", "sr-rs", "sk-sk", "nb-no", "hy-am", "bn-in", "eu-es",
+ * "gl-es", "gu-in", "he-il", "ga-ie", "kn-in", "ml-in", "mr-in", "fa-ae", "pa-in", "te-in", "ur-pk". speller String No Improve search recall by spell-correcting individual search
+ * query terms. Allowed values: "none", "lexicon". semanticFields List<String> No The list of field names used for semantic
+ * ranking. In the form of "," separated string.
+ *
+ * You can add these to a request with {@link RequestOptions#addHeader}
+ * Name Type Required Description x-ms-query-source-authorization String No Token identifying the user for which
+ * the query is being executed. This token is used to enforce security restrictions on documents. x-ms-enable-elevated-read Boolean No A value that enables elevated read that
+ * bypass document level permission checks for the query operation.
- * 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());
- * }
+ * {@code
+ * {
+ * @odata.count: Long (Optional)
+ * @search.coverage: Double (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (Required){
+ * count: Long (Optional)
+ * avg: Double (Optional)
+ * min: Double (Optional)
+ * max: Double (Optional)
+ * sum: Double (Optional)
+ * cardinality: Long (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * }
+ * @search.answers (Optional): [
+ * (Optional){
+ * score: Double (Optional)
+ * key: String (Optional)
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.debug (Optional): {
+ * queryRewrites (Optional): {
+ * text (Optional): {
+ * inputQuery: String (Optional)
+ * rewrites (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * vectors (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * }
+ * @search.nextPageParameters (Optional): {
+ * count: Boolean (Optional)
+ * facets (Optional): [
+ * String (Optional)
+ * ]
+ * filter: String (Optional)
+ * highlight (Optional): [
+ * String (Optional)
+ * ]
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * queryType: String(simple/full/semantic) (Optional)
+ * scoringStatistics: String(local/global) (Optional)
+ * sessionId: String (Optional)
+ * scoringParameters (Optional): [
+ * String (Optional)
+ * ]
+ * scoringProfile: String (Optional)
+ * debug: String(disabled/semantic/vector/queryRewrites/innerHits/all) (Optional)
+ * search: String (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * searchMode: String(any/all) (Optional)
+ * queryLanguage: String(none/en-us/en-gb/en-in/en-ca/en-au/fr-fr/fr-ca/de-de/es-es/es-mx/zh-cn/zh-tw/pt-br/pt-pt/it-it/ja-jp/ko-kr/ru-ru/cs-cz/nl-be/nl-nl/hu-hu/pl-pl/sv-se/tr-tr/hi-in/ar-sa/ar-eg/ar-ma/ar-kw/ar-jo/da-dk/no-no/bg-bg/hr-hr/hr-ba/ms-my/ms-bn/sl-sl/ta-in/vi-vn/el-gr/ro-ro/is-is/id-id/th-th/lt-lt/uk-ua/lv-lv/et-ee/ca-es/fi-fi/sr-ba/sr-me/sr-rs/sk-sk/nb-no/hy-am/bn-in/eu-es/gl-es/gu-in/he-il/ga-ie/kn-in/ml-in/mr-in/fa-ae/pa-in/te-in/ur-pk) (Optional)
+ * speller: String(none/lexicon) (Optional)
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * skip: Integer (Optional)
+ * top: Integer (Optional)
+ * semanticConfiguration: String (Optional)
+ * semanticErrorHandling: String(partial/fail) (Optional)
+ * semanticMaxWaitInMilliseconds: Integer (Optional)
+ * semanticQuery: String (Optional)
+ * answers: String(none/extractive) (Optional)
+ * captions: String(none/extractive) (Optional)
+ * queryRewrites: String(none/generative) (Optional)
+ * semanticFields (Optional): [
+ * String (Optional)
+ * ]
+ * vectorQueries (Optional): [
+ * (Optional){
+ * kind: String(vector/text/imageUrl/imageBinary) (Required)
+ * k: Integer (Optional)
+ * fields: String (Optional)
+ * exhaustive: Boolean (Optional)
+ * oversampling: Double (Optional)
+ * weight: Double (Optional)
+ * threshold (Optional): {
+ * kind: String(vectorSimilarity/searchScore) (Required)
+ * }
+ * filterOverride: String (Optional)
+ * perDocumentVectorLimit: Integer (Optional)
+ * }
+ * ]
+ * vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
+ * hybridSearch (Optional): {
+ * maxTextRecallSize: Integer (Optional)
+ * countAndFacetMode: String(countRetrievableResults/countAllResults) (Optional)
+ * }
+ * }
+ * value (Required): [
+ * (Required){
+ * @search.score: double (Required)
+ * @search.rerankerScore: Double (Optional)
+ * @search.rerankerBoostedScore: Double (Optional)
+ * @search.highlights (Optional): {
+ * String (Required): [
+ * String (Required)
+ * ]
+ * }
+ * @search.captions (Optional): [
+ * (Optional){
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.documentDebugInfo (Optional): {
+ * semantic (Optional): {
+ * titleField (Optional): {
+ * name: String (Optional)
+ * state: String(used/unused/partial) (Optional)
+ * }
+ * contentFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * keywordFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * rerankerInput (Optional): {
+ * title: String (Optional)
+ * content: String (Optional)
+ * keywords: String (Optional)
+ * }
+ * }
+ * vectors (Optional): {
+ * subscores (Optional): {
+ * text (Optional): {
+ * searchScore: Double (Optional)
+ * }
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): {
+ * searchScore: Double (Optional)
+ * vectorSimilarity: Double (Optional)
+ * }
+ * }
+ * ]
+ * documentBoost: Double (Optional)
+ * }
+ * }
+ * innerHits (Optional): {
+ * String (Required): [
+ * (Required){
+ * ordinal: Long (Optional)
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): (recursive schema, see String above)
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @odata.nextLink: String (Optional)
+ * @search.semanticPartialResponseReason: String(maxWaitExceeded/capacityOverloaded/transient) (Optional)
+ * @search.semanticPartialResponseType: String(baseResults/rerankedResults) (Optional)
+ * @search.semanticQueryRewritesResultType: String(originalQueryOnly) (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to upload to the target Index.
- * @param options Options that allow specifying document indexing behavior.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return response containing the document index result.
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing search results from an index along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Response
+ *
+ * You can add these to a request with {@link RequestOptions#addHeader}
+ * Name Type Required Description x-ms-query-source-authorization String No Token identifying the user for which
+ * the query is being executed. This token is used to enforce security restrictions on documents. x-ms-enable-elevated-read Boolean No A value that enables elevated read that
+ * bypass document level permission checks for the query operation.
- * 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());
- * }
+ * {@code
+ * {
+ * count: Boolean (Optional)
+ * facets (Optional): [
+ * String (Optional)
+ * ]
+ * filter: String (Optional)
+ * highlight (Optional): [
+ * String (Optional)
+ * ]
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * queryType: String(simple/full/semantic) (Optional)
+ * scoringStatistics: String(local/global) (Optional)
+ * sessionId: String (Optional)
+ * scoringParameters (Optional): [
+ * String (Optional)
+ * ]
+ * scoringProfile: String (Optional)
+ * debug: String(disabled/semantic/vector/queryRewrites/innerHits/all) (Optional)
+ * search: String (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * searchMode: String(any/all) (Optional)
+ * queryLanguage: String(none/en-us/en-gb/en-in/en-ca/en-au/fr-fr/fr-ca/de-de/es-es/es-mx/zh-cn/zh-tw/pt-br/pt-pt/it-it/ja-jp/ko-kr/ru-ru/cs-cz/nl-be/nl-nl/hu-hu/pl-pl/sv-se/tr-tr/hi-in/ar-sa/ar-eg/ar-ma/ar-kw/ar-jo/da-dk/no-no/bg-bg/hr-hr/hr-ba/ms-my/ms-bn/sl-sl/ta-in/vi-vn/el-gr/ro-ro/is-is/id-id/th-th/lt-lt/uk-ua/lv-lv/et-ee/ca-es/fi-fi/sr-ba/sr-me/sr-rs/sk-sk/nb-no/hy-am/bn-in/eu-es/gl-es/gu-in/he-il/ga-ie/kn-in/ml-in/mr-in/fa-ae/pa-in/te-in/ur-pk) (Optional)
+ * speller: String(none/lexicon) (Optional)
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * skip: Integer (Optional)
+ * top: Integer (Optional)
+ * semanticConfiguration: String (Optional)
+ * semanticErrorHandling: String(partial/fail) (Optional)
+ * semanticMaxWaitInMilliseconds: Integer (Optional)
+ * semanticQuery: String (Optional)
+ * answers: String(none/extractive) (Optional)
+ * captions: String(none/extractive) (Optional)
+ * queryRewrites: String(none/generative) (Optional)
+ * semanticFields (Optional): [
+ * String (Optional)
+ * ]
+ * vectorQueries (Optional): [
+ * (Optional){
+ * kind: String(vector/text/imageUrl/imageBinary) (Required)
+ * k: Integer (Optional)
+ * fields: String (Optional)
+ * exhaustive: Boolean (Optional)
+ * oversampling: Double (Optional)
+ * weight: Double (Optional)
+ * threshold (Optional): {
+ * kind: String(vectorSimilarity/searchScore) (Required)
+ * }
+ * filterOverride: String (Optional)
+ * perDocumentVectorLimit: Integer (Optional)
+ * }
+ * ]
+ * vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
+ * hybridSearch (Optional): {
+ * maxTextRecallSize: Integer (Optional)
+ * countAndFacetMode: String(countRetrievableResults/countAllResults) (Optional)
+ * }
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged
- * @return document index result
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
- */
- @ServiceMethod(returns = ReturnType.SINGLE)
- public IndexDocumentsResult mergeDocuments(Iterable documents) {
- return mergeDocumentsWithResponse(documents, null, Context.NONE).getValue();
- }
-
- /**
- * Merges a collection of documents with existing documents in the target index.
- *
- * 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());
- * }
+ * {@code
+ * {
+ * @odata.count: Long (Optional)
+ * @search.coverage: Double (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (Required){
+ * count: Long (Optional)
+ * avg: Double (Optional)
+ * min: Double (Optional)
+ * max: Double (Optional)
+ * sum: Double (Optional)
+ * cardinality: Long (Optional)
+ * @search.facets (Optional): {
+ * String (Required): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * }
+ * @search.answers (Optional): [
+ * (Optional){
+ * score: Double (Optional)
+ * key: String (Optional)
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.debug (Optional): {
+ * queryRewrites (Optional): {
+ * text (Optional): {
+ * inputQuery: String (Optional)
+ * rewrites (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * vectors (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * }
+ * }
+ * @search.nextPageParameters (Optional): {
+ * count: Boolean (Optional)
+ * facets (Optional): [
+ * String (Optional)
+ * ]
+ * filter: String (Optional)
+ * highlight (Optional): [
+ * String (Optional)
+ * ]
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * queryType: String(simple/full/semantic) (Optional)
+ * scoringStatistics: String(local/global) (Optional)
+ * sessionId: String (Optional)
+ * scoringParameters (Optional): [
+ * String (Optional)
+ * ]
+ * scoringProfile: String (Optional)
+ * debug: String(disabled/semantic/vector/queryRewrites/innerHits/all) (Optional)
+ * search: String (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * searchMode: String(any/all) (Optional)
+ * queryLanguage: String(none/en-us/en-gb/en-in/en-ca/en-au/fr-fr/fr-ca/de-de/es-es/es-mx/zh-cn/zh-tw/pt-br/pt-pt/it-it/ja-jp/ko-kr/ru-ru/cs-cz/nl-be/nl-nl/hu-hu/pl-pl/sv-se/tr-tr/hi-in/ar-sa/ar-eg/ar-ma/ar-kw/ar-jo/da-dk/no-no/bg-bg/hr-hr/hr-ba/ms-my/ms-bn/sl-sl/ta-in/vi-vn/el-gr/ro-ro/is-is/id-id/th-th/lt-lt/uk-ua/lv-lv/et-ee/ca-es/fi-fi/sr-ba/sr-me/sr-rs/sk-sk/nb-no/hy-am/bn-in/eu-es/gl-es/gu-in/he-il/ga-ie/kn-in/ml-in/mr-in/fa-ae/pa-in/te-in/ur-pk) (Optional)
+ * speller: String(none/lexicon) (Optional)
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * skip: Integer (Optional)
+ * top: Integer (Optional)
+ * semanticConfiguration: String (Optional)
+ * semanticErrorHandling: String(partial/fail) (Optional)
+ * semanticMaxWaitInMilliseconds: Integer (Optional)
+ * semanticQuery: String (Optional)
+ * answers: String(none/extractive) (Optional)
+ * captions: String(none/extractive) (Optional)
+ * queryRewrites: String(none/generative) (Optional)
+ * semanticFields (Optional): [
+ * String (Optional)
+ * ]
+ * vectorQueries (Optional): [
+ * (Optional){
+ * kind: String(vector/text/imageUrl/imageBinary) (Required)
+ * k: Integer (Optional)
+ * fields: String (Optional)
+ * exhaustive: Boolean (Optional)
+ * oversampling: Double (Optional)
+ * weight: Double (Optional)
+ * threshold (Optional): {
+ * kind: String(vectorSimilarity/searchScore) (Required)
+ * }
+ * filterOverride: String (Optional)
+ * perDocumentVectorLimit: Integer (Optional)
+ * }
+ * ]
+ * vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
+ * hybridSearch (Optional): {
+ * maxTextRecallSize: Integer (Optional)
+ * countAndFacetMode: String(countRetrievableResults/countAllResults) (Optional)
+ * }
+ * }
+ * value (Required): [
+ * (Required){
+ * @search.score: double (Required)
+ * @search.rerankerScore: Double (Optional)
+ * @search.rerankerBoostedScore: Double (Optional)
+ * @search.highlights (Optional): {
+ * String (Required): [
+ * String (Required)
+ * ]
+ * }
+ * @search.captions (Optional): [
+ * (Optional){
+ * text: String (Optional)
+ * highlights: String (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.documentDebugInfo (Optional): {
+ * semantic (Optional): {
+ * titleField (Optional): {
+ * name: String (Optional)
+ * state: String(used/unused/partial) (Optional)
+ * }
+ * contentFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * keywordFields (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * rerankerInput (Optional): {
+ * title: String (Optional)
+ * content: String (Optional)
+ * keywords: String (Optional)
+ * }
+ * }
+ * vectors (Optional): {
+ * subscores (Optional): {
+ * text (Optional): {
+ * searchScore: Double (Optional)
+ * }
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): {
+ * searchScore: Double (Optional)
+ * vectorSimilarity: Double (Optional)
+ * }
+ * }
+ * ]
+ * documentBoost: Double (Optional)
+ * }
+ * }
+ * innerHits (Optional): {
+ * String (Required): [
+ * (Required){
+ * ordinal: Long (Optional)
+ * vectors (Optional): [
+ * (Optional){
+ * String (Required): (recursive schema, see String above)
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ * }
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @odata.nextLink: String (Optional)
+ * @search.semanticPartialResponseReason: String(maxWaitExceeded/capacityOverloaded/transient) (Optional)
+ * @search.semanticPartialResponseType: String(baseResults/rerankedResults) (Optional)
+ * @search.semanticQueryRewritesResultType: String(originalQueryOnly) (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged.
- * @param options Options that allow specifying document indexing behavior.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return response containing the document index result.
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param searchPostRequest The searchPostRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing search results from an index along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Response
+ *
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Name Type Required Description $select List<String> No List of field names to retrieve for the document;
+ * Any field not retrieved will be missing from the returned document. In the form of "," separated
+ * string.
+ *
+ * You can add these to a request with {@link RequestOptions#addHeader}
+ * Name Type Required Description x-ms-query-source-authorization String No Token identifying the user for which
+ * the query is being executed. This token is used to enforce security restrictions on documents. x-ms-enable-elevated-read Boolean No A value that enables elevated read that
+ * bypass document level permission checks for the query operation.
- * 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());
- * }
+ * {@code
+ * {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged, if exists, otherwise uploaded
- * @return document index result
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param key The key of the document to retrieve.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a document retrieved via a document lookup operation along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public IndexDocumentsResult mergeOrUploadDocuments(Iterable documents) {
- return mergeOrUploadDocumentsWithResponse(documents, null, Context.NONE).getValue();
+ public Response
+ *
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Name Type Required Description $filter String No An OData expression that filters the documents considered for
+ * suggestions. fuzzy Boolean No A value indicating whether to use fuzzy matching for the
+ * suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or
+ * missing character in the search text. While this provides a better experience in some scenarios, it comes at a
+ * performance cost as fuzzy suggestions queries are slower and consume more resources. highlightPostTag String No A string tag that is appended to hit highlights. Must
+ * be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. highlightPreTag String No A string tag that is prepended to hit highlights. Must
+ * be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled. minimumCoverage Double No A number between 0 and 100 indicating the percentage of
+ * the index that must be covered by a suggestions query in order for the query to be reported as a success. This
+ * parameter can be useful for ensuring search availability even for services with only one replica. The default is
+ * 80. $orderby List<String> No The list of OData $orderby expressions by which to
+ * sort the results. Each expression can be either a field name or a call to either the geo.distance() or the
+ * search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate
+ * descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby
+ * is specified, the default sort order is descending by document match score. There can be at most 32 $orderby
+ * clauses. In the form of "," separated string. searchFields List<String> No The list of field names to search for the
+ * specified search text. Target fields must be included in the specified suggester. In the form of "," separated
+ * string. $select List<String> No The list of fields to retrieve. If unspecified,
+ * only the key field will be included in the results. In the form of "," separated string. $top Integer No The number of suggestions to retrieve. The value must be a number
+ * between 1 and 100. The default is 5.
- * 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());
- * }
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * @search.text: String (Required)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.coverage: Double (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to be merged, if exists, otherwise uploaded
- * @param options Options that allow specifying document indexing behavior.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return response containing a document index result
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param searchText The search text to use to suggest documents. Must be at least 1 character, and no more than 100
+ * characters.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing suggestion query results from an index along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Response
+ * {@code
+ * {
+ * filter: String (Optional)
+ * fuzzy: Boolean (Optional)
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * orderby (Optional): [
+ * String (Optional)
+ * ]
+ * search: String (Required)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * select (Optional): [
+ * String (Optional)
+ * ]
+ * suggesterName: String (Required)
+ * top: Integer (Optional)
+ * }
+ * }
+ *
+ *
+ *
- * 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());
- * }
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * @search.text: String (Required)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * @search.coverage: Double (Optional)
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to delete from the target Index. Fields other than the key are ignored.
- * @return document index result.
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param suggestPostRequest The suggestPostRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing suggestion query results from an index along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public IndexDocumentsResult deleteDocuments(Iterable documents) {
- return deleteDocumentsWithResponse(documents, null, Context.NONE).getValue();
+ Response
- * 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());
- * }
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * @search.action: String(upload/merge/mergeOrUpload/delete) (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * }
+ * }
*
- *
- *
- * @param documents collection of documents to delete from the target Index. Fields other than the key are ignored.
- * @param options Options that allow specifying document indexing behavior.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return response containing a document index result.
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * key: String (Required)
+ * errorMessage: String (Optional)
+ * status: boolean (Required)
+ * statusCode: int (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param batch The batch of index actions.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing the status of operations for all documents in the indexing request along with
+ * {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Response
+ *
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Name Type Required Description autocompleteMode String No Specifies the mode for Autocomplete. The default is
+ * 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing
+ * auto-completed terms. Allowed values: "oneTerm", "twoTerms", "oneTermWithContext". $filter String No An OData expression that filters the documents used to produce
+ * completed terms for the Autocomplete result. fuzzy Boolean No A value indicating whether to use fuzzy matching for the
+ * autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted
+ * or missing character in the search text. While this provides a better experience in some scenarios, it comes at a
+ * performance cost as fuzzy autocomplete queries are slower and consume more resources. highlightPostTag String No A string tag that is appended to hit highlights. Must
+ * be set with highlightPreTag. If omitted, hit highlighting is disabled. highlightPreTag String No A string tag that is prepended to hit highlights. Must
+ * be set with highlightPostTag. If omitted, hit highlighting is disabled. minimumCoverage Double No A number between 0 and 100 indicating the percentage of
+ * the index that must be covered by an autocomplete query in order for the query to be reported as a success. This
+ * parameter can be useful for ensuring search availability even for services with only one replica. The default is
+ * 80. searchFields List<String> No The list of field names to consider when
+ * querying for auto-completed terms. Target fields must be included in the specified suggester. In the form of ","
+ * separated string. $top Integer No The number of auto-completed terms to retrieve. This must be a
+ * value between 1 and 100. The default is 5.
- * 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());
- * }
+ * {@code
+ * {
+ * @search.coverage: Double (Optional)
+ * value (Required): [
+ * (Required){
+ * text: String (Required)
+ * queryPlusText: String (Required)
+ * }
+ * ]
+ * }
+ * }
*
- *
- *
- * @param batch The batch of index actions
- * @return Response containing the status of operations for all actions in the batch
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ * @param searchText The incomplete term which should be auto-completed.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the result of Autocomplete query along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public IndexDocumentsResult indexDocuments(IndexDocumentsBatch batch) {
- return indexDocumentsWithResponse(batch, null, Context.NONE).getValue();
+ Response
- * 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());
- * }
+ * {@code
+ * {
+ * search: String (Required)
+ * autocompleteMode: String(oneTerm/twoTerms/oneTermWithContext) (Optional)
+ * filter: String (Optional)
+ * fuzzy: Boolean (Optional)
+ * highlightPostTag: String (Optional)
+ * highlightPreTag: String (Optional)
+ * minimumCoverage: Double (Optional)
+ * searchFields (Optional): [
+ * String (Optional)
+ * ]
+ * suggesterName: String (Required)
+ * top: Integer (Optional)
+ * }
+ * }
*
- *
- *
- * @param batch The batch of index actions
- * @param options Options that allow specifying document indexing behavior.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return Response containing the status of operations for all actions in the batch
- * @throws IndexBatchException If some of the indexing actions fail but other actions succeed and modify the state
- * of the index. This can happen when the Search Service is under heavy indexing load. It is important to explicitly
- * catch this exception and check the return value {@link IndexBatchException#getIndexingResults()}. The indexing
- * result reports the status of each indexing action in the batch, making it possible to determine the state of the
- * index after a partial failure.
- * @see Add, update, or
- * delete documents
+ *
+ *
+ * {@code
+ * {
+ * @search.coverage: Double (Optional)
+ * value (Required): [
+ * (Required){
+ * text: String (Required)
+ * queryPlusText: String (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param autocompletePostRequest The autocompletePostRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the result of Autocomplete query along with {@link Response}.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Response
- * 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());
- * }
- *
- *
- *
- * @param key The key of the document to retrieve.
- * @param modelClass The model class converts to.
- * @param
- * 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());
- * }
- *
- *
- *
- * @param
- * 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());
- * }
- *
- *
- *
- * @param
- * long count = SEARCH_CLIENT.getDocumentCount();
- * System.out.printf("There are %d documents in service.", count);
- *
- *
- *
- * @return the number of documents.
+ * Retrieves a document from the index.
+ *
+ * @param key The key of the document to retrieve.
+ * @param querySourceAuthorization Token identifying the user for which the query is being executed. This token is
+ * used to enforce security restrictions on documents.
+ * @param enableElevatedRead A value that enables elevated read that bypass document level permission checks for the
+ * query operation.
+ * @param selectedFields List of field names to retrieve for the document; Any field not retrieved will be missing
+ * from the returned document.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return a document retrieved via a document lookup operation.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public long getDocumentCount() {
- return getDocumentCountWithResponse(Context.NONE).getValue();
+ public LookupDocument getDocument(String key, String querySourceAuthorization, Boolean enableElevatedRead,
+ List
- * 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());
- *
- *
- *
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return response containing the number of documents.
+ * Retrieves a document from the index.
+ *
+ * @param key The key of the document to retrieve.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return a document retrieved via a document lookup operation.
*/
+ @Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Response
- * 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;
- * }
- * }
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @return A {@link SearchPagedIterable} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
+ * Suggests documents in the index that match the given partial query text.
+ *
+ * @param searchText The search text to use to suggest documents. Must be at least 1 character, and no more than 100
+ * characters.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @param filter An OData expression that filters the documents considered for suggestions.
+ * @param useFuzzyMatching A value indicating whether to use fuzzy matching for the suggestions query. Default is
+ * false. When set to true, the query will find terms even if there's a substituted or missing character in the
+ * search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy
+ * suggestions queries are slower and consume more resources.
+ * @param highlightPostTag A string tag that is appended to hit highlights. Must be set with highlightPreTag. If
+ * omitted, hit highlighting of suggestions is disabled.
+ * @param highlightPreTag A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If
+ * omitted, hit highlighting of suggestions is disabled.
+ * @param minimumCoverage A number between 0 and 100 indicating the percentage of the index that must be covered by
+ * a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring
+ * search availability even for services with only one replica. The default is 80.
+ * @param orderBy The list of OData $orderby expressions by which to sort the results. Each expression can be either
+ * a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be
+ * followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will
+ * be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by
+ * document match score. There can be at most 32 $orderby clauses.
+ * @param searchFields The list of field names to search for the specified search text. Target fields must be
+ * included in the specified suggester.
+ * @param select The list of fields to retrieve. If unspecified, only the key field will be included in the results.
+ * @param top The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing suggestion query results from an index.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedIterable search(String searchText) {
- return search(searchText, null, Context.NONE);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ SuggestDocumentsResult suggestGet(String searchText, String suggesterName, String filter, Boolean useFuzzyMatching,
+ String highlightPostTag, String highlightPreTag, Double minimumCoverage, List
- * 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;
- * }
- * }
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @param searchOptions Parameters to further refine the search query
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return A {@link SearchPagedIterable} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
+ * Suggests documents in the index that match the given partial query text.
+ *
+ * @param searchText The search text to use to suggest documents. Must be at least 1 character, and no more than 100
+ * characters.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing suggestion query results from an index.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedIterable search(String searchText, SearchOptions searchOptions, Context context) {
- return search(searchText, searchOptions, null, context);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ SuggestDocumentsResult suggestGet(String searchText, String suggesterName) {
+ // Generated convenience method for suggestGetWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return suggestGetWithResponse(searchText, suggesterName, requestOptions).getValue()
+ .toObject(SuggestDocumentsResult.class);
}
/**
- * Searches for documents in the Azure AI Search index.
- *
- * 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;
- * }
- * }
- *
- *
- *
- * @param searchText A full-text search query expression.
- * @param searchOptions Parameters to further refine the search query
- * @param querySourceAuthorization Token identifying the user for which the query is being executed.
- * This token is used to enforce security restrictions on documents.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return A {@link SearchPagedIterable} that iterates over {@link SearchResult} objects and provides access to the
- * {@link SearchPagedResponse} object for each page containing HTTP response and count, facet, and coverage
- * information.
- * @see Search documents
+ * Suggests documents in the index that match the given partial query text.
+ *
+ * @param options Options for suggestPost API.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing suggestion query results from an index.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SearchPagedIterable search(String searchText, SearchOptions searchOptions, String querySourceAuthorization,
- Context context) {
- SearchRequest request = createSearchRequest(searchText, searchOptions);
- // The firstPageResponse shared among all functional calls below.
- // Do not initial new instance directly in func call.
- final SearchFirstPageResponseWrapper firstPageResponseWrapper = new SearchFirstPageResponseWrapper();
- Function
- * 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());
- * }
- * }
- *
- *
- *
- * @param searchText The search text on which to base suggestions
- * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
- * definition
- * @return A {@link SuggestPagedIterable} that iterates over {@link SuggestResult} objects and provides access to
- * the {@link SuggestPagedResponse} object for each page containing HTTP response and coverage information.
- * @see Suggestions
+ * Sends a batch of document write actions to the index.
+ *
+ * @param batch The batch of index actions.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing the status of operations for all documents in the indexing request.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SuggestPagedIterable suggest(String searchText, String suggesterName) {
- return suggest(searchText, suggesterName, null, Context.NONE);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ IndexDocumentsResult index(IndexDocumentsBatch batch) {
+ // Generated convenience method for indexWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return indexWithResponse(BinaryData.fromObject(batch), requestOptions).getValue()
+ .toObject(IndexDocumentsResult.class);
}
/**
- * Suggests documents in the index that match the given partial query.
- *
- *
- * 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());
- * }
- * }
- *
- *
- *
- * @param searchText The search text on which to base suggestions
+ * Autocompletes incomplete query terms based on input text and matching terms in the index.
+ *
+ * @param searchText The incomplete term which should be auto-completed.
* @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
- * definition
- * @param suggestOptions Parameters to further refine the suggestion query.
- * @param context additional context that is passed through the Http pipeline during the service call
- * @return A {@link SuggestPagedIterable} that iterates over {@link SuggestResult} objects and provides access to
- * the {@link SuggestPagedResponse} object for each page containing HTTP response and coverage information.
- * @see Suggestions
+ * definition.
+ * @param autocompleteMode Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get
+ * shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.
+ * @param filter An OData expression that filters the documents used to produce completed terms for the Autocomplete
+ * result.
+ * @param useFuzzyMatching A value indicating whether to use fuzzy matching for the autocomplete query. Default is
+ * false. When set to true, the query will find terms even if there's a substituted or missing character in the
+ * search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy
+ * autocomplete queries are slower and consume more resources.
+ * @param highlightPostTag A string tag that is appended to hit highlights. Must be set with highlightPreTag. If
+ * omitted, hit highlighting is disabled.
+ * @param highlightPreTag A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If
+ * omitted, hit highlighting is disabled.
+ * @param minimumCoverage A number between 0 and 100 indicating the percentage of the index that must be covered by
+ * an autocomplete query in order for the query to be reported as a success. This parameter can be useful for
+ * ensuring search availability even for services with only one replica. The default is 80.
+ * @param searchFields The list of field names to consider when querying for auto-completed terms. Target fields
+ * must be included in the specified suggester.
+ * @param top The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is
+ * 5.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the result of Autocomplete query.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public SuggestPagedIterable suggest(String searchText, String suggesterName, SuggestOptions suggestOptions,
- Context context) {
- SuggestRequest suggestRequest
- = createSuggestRequest(searchText, suggesterName, Utility.ensureSuggestOptions(suggestOptions));
- return new SuggestPagedIterable(() -> suggest(suggestRequest, context));
- }
-
- private SuggestPagedResponse suggest(SuggestRequest suggestRequest, Context context) {
- return Utility.executeRestCallWithExceptionHandling(() -> {
- Response
- * AutocompletePagedIterable autocompletePagedIterable = SEARCH_CLIENT.autocomplete("searchText", "sg");
- * for (AutocompleteItem result: autocompletePagedIterable) {
- * System.out.printf("The complete term is %s", result.getText());
- * }
- *
- *
- *
- * @param searchText search text
- * @param suggesterName suggester name
- * @return auto complete result.
+ *
+ * @param searchText The incomplete term which should be auto-completed.
+ * @param suggesterName The name of the suggester as specified in the suggesters collection that's part of the index
+ * definition.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the result of Autocomplete query.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public AutocompletePagedIterable autocomplete(String searchText, String suggesterName) {
- return autocomplete(searchText, suggesterName, null, Context.NONE);
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ AutocompleteResult autocompleteGet(String searchText, String suggesterName) {
+ // Generated convenience method for autocompleteGetWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return autocompleteGetWithResponse(searchText, suggesterName, requestOptions).getValue()
+ .toObject(AutocompleteResult.class);
}
/**
* Autocompletes incomplete query terms based on input text and matching terms in the index.
- *
- *
- * 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());
- * }
- *
- *
- *
- * @param searchText search text
- * @param suggesterName suggester name
- * @param autocompleteOptions autocomplete options
- * @param context additional context that is passed through the HTTP pipeline during the service call
- * @return auto complete result.
+ *
+ * @param options Options for autocompletePost API.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the result of Autocomplete query.
*/
- @ServiceMethod(returns = ReturnType.COLLECTION)
- public AutocompletePagedIterable autocomplete(String searchText, String suggesterName,
- AutocompleteOptions autocompleteOptions, Context context) {
- AutocompleteRequest request = createAutoCompleteRequest(searchText, suggesterName, autocompleteOptions);
-
- return new AutocompletePagedIterable(() -> autocomplete(request, context));
- }
-
- private AutocompletePagedResponse autocomplete(AutocompleteRequest request, Context context) {
- return Utility.executeRestCallWithExceptionHandling(() -> {
- Response
- * Overview
- *
- *
- *
- * Getting Started
- *
- *
- *
- * Authentication
- *
- *
- *
- * Building and Authenticating a {@link SearchClient} or {@link SearchAsyncClient} using API keys
- *
- *
- *
- *
- *
- *
- * SearchClient searchClient = new SearchClientBuilder()
- * .credential(new AzureKeyCredential("{key}"))
- * .endpoint("{endpoint}")
- * .indexName("{indexName}")
- * .buildClient();
- *
- *
- *
- *
- * SearchAsyncClient searchAsyncClient = new SearchClientBuilder()
- * .credential(new AzureKeyCredential("{key}"))
- * .endpoint("{endpoint}")
- * .indexName("{indexName}")
- * .buildAsyncClient();
- *
- *
- *
- *
- * Building and Authenticating a {@link SearchClient} or {@link SearchAsyncClient} using Microsoft Entra ID
- *
- *
- *
- * import com.azure.identity.DefaultAzureCredential;
- * import com.azure.identity.DefaultAzureCredentialBuilder;
- *
- *
- *
- *
- * DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
- *
- * SearchClient searchClient = new SearchClientBuilder()
- * .credential(credential)
- * .endpoint("{endpoint}")
- * .indexName("{indexName}")
- * .buildClient();
- *
- *
- *
- *
- * DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
- *
- * SearchAsyncClient searchAsyncClient = new SearchClientBuilder()
- * .credential(credential)
- * .endpoint("{endpoint}")
- * .indexName("{indexName}")
- * .buildAsyncClient();
- *
- *
- *
- * @see SearchClient
- * @see SearchAsyncClient
- * @see com.azure.search.documents
+ * A builder for creating a new instance of the SearchClient type.
*/
@ServiceClientBuilder(serviceClients = { SearchClient.class, SearchAsyncClient.class })
-public final class SearchClientBuilder
- implements AzureKeyCredentialTrait