Skip to content

Commit 44390ff

Browse files
algolia-botClaraMuller
algolia-bot
and
ClaraMuller
committed
feat(specs): allow enablePersonalization query parameter at run time for Composition API (generated)
algolia/api-clients-automation#5651 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
1 parent e233fa3 commit 44390ff

File tree

1 file changed

+72
-69
lines changed

1 file changed

+72
-69
lines changed

‎src/main/scala/algoliasearch/composition/Params.scala‎

Lines changed: 72 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,39 @@ import algoliasearch.composition.SupportedLanguage._
3434

3535
/** Params
3636
*
37-
* @param query
38-
* Search query.
37+
* @param analytics
38+
* Whether this search will be included in Analytics.
39+
* @param analyticsTags
40+
* Tags to apply to the query for [segmenting analytics
41+
* data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
42+
* @param aroundLatLng
43+
* Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only
44+
* records included within a circle around this central location are included in the results. The radius of the
45+
* circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you
46+
* also specify `insidePolygon` or `insideBoundingBox`.
47+
* @param aroundLatLngViaIP
48+
* Whether to obtain the coordinates from the request's IP address.
49+
* @param clickAnalytics
50+
* Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query
51+
* and is required for tracking [click and conversion
52+
* events](https://www.algolia.com/doc/guides/sending-events/getting-started).
53+
* @param enableABTest
54+
* Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B
55+
* test is ignored.
56+
* @param enablePersonalization
57+
* Whether to enable Personalization.
58+
* @param enableReRanking
59+
* Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This
60+
* setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
61+
* @param enableRules
62+
* Whether to enable composition rules.
63+
* @param facets
64+
* Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
65+
* To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets
66+
* with the `disjunctive` modifier. For more information, see
67+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
68+
* and [disjunctive faceting for Smart
69+
* Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
3970
* @param filters
4071
* Filter expression to only include items that match the filter criteria in the response. You can use these filter
4172
* expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`,
@@ -50,39 +81,34 @@ import algoliasearch.composition.SupportedLanguage._
5081
* facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter
5182
* matches if it matches at least one element of the array. For more information, see
5283
* [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
53-
* @param page
54-
* Page of search results to retrieve.
5584
* @param getRankingInfo
5685
* Whether the run response should include detailed ranking information.
57-
* @param relevancyStrictness
58-
* Relevancy threshold below which less relevant results aren't included in the results You can only set
59-
* `relevancyStrictness` on [virtual replica
60-
* indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
61-
* Use this setting to strike a balance between the relevance and number of returned results.
62-
* @param facets
63-
* Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
64-
* To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets
65-
* with the `disjunctive` modifier. For more information, see
66-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
67-
* and [disjunctive faceting for Smart
68-
* Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
6986
* @param hitsPerPage
7087
* Number of hits per page.
71-
* @param aroundLatLng
72-
* Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only
73-
* records included within a circle around this central location are included in the results. The radius of the
74-
* circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you
75-
* also specify `insidePolygon` or `insideBoundingBox`.
76-
* @param aroundLatLngViaIP
77-
* Whether to obtain the coordinates from the request's IP address.
78-
* @param minimumAroundRadius
79-
* Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
88+
* @param injectedItems
89+
* A list of extenrally injected objectID groups into from an external source.
8090
* @param insidePolygon
8191
* Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented
8292
* by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering
8393
* inside
8494
* polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
8595
* This parameter is ignored if you also specify `insideBoundingBox`.
96+
* @param minimumAroundRadius
97+
* Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
98+
* @param naturalLanguages
99+
* ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to
100+
* keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets
101+
* `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and
102+
* `analyticsTags`.
103+
* @param page
104+
* Page of search results to retrieve.
105+
* @param query
106+
* Search query.
107+
* @param relevancyStrictness
108+
* Relevancy threshold below which less relevant results aren't included in the results You can only set
109+
* `relevancyStrictness` on [virtual replica
110+
* indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
111+
* Use this setting to strike a balance between the relevance and number of returned results.
86112
* @param queryLanguages
87113
* Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection
88114
* dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals`
@@ -94,65 +120,42 @@ import algoliasearch.composition.SupportedLanguage._
94120
* or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to
95121
* unexpected search results. For more information, see [Language-specific
96122
* configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
97-
* @param naturalLanguages
98-
* ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to
99-
* keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets
100-
* `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and
101-
* `analyticsTags`.
102-
* @param enableRules
103-
* Whether to enable composition rules.
104123
* @param ruleContexts
105124
* Assigns a rule context to the run query [Rule
106125
* contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context)
107126
* are strings that you can use to trigger matching rules.
108127
* @param userToken
109128
* Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For
110129
* more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
111-
* @param clickAnalytics
112-
* Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query
113-
* and is required for tracking [click and conversion
114-
* events](https://www.algolia.com/doc/guides/sending-events/getting-started).
115-
* @param analytics
116-
* Whether this search will be included in Analytics.
117-
* @param analyticsTags
118-
* Tags to apply to the query for [segmenting analytics
119-
* data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
120-
* @param enableABTest
121-
* Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B
122-
* test is ignored.
123-
* @param enableReRanking
124-
* Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This
125-
* setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
126-
* @param injectedItems
127-
* A list of extenrally injected objectID groups into from an external source.
128130
*/
129131
case class Params(
130-
query: Option[String] = scala.None,
131-
filters: Option[String] = scala.None,
132-
page: Option[Int] = scala.None,
133-
getRankingInfo: Option[Boolean] = scala.None,
134-
relevancyStrictness: Option[Int] = scala.None,
135-
facetFilters: Option[FacetFilters] = scala.None,
136-
facets: Option[Seq[String]] = scala.None,
137-
optionalFilters: Option[OptionalFilters] = scala.None,
138-
numericFilters: Option[NumericFilters] = scala.None,
139-
hitsPerPage: Option[Int] = scala.None,
132+
analytics: Option[Boolean] = scala.None,
133+
analyticsTags: Option[Seq[String]] = scala.None,
140134
aroundLatLng: Option[String] = scala.None,
141135
aroundLatLngViaIP: Option[Boolean] = scala.None,
142136
aroundRadius: Option[AroundRadius] = scala.None,
143137
aroundPrecision: Option[AroundPrecision] = scala.None,
144-
minimumAroundRadius: Option[Int] = scala.None,
138+
clickAnalytics: Option[Boolean] = scala.None,
139+
enableABTest: Option[Boolean] = scala.None,
140+
enablePersonalization: Option[Boolean] = scala.None,
141+
enableReRanking: Option[Boolean] = scala.None,
142+
enableRules: Option[Boolean] = scala.None,
143+
facetFilters: Option[FacetFilters] = scala.None,
144+
facets: Option[Seq[String]] = scala.None,
145+
filters: Option[String] = scala.None,
146+
getRankingInfo: Option[Boolean] = scala.None,
147+
hitsPerPage: Option[Int] = scala.None,
148+
injectedItems: Option[Map[String, ExternalInjectedItem]] = scala.None,
145149
insideBoundingBox: Option[InsideBoundingBox] = scala.None,
146150
insidePolygon: Option[Seq[Seq[Double]]] = scala.None,
147-
queryLanguages: Option[Seq[SupportedLanguage]] = scala.None,
151+
minimumAroundRadius: Option[Int] = scala.None,
148152
naturalLanguages: Option[Seq[SupportedLanguage]] = scala.None,
149-
enableRules: Option[Boolean] = scala.None,
153+
numericFilters: Option[NumericFilters] = scala.None,
154+
optionalFilters: Option[OptionalFilters] = scala.None,
155+
page: Option[Int] = scala.None,
156+
query: Option[String] = scala.None,
157+
relevancyStrictness: Option[Int] = scala.None,
158+
queryLanguages: Option[Seq[SupportedLanguage]] = scala.None,
150159
ruleContexts: Option[Seq[String]] = scala.None,
151-
userToken: Option[String] = scala.None,
152-
clickAnalytics: Option[Boolean] = scala.None,
153-
analytics: Option[Boolean] = scala.None,
154-
analyticsTags: Option[Seq[String]] = scala.None,
155-
enableABTest: Option[Boolean] = scala.None,
156-
enableReRanking: Option[Boolean] = scala.None,
157-
injectedItems: Option[Map[String, ExternalInjectedItem]] = scala.None
160+
userToken: Option[String] = scala.None
158161
)

0 commit comments

Comments
 (0)