feat(specs): allow enablePersonalization query parameter at run time for Composition API (generated)

algolia-bot · ClaraMuller · algolia-bot · commit 6e7ecae2896e · 2025-11-18T16:06:31.000Z
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>
diff --git a/packages/composition/model/params.ts b/packages/composition/model/params.ts
@@ -11,64 +11,80 @@ import type { SupportedLanguage } from './supportedLanguage';
 
 export type Params = {
   /**
-   * Search query.
+   * Whether this search will be included in Analytics.
    */
-  query?: string | undefined;
+  analytics?: boolean | undefined;
 
   /**
-   * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
+   * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
    */
-  filters?: string | undefined;
+  analyticsTags?: Array<string> | undefined;
 
   /**
-   * Page of search results to retrieve.
+   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and 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`.
    */
-  page?: number | undefined;
+  aroundLatLng?: string | undefined;
 
   /**
-   * Whether the run response should include detailed ranking information.
+   * Whether to obtain the coordinates from the request\'s IP address.
    */
-  getRankingInfo?: boolean | undefined;
+  aroundLatLngViaIP?: boolean | undefined;
+
+  aroundRadius?: AroundRadius | undefined;
+
+  aroundPrecision?: AroundPrecision | undefined;
 
   /**
-   * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
+   * Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
    */
-  relevancyStrictness?: number | undefined;
-
-  facetFilters?: FacetFilters | undefined;
+  clickAnalytics?: boolean | undefined;
 
   /**
-   * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
+   * Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
    */
-  facets?: Array<string> | undefined;
+  enableABTest?: boolean | undefined;
 
-  optionalFilters?: OptionalFilters | undefined;
+  /**
+   * Whether to enable Personalization.
+   */
+  enablePersonalization?: boolean | undefined;
 
-  numericFilters?: NumericFilters | undefined;
+  /**
+   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+   */
+  enableReRanking?: boolean | undefined;
 
   /**
-   * Number of hits per page.
+   * Whether to enable composition rules.
    */
-  hitsPerPage?: number | undefined;
+  enableRules?: boolean | undefined;
+
+  facetFilters?: FacetFilters | undefined;
 
   /**
-   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and 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`.
+   * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
    */
-  aroundLatLng?: string | undefined;
+  facets?: Array<string> | undefined;
 
   /**
-   * Whether to obtain the coordinates from the request\'s IP address.
+   * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
    */
-  aroundLatLngViaIP?: boolean | undefined;
+  filters?: string | undefined;
 
-  aroundRadius?: AroundRadius | undefined;
+  /**
+   * Whether the run response should include detailed ranking information.
+   */
+  getRankingInfo?: boolean | undefined;
 
-  aroundPrecision?: AroundPrecision | undefined;
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number | undefined;
 
   /**
-   * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
+   * A list of extenrally injected objectID groups into from an external source.
    */
-  minimumAroundRadius?: number | undefined;
+  injectedItems?: { [key: string]: ExternalInjectedItem } | undefined;
 
   insideBoundingBox?: InsideBoundingBox | null | undefined;
 
@@ -78,57 +94,46 @@ export type Params = {
   insidePolygon?: Array<Array<number>> | undefined;
 
   /**
-   * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
+   * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
    */
-  queryLanguages?: Array<SupportedLanguage> | undefined;
+  minimumAroundRadius?: number | undefined;
 
   /**
    * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
    */
   naturalLanguages?: Array<SupportedLanguage> | undefined;
 
-  /**
-   * Whether to enable composition rules.
-   */
-  enableRules?: boolean | undefined;
-
-  /**
-   * Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
-   */
-  ruleContexts?: Array<string> | undefined;
+  numericFilters?: NumericFilters | undefined;
 
-  /**
-   * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
-   */
-  userToken?: string | undefined;
+  optionalFilters?: OptionalFilters | undefined;
 
   /**
-   * Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
+   * Page of search results to retrieve.
    */
-  clickAnalytics?: boolean | undefined;
+  page?: number | undefined;
 
   /**
-   * Whether this search will be included in Analytics.
+   * Search query.
    */
-  analytics?: boolean | undefined;
+  query?: string | undefined;
 
   /**
-   * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
+   * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
    */
-  analyticsTags?: Array<string> | undefined;
+  relevancyStrictness?: number | undefined;
 
   /**
-   * Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
+   * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
    */
-  enableABTest?: boolean | undefined;
+  queryLanguages?: Array<SupportedLanguage> | undefined;
 
   /**
-   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+   * Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
    */
-  enableReRanking?: boolean | undefined;
+  ruleContexts?: Array<string> | undefined;
 
   /**
-   * A list of extenrally injected objectID groups into from an external source.
+   * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
    */
-  injectedItems?: { [key: string]: ExternalInjectedItem } | undefined;
+  userToken?: string | undefined;
 };
