From 69d256c26af36b1736f6570f5c351f5d7ec9a92c Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 7 Oct 2024 10:47:07 +0000 Subject: [PATCH] fix(specs): correct typos is Search API (generated) https://github.com/algolia/api-clients-automation/pull/3898 Co-authored-by: algolia-bot Co-authored-by: gazconroy Co-authored-by: Gary Conroy Co-authored-by: shortcuts --- .../java/com/algolia/api/SearchClient.java | 180 +++++++++--------- .../model/recommend/FallbackParams.java | 28 +-- .../model/recommend/NumericFilters.java | 2 +- .../algolia/model/recommend/QueryType.java | 2 +- .../recommend/RecommendSearchParams.java | 28 +-- .../model/recommend/RenderingContent.java | 2 +- .../model/recommend/TypoTolerance.java | 4 +- .../com/algolia/model/search/Anchoring.java | 4 +- .../java/com/algolia/model/search/ApiKey.java | 2 +- .../model/search/BrowseParamsObject.java | 13 +- .../model/search/ConsequenceParams.java | 13 +- .../algolia/model/search/DeleteByParams.java | 7 +- .../model/search/GetApiKeyResponse.java | 2 +- .../algolia/model/search/IndexSettings.java | 21 +- .../algolia/model/search/NumericFilters.java | 2 +- .../com/algolia/model/search/QueryType.java | 2 +- .../model/search/RenderingContent.java | 2 +- .../algolia/model/search/SearchForFacets.java | 13 +- .../algolia/model/search/SearchForHits.java | 13 +- .../model/search/SearchParamsObject.java | 13 +- .../model/search/SettingsResponse.java | 21 +- .../algolia/model/search/TypoTolerance.java | 4 +- 22 files changed, 193 insertions(+), 185 deletions(-) diff --git a/algoliasearch/src/main/java/com/algolia/api/SearchClient.java b/algoliasearch/src/main/java/com/algolia/api/SearchClient.java index e6a4643c9..e93a49a09 100644 --- a/algoliasearch/src/main/java/com/algolia/api/SearchClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/SearchClient.java @@ -115,7 +115,7 @@ public CompletableFuture addApiKeyAsync(@Nonnull ApiKey apiKe * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -138,7 +138,7 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject( * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @throws AlgoliaRuntimeException If it fails to process the API call */ @@ -156,7 +156,7 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject(@Nonnull String indexName * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -191,7 +191,7 @@ public CompletableFuture addOrUpdateObjectAsync( * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @throws AlgoliaRuntimeException If it fails to process the API call */ @@ -559,8 +559,8 @@ public CompletableFuture batchDictionaryEntriesAsync( * `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - * `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: * `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or - * `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your - * browse requests, they'll be ignored. + * `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse + * requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param browseParams (optional) @@ -588,8 +588,8 @@ public BrowseResponse browse( * `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - * `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: * `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or - * `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your - * browse requests, they'll be ignored. + * `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse + * requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param browseParams (optional) @@ -611,8 +611,8 @@ public BrowseResponse browse(@Nonnull String indexName, BrowseParams brow * `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - * `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: * `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or - * `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your - * browse requests, they'll be ignored. + * `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse + * requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param innerType The class held by the index, could be your custom class or {@link Object}. @@ -635,8 +635,8 @@ public BrowseResponse browse(@Nonnull String indexName, Class innerTyp * `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - * `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: * `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or - * `false` (`min` and `strict` is evaluated to `true`) If you send these parameters with your - * browse requests, they'll be ignored. + * `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse + * requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param innerType The class held by the index, could be your custom class or {@link Object}. @@ -656,8 +656,8 @@ public BrowseResponse browse(@Nonnull String indexName, Class innerTyp * `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - * `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: * `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - - * `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send - * these parameters with your browse requests, they'll be ignored. + * `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these + * parameters with your browse requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param browseParams (optional) @@ -692,8 +692,8 @@ public CompletableFuture> browseAsync( * `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - * `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: * `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - - * `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send - * these parameters with your browse requests, they'll be ignored. + * `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these + * parameters with your browse requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param browseParams (optional) @@ -715,8 +715,8 @@ public CompletableFuture> browseAsync(@Nonnull String inde * `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - * `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: * `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - - * `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send - * these parameters with your browse requests, they'll be ignored. + * `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these + * parameters with your browse requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param innerType The class held by the index, could be your custom class or {@link Object}. @@ -739,8 +739,8 @@ public CompletableFuture> browseAsync(@Nonnull String inde * `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - * `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: * `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - - * `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you send - * these parameters with your browse requests, they'll be ignored. + * `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these + * parameters with your browse requests, they'll be ignored. * * @param indexName Name of the index on which to perform the operation. (required) * @param innerType The class held by the index, could be your custom class or {@link Object}. @@ -2738,7 +2738,7 @@ public CompletableFuture> getSourcesAsync() throws AlgoliaRuntimeEx } /** - * Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` + * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` * operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Name of the index on which to perform the operation. (required) @@ -2753,7 +2753,7 @@ public SynonymHit getSynonym(@Nonnull String indexName, @Nonnull String objectID } /** - * Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` + * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` * operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Name of the index on which to perform the operation. (required) @@ -2765,7 +2765,7 @@ public SynonymHit getSynonym(@Nonnull String indexName, @Nonnull String objectID } /** - * (asynchronously) Retrieves a syonym by its ID. To find the object IDs for your synonyms, use + * (asynchronously) Retrieves a synonym by its ID. To find the object IDs for your synonyms, use * the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Name of the index on which to perform the operation. (required) @@ -2788,7 +2788,7 @@ public CompletableFuture getSynonymAsync(@Nonnull String indexName, } /** - * (asynchronously) Retrieves a syonym by its ID. To find the object IDs for your synonyms, use + * (asynchronously) Retrieves a synonym by its ID. To find the object IDs for your synonyms, use * the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Name of the index on which to perform the operation. (required) @@ -3447,7 +3447,7 @@ public CompletableFuture multipleBatchAsync(@Nonnull Batc * - Related guide: [Copy * indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) * **Move** - Moving a source index that doesn't exist is ignored without returning an error. - - * When moving an index, the analytics data keep their original name and a new set of analytics + * When moving an index, the analytics data keeps its original name, and a new set of analytics * data is started for the new name. To access the original analytics in the dashboard, create an * index with the original name. - If the destination index has replicas, moving will overwrite * the existing index and copy the data to the replica indices. - Related guide: [Move @@ -3479,7 +3479,7 @@ public UpdatedAtResponse operationIndex( * - Related guide: [Copy * indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) * **Move** - Moving a source index that doesn't exist is ignored without returning an error. - - * When moving an index, the analytics data keep their original name and a new set of analytics + * When moving an index, the analytics data keeps its original name, and a new set of analytics * data is started for the new name. To access the original analytics in the dashboard, create an * index with the original name. - If the destination index has replicas, moving will overwrite * the existing index and copy the data to the replica indices. - Related guide: [Move @@ -3506,7 +3506,7 @@ public UpdatedAtResponse operationIndex(@Nonnull String indexName, @Nonnull Oper * - Related guide: [Copy * indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) * **Move** - Moving a source index that doesn't exist is ignored without returning an error. - - * When moving an index, the analytics data keep their original name and a new set of analytics + * When moving an index, the analytics data keeps its original name, and a new set of analytics * data is started for the new name. To access the original analytics in the dashboard, create an * index with the original name. - If the destination index has replicas, moving will overwrite * the existing index and copy the data to the replica indices. - Related guide: [Move @@ -3547,7 +3547,7 @@ public CompletableFuture operationIndexAsync( * - Related guide: [Copy * indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) * **Move** - Moving a source index that doesn't exist is ignored without returning an error. - - * When moving an index, the analytics data keep their original name and a new set of analytics + * When moving an index, the analytics data keeps its original name, and a new set of analytics * data is started for the new name. To access the original analytics in the dashboard, create an * index with the original name. - If the destination index has replicas, moving will overwrite * the existing index and copy the data to the replica indices. - Related guide: [Move @@ -3565,7 +3565,7 @@ public CompletableFuture operationIndexAsync( } /** - * Adds new attributes to a record, or update existing ones. - If a record with the specified + * Adds new attributes to a record, or updates existing ones. - If a record with the specified * object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. * - If the index doesn't exist yet, this method creates a new index. - You can use any * first-level attribute but not nested attributes. If you specify a nested attribute, the engine @@ -3584,11 +3584,10 @@ public CompletableFuture operationIndexAsync( * the current value, and otherwise ignore the whole object update. For example, if you pass an * IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, * the engine updates the object. If the object doesn't exist yet, the engine only creates it if - * you pass an IncrementSet value that's greater than 0. You can specify an operation by providing - * an object with the attribute to update as the key and its value being an object with the - * following properties: - _operation: the operation to apply on the attribute - value: the - * right-hand side argument to the operation, for example, increment or decrement step, value to - * add or remove. + * you pass an IncrementSet value greater than 0. You can specify an operation by providing an + * object with the attribute to update as the key and its value being an object with the following + * properties: - _operation: the operation to apply on the attribute - value: the right-hand side + * argument to the operation, for example, increment or decrement step, value to add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3610,7 +3609,7 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( } /** - * Adds new attributes to a record, or update existing ones. - If a record with the specified + * Adds new attributes to a record, or updates existing ones. - If a record with the specified * object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. * - If the index doesn't exist yet, this method creates a new index. - You can use any * first-level attribute but not nested attributes. If you specify a nested attribute, the engine @@ -3629,11 +3628,10 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( * the current value, and otherwise ignore the whole object update. For example, if you pass an * IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, * the engine updates the object. If the object doesn't exist yet, the engine only creates it if - * you pass an IncrementSet value that's greater than 0. You can specify an operation by providing - * an object with the attribute to update as the key and its value being an object with the - * following properties: - _operation: the operation to apply on the attribute - value: the - * right-hand side argument to the operation, for example, increment or decrement step, value to - * add or remove. + * you pass an IncrementSet value greater than 0. You can specify an operation by providing an + * object with the attribute to update as the key and its value being an object with the following + * properties: - _operation: the operation to apply on the attribute - value: the right-hand side + * argument to the operation, for example, increment or decrement step, value to add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3652,7 +3650,7 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( } /** - * Adds new attributes to a record, or update existing ones. - If a record with the specified + * Adds new attributes to a record, or updates existing ones. - If a record with the specified * object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. * - If the index doesn't exist yet, this method creates a new index. - You can use any * first-level attribute but not nested attributes. If you specify a nested attribute, the engine @@ -3671,11 +3669,10 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( * the current value, and otherwise ignore the whole object update. For example, if you pass an * IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, * the engine updates the object. If the object doesn't exist yet, the engine only creates it if - * you pass an IncrementSet value that's greater than 0. You can specify an operation by providing - * an object with the attribute to update as the key and its value being an object with the - * following properties: - _operation: the operation to apply on the attribute - value: the - * right-hand side argument to the operation, for example, increment or decrement step, value to - * add or remove. + * you pass an IncrementSet value greater than 0. You can specify an operation by providing an + * object with the attribute to update as the key and its value being an object with the following + * properties: - _operation: the operation to apply on the attribute - value: the right-hand side + * argument to the operation, for example, increment or decrement step, value to add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3694,7 +3691,7 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( } /** - * Adds new attributes to a record, or update existing ones. - If a record with the specified + * Adds new attributes to a record, or updates existing ones. - If a record with the specified * object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. * - If the index doesn't exist yet, this method creates a new index. - You can use any * first-level attribute but not nested attributes. If you specify a nested attribute, the engine @@ -3713,11 +3710,10 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( * the current value, and otherwise ignore the whole object update. For example, if you pass an * IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, * the engine updates the object. If the object doesn't exist yet, the engine only creates it if - * you pass an IncrementSet value that's greater than 0. You can specify an operation by providing - * an object with the attribute to update as the key and its value being an object with the - * following properties: - _operation: the operation to apply on the attribute - value: the - * right-hand side argument to the operation, for example, increment or decrement step, value to - * add or remove. + * you pass an IncrementSet value greater than 0. You can specify an operation by providing an + * object with the attribute to update as the key and its value being an object with the following + * properties: - _operation: the operation to apply on the attribute - value: the right-hand side + * argument to the operation, for example, increment or decrement step, value to add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3733,7 +3729,7 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( } /** - * (asynchronously) Adds new attributes to a record, or update existing ones. - If a record with + * (asynchronously) Adds new attributes to a record, or updates existing ones. - If a record with * the specified object ID doesn't exist, a new record is added to the index **if** * `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. * - You can use any first-level attribute but not nested attributes. If you specify a nested @@ -3752,11 +3748,11 @@ public UpdatedAtWithObjectIdResponse partialUpdateObject( * greater than the current value, and otherwise ignore the whole object update. For example, if * you pass an IncrementSet value of 2 for the version attribute, and the current value of the * attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only - * creates it if you pass an IncrementSet value that's greater than 0. You can specify an - * operation by providing an object with the attribute to update as the key and its value being an - * object with the following properties: - _operation: the operation to apply on the attribute - - * value: the right-hand side argument to the operation, for example, increment or decrement step, - * value to add or remove. + * creates it if you pass an IncrementSet value greater than 0. You can specify an operation by + * providing an object with the attribute to update as the key and its value being an object with + * the following properties: - _operation: the operation to apply on the attribute - value: the + * right-hand side argument to the operation, for example, increment or decrement step, value to + * add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3790,7 +3786,7 @@ public CompletableFuture partialUpdateObjectAsync } /** - * (asynchronously) Adds new attributes to a record, or update existing ones. - If a record with + * (asynchronously) Adds new attributes to a record, or updates existing ones. - If a record with * the specified object ID doesn't exist, a new record is added to the index **if** * `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. * - You can use any first-level attribute but not nested attributes. If you specify a nested @@ -3809,11 +3805,11 @@ public CompletableFuture partialUpdateObjectAsync * greater than the current value, and otherwise ignore the whole object update. For example, if * you pass an IncrementSet value of 2 for the version attribute, and the current value of the * attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only - * creates it if you pass an IncrementSet value that's greater than 0. You can specify an - * operation by providing an object with the attribute to update as the key and its value being an - * object with the following properties: - _operation: the operation to apply on the attribute - - * value: the right-hand side argument to the operation, for example, increment or decrement step, - * value to add or remove. + * creates it if you pass an IncrementSet value greater than 0. You can specify an operation by + * providing an object with the attribute to update as the key and its value being an object with + * the following properties: - _operation: the operation to apply on the attribute - value: the + * right-hand side argument to the operation, for example, increment or decrement step, value to + * add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3832,7 +3828,7 @@ public CompletableFuture partialUpdateObjectAsync } /** - * (asynchronously) Adds new attributes to a record, or update existing ones. - If a record with + * (asynchronously) Adds new attributes to a record, or updates existing ones. - If a record with * the specified object ID doesn't exist, a new record is added to the index **if** * `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. * - You can use any first-level attribute but not nested attributes. If you specify a nested @@ -3851,11 +3847,11 @@ public CompletableFuture partialUpdateObjectAsync * greater than the current value, and otherwise ignore the whole object update. For example, if * you pass an IncrementSet value of 2 for the version attribute, and the current value of the * attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only - * creates it if you pass an IncrementSet value that's greater than 0. You can specify an - * operation by providing an object with the attribute to update as the key and its value being an - * object with the following properties: - _operation: the operation to apply on the attribute - - * value: the right-hand side argument to the operation, for example, increment or decrement step, - * value to add or remove. + * creates it if you pass an IncrementSet value greater than 0. You can specify an operation by + * providing an object with the attribute to update as the key and its value being an object with + * the following properties: - _operation: the operation to apply on the attribute - value: the + * right-hand side argument to the operation, for example, increment or decrement step, value to + * add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -3874,7 +3870,7 @@ public CompletableFuture partialUpdateObjectAsync } /** - * (asynchronously) Adds new attributes to a record, or update existing ones. - If a record with + * (asynchronously) Adds new attributes to a record, or updates existing ones. - If a record with * the specified object ID doesn't exist, a new record is added to the index **if** * `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. * - You can use any first-level attribute but not nested attributes. If you specify a nested @@ -3893,11 +3889,11 @@ public CompletableFuture partialUpdateObjectAsync * greater than the current value, and otherwise ignore the whole object update. For example, if * you pass an IncrementSet value of 2 for the version attribute, and the current value of the * attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only - * creates it if you pass an IncrementSet value that's greater than 0. You can specify an - * operation by providing an object with the attribute to update as the key and its value being an - * object with the following properties: - _operation: the operation to apply on the attribute - - * value: the right-hand side argument to the operation, for example, increment or decrement step, - * value to add or remove. + * creates it if you pass an IncrementSet value greater than 0. You can specify an operation by + * providing an object with the attribute to update as the key and its value being an object with + * the following properties: - _operation: the operation to apply on the attribute - value: the + * right-hand side argument to the operation, for example, increment or decrement step, value to + * add or remove. * * @param indexName Name of the index on which to perform the operation. (required) * @param objectID Unique record identifier. (required) @@ -4075,7 +4071,7 @@ public CompletableFuture restoreApiKeyAsync(@Nonnull String k * replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Name of the index on which to perform the operation. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -4096,7 +4092,7 @@ public SaveObjectResponse saveObject(@Nonnull String indexName, @Nonnull Object * replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Name of the index on which to perform the operation. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @throws AlgoliaRuntimeException If it fails to process the API call */ @@ -4114,7 +4110,7 @@ public SaveObjectResponse saveObject(@Nonnull String indexName, @Nonnull Object * update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Name of the index on which to perform the operation. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -4143,7 +4139,7 @@ public CompletableFuture saveObjectAsync( * update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Name of the index on which to perform the operation. (required) - * @param body The record, a schemaless object with attributes that are useful in the context of + * @param body The record. A schemaless object with attributes that are useful in the context of * search and discovery. (required) * @throws AlgoliaRuntimeException If it fails to process the API call */ @@ -4802,7 +4798,7 @@ public CompletableFuture saveSynonymsAsync(@Nonnull String in } /** - * Sends multiple search request to one or more indices. This can be useful in these cases: - + * Sends multiple search requests to one or more indices. This can be useful in these cases: - * Different indices for different purposes, such as, one index for products, another one for * marketing content. - Multiple searches to the same index—for example, with different filters. * @@ -4819,7 +4815,7 @@ public SearchResponses search(@Nonnull SearchMethodParams searchMethodPar } /** - * Sends multiple search request to one or more indices. This can be useful in these cases: - + * Sends multiple search requests to one or more indices. This can be useful in these cases: - * Different indices for different purposes, such as, one index for products, another one for * marketing content. - Multiple searches to the same index—for example, with different filters. * @@ -4833,7 +4829,7 @@ public SearchResponses search(@Nonnull SearchMethodParams searchMethodPar } /** - * (asynchronously) Sends multiple search request to one or more indices. This can be useful in + * (asynchronously) Sends multiple search requests to one or more indices. This can be useful in * these cases: - Different indices for different purposes, such as, one index for products, * another one for marketing content. - Multiple searches to the same index—for example, with * different filters. @@ -4862,7 +4858,7 @@ public CompletableFuture> searchAsync( } /** - * (asynchronously) Sends multiple search request to one or more indices. This can be useful in + * (asynchronously) Sends multiple search requests to one or more indices. This can be useful in * these cases: - Different indices for different purposes, such as, one index for products, * another one for marketing content. - Multiple searches to the same index—for example, with * different filters. @@ -5230,7 +5226,7 @@ public CompletableFuture searchRulesAsync(@Nonnull String i } /** - * Searches a single index and return matching search results (_hits_). This method lets you + * Searches a single index and returns matching search results (_hits_). This method lets you * retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5251,7 +5247,7 @@ public SearchResponse searchSingleIndex( } /** - * Searches a single index and return matching search results (_hits_). This method lets you + * Searches a single index and returns matching search results (_hits_). This method lets you * retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5266,7 +5262,7 @@ public SearchResponse searchSingleIndex(@Nonnull String indexName, Search } /** - * Searches a single index and return matching search results (_hits_). This method lets you + * Searches a single index and returns matching search results (_hits_). This method lets you * retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5282,7 +5278,7 @@ public SearchResponse searchSingleIndex(@Nonnull String indexName, Class< } /** - * Searches a single index and return matching search results (_hits_). This method lets you + * Searches a single index and returns matching search results (_hits_). This method lets you * retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5295,7 +5291,7 @@ public SearchResponse searchSingleIndex(@Nonnull String indexName, Class< } /** - * (asynchronously) Searches a single index and return matching search results (_hits_). This + * (asynchronously) Searches a single index and returns matching search results (_hits_). This * method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5324,7 +5320,7 @@ public CompletableFuture> searchSingleIndexAsync( } /** - * (asynchronously) Searches a single index and return matching search results (_hits_). This + * (asynchronously) Searches a single index and returns matching search results (_hits_). This * method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5342,7 +5338,7 @@ public CompletableFuture> searchSingleIndexAsync( } /** - * (asynchronously) Searches a single index and return matching search results (_hits_). This + * (asynchronously) Searches a single index and returns matching search results (_hits_). This * method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * @@ -5361,7 +5357,7 @@ public CompletableFuture> searchSingleIndexAsync( } /** - * (asynchronously) Searches a single index and return matching search results (_hits_). This + * (asynchronously) Searches a single index and returns matching search results (_hits_). This * method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` * operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. * diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java b/algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java index 20055e806..6f1204f15 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java @@ -443,9 +443,10 @@ public FallbackParams setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -749,8 +750,8 @@ public FallbackParams addAttributesForFaceting(String attributesForFacetingItem) * [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). * Facets are attributes that let you categorize search results. They can be used for filtering * search results. By default, no attribute is used for faceting. Attribute names are - * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a - * filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching + * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as + * a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching * for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ * deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier * to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. @@ -781,7 +782,7 @@ public FallbackParams addReplicas(String replicasItem) { * use replica indices. All index operations on a primary index are automatically forwarded to its * replicas. To add a replica index, you must provide the complete set of replicas to this * parameter. If you omit a replica from this list, the replica turns into a regular, standalone - * index that will no longer by synced with the primary index. **Modifier** - + * index that will no longer be synced with the primary index. **Modifier** - * `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of * records and are optimized for [Relevant * sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). @@ -1005,9 +1006,9 @@ public FallbackParams addNumericAttributesForFiltering(String numericAttributesF * Numeric attributes that can be used as [numerical * filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). * Attribute names are case-sensitive. By default, all numeric attributes are available as - * numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to - * turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your - * index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only + * numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off + * filtering for all numeric attributes, specify an attribute that doesn't exist in your index, + * such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only * filtering based on equality comparisons `=` and `!=`. */ @javax.annotation.Nullable @@ -1056,7 +1057,8 @@ public FallbackParams addSearchableAttributes(String searchableAttributesItem) { * information, see [Searchable * attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). * **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. - * Without modifier, matches at the beginning of an attribute rank higer than matches at the end. + * Without a modifier, matches at the beginning of an attribute rank higher than matches at the + * end. */ @javax.annotation.Nullable public List getSearchableAttributes() { @@ -1526,7 +1528,7 @@ public FallbackParams addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1553,7 +1555,7 @@ public FallbackParams addDisableExactOnAttributes(String disableExactOnAttribute * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1645,7 +1647,7 @@ public FallbackParams setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHig * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java index b853f223a..67f5934d2 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java @@ -16,7 +16,7 @@ /** * Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types * and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, - * `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: + * `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: * `facet: TO `. The range includes the lower and upper boundaries. The same * combination rules apply as for `facetFilters`. */ diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/QueryType.java b/algoliasearch/src/main/java/com/algolia/model/recommend/QueryType.java index 81eca0309..fce299852 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/QueryType.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/QueryType.java @@ -8,7 +8,7 @@ /** * Determines if and how query words are interpreted as prefixes. By default, only the last query - * word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid + * word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid * `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive * results and makes your search slower. For more information, see [Prefix * searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendSearchParams.java b/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendSearchParams.java index 62069a2b9..9b0f6b498 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendSearchParams.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendSearchParams.java @@ -443,9 +443,10 @@ public RecommendSearchParams setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -749,8 +750,8 @@ public RecommendSearchParams addAttributesForFaceting(String attributesForFaceti * [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). * Facets are attributes that let you categorize search results. They can be used for filtering * search results. By default, no attribute is used for faceting. Attribute names are - * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a - * filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching + * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as + * a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching * for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ * deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier * to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. @@ -781,7 +782,7 @@ public RecommendSearchParams addReplicas(String replicasItem) { * use replica indices. All index operations on a primary index are automatically forwarded to its * replicas. To add a replica index, you must provide the complete set of replicas to this * parameter. If you omit a replica from this list, the replica turns into a regular, standalone - * index that will no longer by synced with the primary index. **Modifier** - + * index that will no longer be synced with the primary index. **Modifier** - * `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of * records and are optimized for [Relevant * sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). @@ -1005,9 +1006,9 @@ public RecommendSearchParams addNumericAttributesForFiltering(String numericAttr * Numeric attributes that can be used as [numerical * filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). * Attribute names are case-sensitive. By default, all numeric attributes are available as - * numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to - * turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your - * index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only + * numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off + * filtering for all numeric attributes, specify an attribute that doesn't exist in your index, + * such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only * filtering based on equality comparisons `=` and `!=`. */ @javax.annotation.Nullable @@ -1056,7 +1057,8 @@ public RecommendSearchParams addSearchableAttributes(String searchableAttributes * information, see [Searchable * attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). * **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. - * Without modifier, matches at the beginning of an attribute rank higer than matches at the end. + * Without a modifier, matches at the beginning of an attribute rank higher than matches at the + * end. */ @javax.annotation.Nullable public List getSearchableAttributes() { @@ -1526,7 +1528,7 @@ public RecommendSearchParams addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1553,7 +1555,7 @@ public RecommendSearchParams addDisableExactOnAttributes(String disableExactOnAt * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1645,7 +1647,7 @@ public RecommendSearchParams setReplaceSynonymsInHighlight(Boolean replaceSynony * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/RenderingContent.java b/algoliasearch/src/main/java/com/algolia/model/recommend/RenderingContent.java index cff3306fe..857c65d13 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/RenderingContent.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/RenderingContent.java @@ -9,7 +9,7 @@ /** * Extra data that can be used in the search UI. You can use this to control aspects of your search - * UI, such as, the order of facet names and values without changing your frontend code. + * UI, such as the order of facet names and values without changing your frontend code. */ public class RenderingContent { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java b/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java index 622bfbbcc..0db5329a4 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java @@ -16,8 +16,8 @@ * tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) * is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting * and - * concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) - * is also active. + * concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) + * are also active. */ @JsonDeserialize(using = TypoTolerance.Deserializer.class) public interface TypoTolerance { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/Anchoring.java b/algoliasearch/src/main/java/com/algolia/model/search/Anchoring.java index 4f7b078c8..c25bcbff9 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/Anchoring.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/Anchoring.java @@ -8,9 +8,9 @@ /** * Which part of the search query the pattern should match: - `startsWith`. The pattern must match - * the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. + * the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. * The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the - * query. Empty queries are only allowed as pattern with `anchoring: is`. + * query. Empty queries are only allowed as patterns with `anchoring: is`. */ public enum Anchoring { IS("is"), diff --git a/algoliasearch/src/main/java/com/algolia/model/search/ApiKey.java b/algoliasearch/src/main/java/com/algolia/model/search/ApiKey.java index 420c89650..70a99781d 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/ApiKey.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/ApiKey.java @@ -129,7 +129,7 @@ public ApiKey setQueryParameters(String queryParameters) { * Query parameters to add when making API requests with this API key. To restrict this API key to * specific IP addresses, add the `restrictSources` parameter. You can only add a single source, * but you can provide a range of IP addresses. Creating an API key fails if the request is made - * from an IP address that's outside the restricted range. + * from an IP address outside the restricted range. */ @javax.annotation.Nullable public String getQueryParameters() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/BrowseParamsObject.java b/algoliasearch/src/main/java/com/algolia/model/search/BrowseParamsObject.java index fa982122d..5251a50ed 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/BrowseParamsObject.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/BrowseParamsObject.java @@ -462,9 +462,10 @@ public BrowseParamsObject setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -1229,7 +1230,7 @@ public BrowseParamsObject addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1256,7 +1257,7 @@ public BrowseParamsObject addDisableExactOnAttributes(String disableExactOnAttri * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1348,7 +1349,7 @@ public BrowseParamsObject setReplaceSynonymsInHighlight(Boolean replaceSynonymsI * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceParams.java b/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceParams.java index e002a243f..ac0e270d0 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceParams.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceParams.java @@ -453,9 +453,10 @@ public ConsequenceParams setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -1220,7 +1221,7 @@ public ConsequenceParams addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1247,7 +1248,7 @@ public ConsequenceParams addDisableExactOnAttributes(String disableExactOnAttrib * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1339,7 +1340,7 @@ public ConsequenceParams setReplaceSynonymsInHighlight(Boolean replaceSynonymsIn * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/DeleteByParams.java b/algoliasearch/src/main/java/com/algolia/model/search/DeleteByParams.java index cb4f48e74..8c2648e90 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/DeleteByParams.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/DeleteByParams.java @@ -103,9 +103,10 @@ public DeleteByParams setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/GetApiKeyResponse.java b/algoliasearch/src/main/java/com/algolia/model/search/GetApiKeyResponse.java index 600e02894..d1fc6aef7 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/GetApiKeyResponse.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/GetApiKeyResponse.java @@ -157,7 +157,7 @@ public GetApiKeyResponse setQueryParameters(String queryParameters) { * Query parameters to add when making API requests with this API key. To restrict this API key to * specific IP addresses, add the `restrictSources` parameter. You can only add a single source, * but you can provide a range of IP addresses. Creating an API key fails if the request is made - * from an IP address that's outside the restricted range. + * from an IP address outside the restricted range. */ @javax.annotation.Nullable public String getQueryParameters() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/IndexSettings.java b/algoliasearch/src/main/java/com/algolia/model/search/IndexSettings.java index 1c9bf3dc2..efd8e9674 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/IndexSettings.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/IndexSettings.java @@ -215,8 +215,8 @@ public IndexSettings addAttributesForFaceting(String attributesForFacetingItem) * [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). * Facets are attributes that let you categorize search results. They can be used for filtering * search results. By default, no attribute is used for faceting. Attribute names are - * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a - * filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching + * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as + * a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching * for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ * deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier * to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. @@ -247,7 +247,7 @@ public IndexSettings addReplicas(String replicasItem) { * use replica indices. All index operations on a primary index are automatically forwarded to its * replicas. To add a replica index, you must provide the complete set of replicas to this * parameter. If you omit a replica from this list, the replica turns into a regular, standalone - * index that will no longer by synced with the primary index. **Modifier** - + * index that will no longer be synced with the primary index. **Modifier** - * `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of * records and are optimized for [Relevant * sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). @@ -471,9 +471,9 @@ public IndexSettings addNumericAttributesForFiltering(String numericAttributesFo * Numeric attributes that can be used as [numerical * filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). * Attribute names are case-sensitive. By default, all numeric attributes are available as - * numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to - * turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your - * index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only + * numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off + * filtering for all numeric attributes, specify an attribute that doesn't exist in your index, + * such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only * filtering based on equality comparisons `=` and `!=`. */ @javax.annotation.Nullable @@ -522,7 +522,8 @@ public IndexSettings addSearchableAttributes(String searchableAttributesItem) { * information, see [Searchable * attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). * **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. - * Without modifier, matches at the beginning of an attribute rank higer than matches at the end. + * Without a modifier, matches at the beginning of an attribute rank higher than matches at the + * end. */ @javax.annotation.Nullable public List getSearchableAttributes() { @@ -1070,7 +1071,7 @@ public IndexSettings addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1097,7 +1098,7 @@ public IndexSettings addDisableExactOnAttributes(String disableExactOnAttributes * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1189,7 +1190,7 @@ public IndexSettings setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHigh * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java index bc780f561..5bc01ff57 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java @@ -16,7 +16,7 @@ /** * Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types * and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, - * `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: + * `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: * `facet: TO `. The range includes the lower and upper boundaries. The same * combination rules apply as for `facetFilters`. */ diff --git a/algoliasearch/src/main/java/com/algolia/model/search/QueryType.java b/algoliasearch/src/main/java/com/algolia/model/search/QueryType.java index 6409330cd..1a210923f 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/QueryType.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/QueryType.java @@ -8,7 +8,7 @@ /** * Determines if and how query words are interpreted as prefixes. By default, only the last query - * word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid + * word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid * `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive * results and makes your search slower. For more information, see [Prefix * searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). diff --git a/algoliasearch/src/main/java/com/algolia/model/search/RenderingContent.java b/algoliasearch/src/main/java/com/algolia/model/search/RenderingContent.java index 3bf5658f4..244dee2c9 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/RenderingContent.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/RenderingContent.java @@ -9,7 +9,7 @@ /** * Extra data that can be used in the search UI. You can use this to control aspects of your search - * UI, such as, the order of facet names and values without changing your frontend code. + * UI, such as the order of facet names and values without changing your frontend code. */ public class RenderingContent { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/SearchForFacets.java b/algoliasearch/src/main/java/com/algolia/model/search/SearchForFacets.java index fe9855baf..23c8f51fc 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/SearchForFacets.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/SearchForFacets.java @@ -485,9 +485,10 @@ public SearchForFacets setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -1252,7 +1253,7 @@ public SearchForFacets addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1279,7 +1280,7 @@ public SearchForFacets addDisableExactOnAttributes(String disableExactOnAttribut * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1371,7 +1372,7 @@ public SearchForFacets setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHi * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/SearchForHits.java b/algoliasearch/src/main/java/com/algolia/model/search/SearchForHits.java index eab0e2771..0dbcfb281 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/SearchForHits.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/SearchForHits.java @@ -479,9 +479,10 @@ public SearchForHits setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -1246,7 +1247,7 @@ public SearchForHits addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1273,7 +1274,7 @@ public SearchForHits addDisableExactOnAttributes(String disableExactOnAttributes * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1365,7 +1366,7 @@ public SearchForHits setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHigh * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/SearchParamsObject.java b/algoliasearch/src/main/java/com/algolia/model/search/SearchParamsObject.java index 2b5e58b0c..c172ffaeb 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/SearchParamsObject.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/SearchParamsObject.java @@ -459,9 +459,10 @@ public SearchParamsObject setAroundLatLng(String aroundLatLng) { /** * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and - * longitude. Only records included within circle around this central location are included in the - * results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` - * settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`. + * longitude. Only records included within a circle around this central location are included in + * the results. The radius of the circle is determined by the `aroundRadius` and + * `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` + * or `insideBoundingBox`. */ @javax.annotation.Nullable public String getAroundLatLng() { @@ -1226,7 +1227,7 @@ public SearchParamsObject addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1253,7 +1254,7 @@ public SearchParamsObject addDisableExactOnAttributes(String disableExactOnAttri * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1345,7 +1346,7 @@ public SearchParamsObject setReplaceSynonymsInHighlight(Boolean replaceSynonymsI * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/SettingsResponse.java b/algoliasearch/src/main/java/com/algolia/model/search/SettingsResponse.java index 6cfdc72a3..e42b778b1 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/SettingsResponse.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/SettingsResponse.java @@ -218,8 +218,8 @@ public SettingsResponse addAttributesForFaceting(String attributesForFacetingIte * [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). * Facets are attributes that let you categorize search results. They can be used for filtering * search results. By default, no attribute is used for faceting. Attribute names are - * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a - * filter, but doesn't evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching + * case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as + * a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching * for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ * deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier * to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. @@ -250,7 +250,7 @@ public SettingsResponse addReplicas(String replicasItem) { * use replica indices. All index operations on a primary index are automatically forwarded to its * replicas. To add a replica index, you must provide the complete set of replicas to this * parameter. If you omit a replica from this list, the replica turns into a regular, standalone - * index that will no longer by synced with the primary index. **Modifier** - + * index that will no longer be synced with the primary index. **Modifier** - * `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of * records and are optimized for [Relevant * sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). @@ -474,9 +474,9 @@ public SettingsResponse addNumericAttributesForFiltering(String numericAttribute * Numeric attributes that can be used as [numerical * filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). * Attribute names are case-sensitive. By default, all numeric attributes are available as - * numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to - * turn off filtering for all numeric attributes, specifiy an attribute that doesn't exist in your - * index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only + * numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off + * filtering for all numeric attributes, specify an attribute that doesn't exist in your index, + * such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only * filtering based on equality comparisons `=` and `!=`. */ @javax.annotation.Nullable @@ -525,7 +525,8 @@ public SettingsResponse addSearchableAttributes(String searchableAttributesItem) * information, see [Searchable * attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). * **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. - * Without modifier, matches at the beginning of an attribute rank higer than matches at the end. + * Without a modifier, matches at the beginning of an attribute rank higher than matches at the + * end. */ @javax.annotation.Nullable public List getSearchableAttributes() { @@ -1073,7 +1074,7 @@ public SettingsResponse addOptionalWords(String optionalWordsItem) { * `optionalWords` has less than 10 words, the required number of matched words increases by 1: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If * `optionalWords` has 10 or more words, the number of required matched words increases by the - * number of optional words dividied by 5 (rounded down). For example, with 18 optional words: + * number of optional words divided by 5 (rounded down). For example, with 18 optional words: * results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more * information, see [Optional * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). @@ -1100,7 +1101,7 @@ public SettingsResponse addDisableExactOnAttributes(String disableExactOnAttribu * Searchable attributes for which you want to [turn off the Exact ranking * criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). * Attribute names are case-sensitive. This can be useful for attributes with long values, where - * the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact + * the likelihood of an exact match is high, such as product descriptions. Turning off the Exact * ranking criterion for these attributes favors exact matching on other attributes. This reduces * the impact of individual attributes with a lot of content on ranking. */ @@ -1192,7 +1193,7 @@ public SettingsResponse setReplaceSynonymsInHighlight(Boolean replaceSynonymsInH * and a search for `home`, records matching either \"home\" or \"house\" are included in the * search results, and either \"home\" or \"house\" are highlighted. With * `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, - * but all occurences of \"house\" are replaced by \"home\" in the highlighted response. + * but all occurrences of \"house\" are replaced by \"home\" in the highlighted response. */ @javax.annotation.Nullable public Boolean getReplaceSynonymsInHighlight() { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java b/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java index a679b25bf..7faaeefec 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java @@ -16,8 +16,8 @@ * tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) * is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting * and - * concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) - * is also active. + * concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) + * are also active. */ @JsonDeserialize(using = TypoTolerance.Deserializer.class) public interface TypoTolerance {