Skip to content

Commit

Permalink
fix(specs): correct typos is Search API (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3898

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: gazconroy <gazconroyster@gmail.com>
Co-authored-by: Gary Conroy <gary.conroy@LON-M3P-GConroy.local>
Co-authored-by: shortcuts <vannicattec@gmail.com>
  • Loading branch information
4 people committed Oct 7, 2024
1 parent 2efca0f commit 69d256c
Show file tree
Hide file tree
Showing 22 changed files with 193 additions and 185 deletions.
180 changes: 88 additions & 92 deletions algoliasearch/src/main/java/com/algolia/api/SearchClient.java

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down Expand Up @@ -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))`.
Expand Down Expand Up @@ -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/).
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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<String> getSearchableAttributes() {
Expand Down Expand Up @@ -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).
Expand All @@ -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.
*/
Expand Down Expand Up @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same
* combination rules apply as for `facetFilters`.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down Expand Up @@ -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))`.
Expand Down Expand Up @@ -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/).
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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<String> getSearchableAttributes() {
Expand Down Expand Up @@ -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).
Expand All @@ -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.
*/
Expand Down Expand Up @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
Loading

0 comments on commit 69d256c

Please sign in to comment.