@coveo/platform-client 55.13.2 → 56.0.0

package/dist/types/resources/Search/SearchInterfaces.d.ts

@@ -21,7 +21,6 @@ interface SharedSearchParams {
      * - For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of that event should be set to the `pipeline` value of the query (or to the `"default"` string, if no `pipeline` value was specified in the query).
      *
      * See also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).
-     *
      * @example `CustomerQueryPipeline`
      */
     pipeline?: string;
@@ -35,7 +34,6 @@ interface SharedSearchParams {
      * - When logging a **Search** usage analytics event for a query, the `originLevel1` field of that event should be set to the value of the `searchHub` search request parameter.
      *
      * See also the `tab` parameter.
-     *
      * @example `CustomerPortal`
      */
     searchHub?: string;
@@ -45,7 +43,6 @@ interface SharedSearchParams {
      * If not specified, the default time zone of the server hosting the index is used.
      *
      * **Note:** While no Coveo Machine Learning model uses this information, it can nevertheless affect the ranking scores (and thus, potentially the order) of result items, as ranking expressions may be based on time constants.
-     *
      * @example `America/New_York`
      */
     timezone?: string;
@@ -55,7 +52,6 @@ interface SharedSearchParams {
      * **Notes:**
      * - Debug information can only appear in responses in the JSON format (see the `format` parameter).
      * - Avoid setting this parameter to `true` in production, as it has a negative impact on query performance.
-     *
      * @default `false`
      */
     debug?: boolean;
@@ -65,7 +61,6 @@ interface SharedSearchParams {
      * If you do not specify an `index` (or `indexToken`) value, any index mirror could be used.
      *
      * **Note:** Passing an `index` (or `indexToken`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).
-     *
      * @example `myorg-nvoqun-Indexer1-pbi2nbuw`
      */
     index?: string;
@@ -79,7 +74,6 @@ export interface SharedFieldsParams extends SharedSearchParams {
      * **Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should be set to the `tab` value of the query (or to the `"default"` string, if no `tab` value was specified in the query).
      *
      * See also the `searchHub` parameter.
-     *
      * @example `ForumTab`
      */
     tab?: string;
@@ -91,7 +85,6 @@ export interface SharedFieldsParams extends SharedSearchParams {
      * **Note:** When logging a **Search** usage analytics event for a query, the `originLevel3` field of that event should be set to the `referrer` value of the query, if specified.
      *
      * See also the `context` parameter.
-     *
      * @example `http://www.example.com`
      */
     referrer?: string;
@@ -104,7 +97,6 @@ export interface SharedFieldsParams extends SharedSearchParams {
      * When logging a **Search** usage analytics event for a query, the `customData` field of that event should include the same data as the `context` parameter of the query. However, each `context` key included in `customData` must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).
      *
      * See also the `referrer` parameter.
-     *
      * @example
      * ```json
      * {
@@ -120,7 +112,6 @@ export interface SharedFieldsParams extends SharedSearchParams {
      * Coveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.
      *
      * **Note:** When logging a **Search** usage analytics event, the language field of that event should match the language part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).
-     *
      * @example `en-US`
      */
     locale?: string;
@@ -130,7 +121,6 @@ export interface SharedFieldsParams extends SharedSearchParams {
      * If you do not specify an `indexToken` (or `index`) value, any index mirror could be used.
      *
      * **Note:** Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).
-     *
      * @example `ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==`
      */
     indexToken?: string;
@@ -138,13 +128,11 @@ export interface SharedFieldsParams extends SharedSearchParams {
      * The identifier for a logical group of indexes that have been configured to include documents form the same sources.
      *
      * If you do not specify a `logicalIndex` value, the `default` grouping will be used, typically including all indexes.
-     *
      * @example `webcontentonly`
      */
     logicalIndex?: string;
 }
-export interface SearchListFieldsParams extends SharedFieldsParams {
-}
+export type SearchListFieldsParams = SharedFieldsParams;
 export interface SearchListFieldsResponse {
     fields: Array<{
         type: string;
@@ -195,8 +183,7 @@ export interface TokenModel {
     token: string;
 }
 export type RestQueryParams = PostSearchBodyQueryParams;
-export interface PostSearchQueryStringParams extends Pick<SharedSearchParams, 'organizationId' | 'viewAllContent'> {
-}
+export type PostSearchQueryStringParams = Pick<SharedSearchParams, 'organizationId' | 'viewAllContent'>;
 /**
  * Defines the body parameters of the list field values request.
  */
@@ -213,13 +200,11 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * Use:
      * - occurrences: to sort by number of occurrences, with field values having the highest number of occurrences appearing first.
      * - nosort: to avoid sorting the results of the Group By operation. The field values will appear in an unspecified order.
-     *
      * @default `occurrences`
      */
     sortCriteria?: string;
     /**
      * The maximum number of values to return.
-     *
      * @default `10`
      */
     maximumNumberOfValues?: number;
@@ -227,7 +212,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * The query expression that should override the basic query expression on which the Group By operation is being performed (see the `q` query parameter).
      *
      * **Note:** If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `Coveo Cloud V2 Platform`
      */
     queryOverride?: string;
@@ -235,7 +219,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * The query expression that should override the constant query expression on which the Group By operation is being performed (see the `cq` query parameter).
      *
      * **Note:** If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `@filetype==forumpost`
      */
     constantQueryOverride?: string;
@@ -243,7 +226,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * The query expression that should override the disjunction query expression on which the Group By operation is being performed (see the `dq` query parameter).
      *
      * **Note:** If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `@date=2016-12-01..2016-12-31`
      */
     disjunctionQueryOverride?: string;
@@ -261,7 +243,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * - regularexpression: to parse the specified pattern as a regular expression.
      * - editdistance: to apply the Edit Distance algorithm to match values that are close to the specified pattern.
      * - phonetic to apply a phonetic algorithm to match values that are phonetically similar to the specified pattern.
-     *
      * @default `wildcard`
      */
     patternType?: string;
@@ -271,7 +252,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
     commerce?: RestCommerceParameters;
     /**
      * A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field.
-     *
      * @example
      * Suppose that in your index, the `@price` dictionary field contains different values for its `storeA` and `storeB` keys. Including `"dictionaryFieldContext": { "price": "storeA" }` in the query means that any part of the query expression that targets the `@price` field will in fact only query the `storeA` values of that field.
      */
@@ -282,7 +262,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * If the results of a specific request are available in the cache, and if those results are no older than the `maximumAge` value, the service returns those results rather than forwarding a new query to the index.
      *
      * **Note:** This parameter is automatically overridden when `staticQuery` is set to `true`.
-     *
      * @default `-1` (which corresponds to the internal default value (15 minutes))
      */
     maximumAge?: number;
@@ -290,15 +269,12 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * The query and page view actions previously made by the current user.
      *
      * Coveo Machine Learning content recommendations models use this information to provide contextually relevant output.
-     *
-     * @type {RestActionHistory[]}
      */
     actionsHistory?: RestActionHistory[];
     /**
      * The identifier of the recommendation interface from which the request originates.
      *
      * Coveo Machine Learning content recommendations models may use this information to provide contextually relevant output.
-     *
      * @example `RecommendedProducts`
      */
     recommendation?: string;
@@ -310,7 +286,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * - Use `xlsx` to generate an Excel file containing the results (binary).
      *
      * **Note:** Debug information (see the `debug` parameter) can only appear in a response in the JSON format.
-     *
      * @default `json`
      */
     format?: RestFormat;
@@ -318,7 +293,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * A GUID representing the current user, who can be authenticated or anonymous. This GUID is normally generated by the usage analytics service and stored in a non-expiring browser cookie.
      *
      * Coveo Machine Learning models may use this information to provide contextually relevant output.
-     *
      * @example `5cb98953-9c13-42ff-8176-e6fcba6a50bf`
      */
     visitorId?: string;
@@ -328,7 +302,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * Coveo Machine Learning models may use this information to provide contextually relevant output.
      *
      * **Note:** When logging a **Search** usage analytics event for a query, the anonymous field of that event should be set to the `isGuestUser` value of the query.
-     *
      * @default `false`
      */
     isGuestUser?: boolean;
@@ -347,7 +320,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * - `categoryFilter` (string): The name of a category of products to get recommendations for.
      * - `brandFilter` (string): The name of a brand of products to get recommendations for.
      * - `filters` (map of strings): The dimensions along with the values to be used at query time by the model as filters for potential suggestions. Only applies to Automatic relevance Tuning, Query Suggestions, or Dynamic Navigation Experience models that don’t use the default `filterFields` advanced parameter values. **Example:** `"filters": { "originContext": "<MY-VALUE>", "originLevel2": "<MY-VALUE>" }`.
-     *
      * @example
      * ```json
      * {
@@ -357,7 +329,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      *   "considerUserContext": false
      * }
      * ```
-     *
      * @example
      * ```json
      * {"wordSelection": "wordsKept:4"}
@@ -366,14 +337,12 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
     mlParameters?: Record<string, any>;
     /**
      * The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization.
-     *
      * @default `coveo`
      */
     indexType?: string;
     /**
      * The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000
      * Coveo determines the most appropriate timeout to use.
-     *
      * @default: `0`
      */
     maximumTimeoutMs?: string;
@@ -393,7 +362,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      * - `clientRequestId` (string): A GUID generated by the client representing the current request. This information is used to identify operations across different apis related to the same request.
      * - `clientTimestamp` (string): Client ISO 8601 timestamp with milliseconds.
      * - `userAgent` (string): The user agent of the request. If not present, the user agent is obtained from the [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) header. This information is required when endpoints are behind a proxy.
-     *
      * @example
      * ```json
      * {
@@ -402,7 +370,6 @@ export interface ListFieldValuesBodyQueryParams extends SharedFieldsParams {
      *   "deviceId": "Chrome"
      * }
      * ```
-     *
      * @example
      * ```json
      * {
@@ -429,7 +396,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * The advanced query expression, typically generated by code (e.g., when toggling facet values).
      *
      * **Note:** When logging a **Search** usage analytics event for a query, the `advancedQuery` field of that event should be set to the `aq` value of the corresponding query (for reporting purposes).
-     *
      * @example
      * `@year==2017`
      */
@@ -449,7 +415,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      *
      * - In the index, the values of the `childField` must only contain alphanumerical characters. Using a `childField` whose values contain non-indexable characters (such as underscores) will make folding fail.
      * - The values of the `childField` must contain 60 characters or less (60 being the default maximum of characters for a word in the index).
-     *
      * @example `@foldingparent`
      */
     childField?: string;
@@ -465,20 +430,17 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Notes:**
      * - Other parts of the query expression can also benefit from the index cache (see the `maximumAge` parameter). However, using the constant query expression allows you to explicitly cache specific result sets.
      * - Temporal keywords (`now`, `today`, `yesterday`) in the constant query expression are only re-evaluated once per 3-4 minutes; therefore, you should avoid basing `cq` expressions on temporal keywords if you require split second accuracy.
-     *
      * @example `@filetype==forumpost`
      */
     cq?: string;
     /**
      * A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field.
-     *
      * @example
      * Suppose that in your index, the `@price` dictionary field contains different values for its `storeA` and `storeB` keys. Including `"dictionaryFieldContext": { "price": "storeA" }` in the query means that any part of the query expression that targets the `@price` field will in fact only query the `storeA` values of that field.
      */
     dictionaryFieldContext?: RestDictionaryFieldContextRequest;
     /**
      * The disjunction query expression, typically populated by Coveo ML automatic relevance tuning models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an `OR` operator. The resulting query expression is `(((q aq) OR (dq)) cq)`.
-     *
      * @example `@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd`
      */
     dq?: string;
@@ -490,7 +452,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * - The Did You Mean feature only processes the basic query expression (see the `q` parameter).
      * - When both `enableDidYouMean` and `enableMLDidYouMean` parameter are set to `true`, the output of both features will appear in the `queryCorrections` array.
      * - The Did You Mean feature will return no corrections when the query is processed by an automatic relevance tuning (ART) model whose Intelligent Term Detection (ITD) feature is enabled.
-     *
      * @default `false`
      */
     enableDidYouMean?: boolean;
@@ -501,7 +462,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * - Two items must be at least 85% similar to one another to be considered duplicates.
      * - When a pair of duplicates is found, only the higher-ranked item of the two is kept in the result set.
      * - Enabling this feature can make the total result count less precise, since only results up to those being retrieved (see the `firstResult` and `numberOfResults` parameters) are submitted to duplicate filtering.
-     *
      * @default `false`
      */
     enableDuplicateFiltering?: boolean;
@@ -513,13 +473,11 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Notes:**
      * - The Coveo ML query suggestions Did You Mean feature only processes the basic query expression (see the `q` parameter).
      * - When both `enableDidYouMean` and `enableMLDidYouMean` parameter are set to true, the output of both features will appear in the `queryCorrections` array.
-     *
      * @default `false`
      */
     enableMLDidYouMean?: boolean;
     /**
      * Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the `q` parameter). See also the `lowercaseOperators` parameter.
-     *
      * @default `true`
      */
     enableQuerySyntax?: boolean;
@@ -531,7 +489,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Notes:**
      * - The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the `retrieveFirstSentences` parameter).
      * - On an Elasticsearch index, actual excerpts may be slightly longer than the requested excerpt length.
-     *
      * @default `200`
      */
     excerptLength?: number;
@@ -549,7 +506,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Note:** If you specify both an array of fields to include (see the `fieldsToInclude` parameter) and an array of fields to exclude, the `fieldsToExclude` parameter has no effect at all.
      *
      * If you do not explicitly specify an array of values for this parameter (or for the `fieldsToInclude` parameter), each query result item will include all of its available fields.
-     *
      * @example
      * ```json
      * ["documenttype","size","source"]
@@ -562,7 +518,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Note:** If you specify both an array of fields to include and an array of fields to exclude (see the `fieldsToExclude` parameter), the `fieldsToExclude` parameter has no effect at all.
      *
      * If you do not explicitly specify an array of values for this parameter (or for the `fieldsToExclude` parameter), each query result item will include all of its available fields.
-     *
      * @example
      * ```json
      * ["clickableuri","author","date","filetype","language","coversationid","messageid","childid","adjustednumberoflikes"]
@@ -577,7 +532,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * See also the `parentField`, `childField`, and `filterFieldRange` parameters.
      *
      * **Note:** In an Elasticsearch index, the corresponding field must be configured as a *Facet* and/or *Sortable* field (see [Add or Edit Fields](https://docs.coveo.com/en/1982/)). This limitation does not apply to a Coveo index.
-     *
      * @example `@foldingcollection`
      */
     filterField?: string;
@@ -585,7 +539,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * The maximum number of items to include in the `childResults` array of a folded query result (see [Result Folding](https://docs.coveo.com/en/1466/)).
      *
      * See also the `filterField`, `parentField`, and `childField`.
-     *
      * @default `5`
      */
     filterFieldRange?: number;
@@ -593,7 +546,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * The 0-based position of the first result to return in the non-paginated result set.
      *
      * Along with the `numberOfResults` parameter, this allows you to retrieve a specific page of result items.
-     *
      * @default `0`
      */
     firstResult?: number;
@@ -605,16 +557,13 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * Whether to treat the `AND`, `NEAR`, `NOT`, and `OR` keywords in the basic query expression (see the `q` parameter) as Coveo Cloud query syntax operators even if those keywords are in lowercase.
      *
      * **Note:** Setting this parameter to `true` has no effect unless you also set the `enableQuerySyntax` parameter to `true`.
-     *
      * @example
      * If you set this parameter, and the `enableQuerySyntax` parameter to `true`, the index interprets the `near` keyword in the basic query expression service center near me as the `NEAR` Coveo Cloud query syntax operator.
-     *
      * @default `false`
      */
     lowercaseOperators?: boolean;
     /**
      * The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the `q` parameter).
-     *
      * @example `I am looking for an enterprise-class native cloud SaaS/PaaS solution that ...`
      */
     lq?: string;
@@ -624,7 +573,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Note:** This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression (`lq`).
      *
      * See also the `lqPartialMatchThreshold` parameter.
-     *
      * @default `5`
      */
     lqPartialMatchKeywords?: string;
@@ -636,7 +584,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results.
      *
      * See also the `lqPartialMatchThreshold` parameter.
-     *
      * @default `100`
      */
     lqPartialMatchMaxKeywords?: number;
@@ -654,29 +601,24 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Note:** This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression (`lq`).
      *
      * See also the `lqPartialMatchKeywords` parameter.
-     *
      * @example `3`
      * @example `75%`
      * @example `all`
-     *
      * @default `50%`
      */
     lqPartialMatchThreshold?: RestThreshold;
     /**
      * The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model.
-     *
      * @default `3`
      */
     mlDidYouMeanMaxCandidates?: number;
     /**
      * The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range `[0.8, 2]`.
-     *
      * @default `1.0`
      */
     mlDidYouMeanMinScore?: number;
     /**
      * Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing.
-     *
      * @default `false`
      */
     mlDidYouMeanUseFacetCount?: boolean;
@@ -688,7 +630,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature.
      *
      * **Note:** The maximum `numberOfResults` value depends on the index settings of your Coveo Cloud V2 organization. By default, a Coveo Cloud V2 index can return a maximum of 1000 items per query.
-     *
      * @default `10`
      */
     numberOfResults?: number;
@@ -702,7 +643,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Notes:**
      * - In the index, the values of the `parentField` must only contain alphanumerical characters. Using a `childField` whose values contain non-indexable characters (such as underscores) will make folding fail.
      * - The values of the `parentField` must contain 60 characters or less (60 being the default maximum of characters for a word in the index).
-     *
      * @example `@foldingchild`
      */
     parentField?: string;
@@ -714,7 +654,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Notes:**
      * - This feature only applies to the basic expression (`q`) of a query, and to the basic `queryOverride` of its Group By operations.
      * - When the `enableQuerySyntax` parameter is set to `true`, this feature has no effect on a basic expression containing advanced Coveo Cloud query syntax (field expressions, operators, etc.).
-     *
      * @default `false`
      */
     partialMatch?: boolean;
@@ -728,7 +667,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * - Stemming expansions **do not** count towards the `partialMatchKeywords` count.
      *
      * See also the `partialMatchThreshold` parameter.
-     *
      * @default `5`
      */
     partialMatchKeywords?: string;
@@ -748,11 +686,9 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * - A keyword and its stemming expansions count as a single keyword when evaluating whether an item meets the `partialMatchThreshold`.
      *
      * See also the `partialMatchKeywords` parameter.
-     *
      * @example `3`
      * @example `75%`
      * @example `all`
-     *
      * @default `50%`
      */
     partialMatchThreshold?: RestThreshold;
@@ -768,7 +704,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * **Note:** Setting this parameter to true has no effect unless you also set the `wildcards` parameter to `true`.
      *
      * See [Using Wildcards in Queries](https://docs.coveo.com/en/1580/).
-     *
      * @default `false`
      */
     questionMark?: boolean;
@@ -785,13 +720,11 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the `excerptLength` parameter).
      *
      * **Note:** The maximum length of the retrieved sentences (in number of characters) is determined by the value of the `excerptLength` parameter.
-     *
      * @default `false`
      */
     retrieveFirstSentences?: boolean;
     /**
      * Whether the `q` value contains the URI hash of a specific item that should be returned.
-     *
      * @default `false`
      */
     searchById?: boolean;
@@ -808,11 +741,9 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * You can specify a list of comma-separated sort criteria. However, this only works when combining:
      * - two or more field criteria (e.g., `@views descending,@likes descending`).
      * - a single date criteria with one or more field criteria (e.g., `date ascending,@views descending`).
-     *
      * @example `date ascending`
      * @example `@author ascending`
      * @example `date descending,@views descending,@likes descending`
-     *
      * @default `relevancy`
      */
     sortCriteria?: string;
@@ -820,7 +751,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see [Rendering Static Content Using Persistent Queries](https://docs.coveo.com/en/1009/)).
      *
      * **Note:** Setting this parameter to `true` overwrites the `maximumAge` parameter value for this query.
-     *
      * @default `false`
      */
     staticQuery?: boolean;
@@ -828,7 +758,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * The length of the automatically generated item summary.
      *
      * The index generates a result item *summary* independently from the query, as opposed to a result item *excerpt*, which is generated based on query keywords.
-     *
      * @default `0`
      */
     summaryLength?: number;
@@ -848,7 +777,6 @@ export interface PostSearchBodyQueryParams extends PostSearchBodyCommonParams {
      * Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the `q` parameter) containing wildcard characters (`*`) to the possible matching keywords. See also the `questionMark` parameter.
      *
      * See [Using Wildcards in Queries](https://docs.coveo.com/en/1580/).
-     *
      * @default `false`
      */
     wildcards?: boolean;
@@ -858,8 +786,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * The query and page view actions previously made by the current user.
      *
      * Coveo Machine Learning content recommendations models use this information to provide contextually relevant output.
-     *
-     * @type {RestActionHistory[]}
      */
     actionsHistory?: RestActionHistory[];
     /**
@@ -878,7 +804,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * - `clientRequestId` (string): A GUID generated by the client representing the current request. This information is used to identify operations across different apis related to the same request.
      * - `clientTimestamp` (string): Client ISO 8601 timestamp with milliseconds.
      * - `userAgent` (string): The user agent of the request. If not present, the user agent is obtained from the [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) header. This information is required when endpoints are behind a proxy.
-     *
      * @example
      * ```json
      * {
@@ -887,7 +812,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      *   "deviceId": "Chrome"
      * }
      * ```
-     *
      * @example
      * ```json
      * {
@@ -906,7 +830,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * When logging a **Search** usage analytics event for a query, the `customData` field of that event should include the same data as the `context` parameter of the query. However, each `context` key included in `customData` must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).
      *
      * See also the `referrer` parameter.
-     *
      * @example
      * ```json
      * {
@@ -924,7 +847,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * - Use `xlsx` to generate an Excel file containing the results (binary).
      *
      * **Note:** Debug information (see the `debug` parameter) can only appear in a response in the JSON format.
-     *
      * @default `json`
      */
     format?: RestFormat;
@@ -934,13 +856,11 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * If you do not specify an `indexToken` (or `index`) value, any index mirror could be used.
      *
      * **Note:** Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).
-     *
      * @example `ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==`
      */
     indexToken?: string;
     /**
      * The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization.
-     *
      * @default `coveo`
      */
     indexType?: string;
@@ -950,7 +870,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * Coveo Machine Learning models may use this information to provide contextually relevant output.
      *
      * **Note:** When logging a **Search** usage analytics event for a query, the anonymous field of that event should be set to the `isGuestUser` value of the query.
-     *
      * @default `false`
      */
     isGuestUser?: boolean;
@@ -960,7 +879,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * Coveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.
      *
      * **Note:** When logging a **Search** usage analytics event, the language field of that event should match the language part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).
-     *
      * @example `en-US`
      */
     locale?: string;
@@ -968,7 +886,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * The identifier for a logical group of indexes that have been configured to include documents form the same sources.
      *
      * If you do not specify a `logicalIndex` value, the `default` grouping will be used, typically including all indexes.
-     *
      * @example `webcontentonly`
      */
     logicalIndex?: string;
@@ -978,7 +895,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * If the results of a specific request are available in the cache, and if those results are no older than the `maximumAge` value, the service returns those results rather than forwarding a new query to the index.
      *
      * **Note:** This parameter is automatically overridden when `staticQuery` is set to `true`.
-     *
      * @default `-1` (which corresponds to the internal default value (15 minutes))
      */
     maximumAge?: number;
@@ -997,7 +913,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * - `categoryFilter` (string): The name of a category of products to get recommendations for.
      * - `brandFilter` (string): The name of a brand of products to get recommendations for.
      * - `filters` (map of strings): The dimensions along with the values to be used at query time by the model as filters for potential suggestions. Only applies to Automatic relevance Tuning, Query Suggestions, or Dynamic Navigation Experience models that don't use the default `filterFields` advanced parameter values. **Example:** `"filters": { "originContext": "<MY-VALUE>", "originLevel2": "<MY-VALUE>" }`.
-     *
      * @example
      * ```json
      * {
@@ -1007,7 +922,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      *   "considerUserContext": false
      * }
      * ```
-     *
      * @example
      * ```json
      * {"wordSelection": "wordsKept:4"}
@@ -1018,7 +932,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * The basic query expression, typically the keywords entered by the end user in a query box.
      *
      * **Note:** When logging a **Search** usage analytics event for a query, the `queryText` field of that event should be set to the `q` value of the corresponding query.
-     *
      * @example `Coveo "Cloud V2" platform`
      */
     q?: string;
@@ -1026,7 +939,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * The identifier of the recommendation interface from which the request originates.
      *
      * Coveo Machine Learning content recommendations models may use this information to provide contextually relevant output.
-     *
      * @example `RecommendedProducts`
      */
     recommendation?: string;
@@ -1038,7 +950,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * **Note:** When logging a **Search** usage analytics event for a query, the `originLevel3` field of that event should be set to the `referrer` value of the query, if specified.
      *
      * See also the `context` parameter.
-     *
      * @example `http://www.example.com`
      */
     referrer?: string;
@@ -1055,11 +966,9 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * You can specify a list of comma-separated sort criteria. However, this only works when combining:
      * - two or more field criteria (e.g., `@views descending,@likes descending`).
      * - a single date criteria with one or more field criteria (e.g., `date ascending,@views descending`).
-     *
      * @example `date ascending`
      * @example `@author ascending`
      * @example `date descending,@views descending,@likes descending`
-     *
      * @default `relevancy`
      */
     /**
@@ -1070,7 +979,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * **Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should be set to the `tab` value of the query (or to the `"default"` string, if no `tab` value was specified in the query).
      *
      * See also the `searchHub` parameter.
-     *
      * @example `ForumTab`
      */
     tab?: string;
@@ -1078,7 +986,6 @@ interface PostSearchBodyCommonParams extends SharedSearchParams {
      * A GUID representing the current user, who can be authenticated or anonymous. This GUID is normally generated by the usage analytics service and stored in a non-expiring browser cookie.
      *
      * Coveo Machine Learning models may use this information to provide contextually relevant output.
-     *
      * @example `5cb98953-9c13-42ff-8176-e6fcba6a50bf`
      */
     visitorId?: string;
@@ -1112,7 +1019,6 @@ export type RestRangeAlgorithm = 'equiprobable' | 'even';
 export interface RestActionHistory {
     /**
      * The action history event name.
-     *
      * @example `PageView`
      *
      * Allowed values are:
@@ -1122,13 +1028,11 @@ export interface RestActionHistory {
     name?: string;
     /**
      * The time when the action history event was sent from the client.
-     *
      * @example `2017-08-15T17:34:08.398Z`
      */
     time?: string;
     /**
      * The action history value, which is either a query expression or a page URI, depending on the action history event `name`.
-     *
      * @example `http://www.example.com/`
      */
     value?: string;
@@ -1141,7 +1045,6 @@ export interface RestAnalyticsRequest {
      * A GUID representing the client id.
      *
      * **Note:** The `clientId` and `deviceId` replaces the deprecated `visitorId`.
-     *
      * @example `6d148f06-5f15-4639-81b4-792a9b94eb5f`
      */
     clientId?: string;
@@ -1149,13 +1052,11 @@ export interface RestAnalyticsRequest {
      * A GUID generated by the client representing the current request.
      *
      * This information is used to identify operations across different apis related to the same request.
-     *
      * @example `6c59a3aa-cb66-492e-9c08-9f1937467b60`
      */
     clientRequestId?: string;
     /**
      * Client ISO 8601 timestamp with milliseconds.
-     *
      * @example `2020-09-09T19:00:45.603-04:00`
      */
     clientTimestamp?: string;
@@ -1163,7 +1064,6 @@ export interface RestAnalyticsRequest {
      * The name of the device that the end user is using. It has to be explicitly passed from native mobile apps.
      *
      * **Note:** The `clientId` and `deviceId` replaces the deprecated `visitorId`.
-     *
      * @example `Chrome`
      */
     deviceId?: string;
@@ -1173,7 +1073,6 @@ export interface RestAnalyticsRequest {
      * If not present, the referrer is obtained from the [Referer](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer) header.
      *
      * **Note:** This information can be obtained from `coveo.analytics.js`.
-     *
      * @example `http://www.example.com/`
      */
     documentLocation?: string;
@@ -1183,7 +1082,6 @@ export interface RestAnalyticsRequest {
      * Coveo Machine Learning models may use this information to provide contextually relevant output.
      *
      * **Note:** This information can be obtained from `coveo.analytics.js`.
-     *
      * @example `http://www.example.com/`
      */
     documentReferrer?: string;
@@ -1191,7 +1089,6 @@ export interface RestAnalyticsRequest {
      * A GUID representing the page ID.
      *
      * **Note:** This information can be obtained from `coveo.analytics.js`.
-     *
      * @example `c4e3aa42-5afa-4b01-8bfd-79b7b49668f7`
      */
     pageId?: string;
@@ -1199,13 +1096,11 @@ export interface RestAnalyticsRequest {
      * The user agent of the request. If not present, the user agent is obtained from the [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) header.
      *
      * **Note:** This information is required when endpoints are behind a proxy.
-     *
      * @example `Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36`
      */
     userAgent?: string;
     /**
      * The ID of the logged user. If not present, the id is obtained from the authentication token.
-     *
      * @example `user@email.com`
      */
     userId?: string;
@@ -1213,7 +1108,6 @@ export interface RestAnalyticsRequest {
      * The user IP. If not present, the IP is obtained from the [X-Forwarded-For](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For) and [Forwarded](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded) headers.
      *
      * **Note:** This information is required when endpoints are behind a proxy.
-     *
      * @example `127.0.0.1`
      */
     userIp?: string;
@@ -1224,12 +1118,10 @@ export interface RestAnalyticsRequest {
 export interface RestCategoryFacetRequest {
     /**
      * The character to use to split field values into a hierarchical sequence.
-     *
      * @example
      * For a multi-value `field` containing the following values:
      * `c; c>folder2; c>folder2>folder3;`
      * The delimiting character is `>`.
-     *
      * @default `|`
      */
     delimitingCharacter?: string;
@@ -1237,13 +1129,11 @@ export interface RestCategoryFacetRequest {
      * The name of the field in which to look for hierarchical values.
      *
      * **Note:** You must ensure that the **Multi-value facet** option is enabled for this field in your index (see [Add or Edit Fields](https://docs.coveo.com/en/1982/)).
-     *
      * @example `@categories`
      */
     field: string;
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
-     *
      * @default `true`
      */
     filterFacetCount?: boolean;
@@ -1251,13 +1141,11 @@ export interface RestCategoryFacetRequest {
      * The maximum number of query result items to scan.
      *
      * **Note:** Specifying a high `injectionDepth` value can negatively impact query performance.
-     *
      * @default `1000`
      */
     injectionDepth?: number;
     /**
      * The maximum number of values to return.
-     *
      * @default `10`
      */
     maximumNumberOfValues?: number;
@@ -1271,7 +1159,6 @@ export interface RestComputedField {
      * The name of the numeric field on which to perform the aggregate operation.
      *
      * **Tip:** You should ensure that the **Use cache for computed fields** option is enabled for that field in your index in order to speed up evaluation (see [Add or Edit Fields](https://docs.coveo.com/en/1982/)).
-     *
      * @example `@wordcount`
      */
     field: string;
@@ -1297,7 +1184,6 @@ export interface RestFacetOptions {
      * Whether to take the scores generated by the index into account when reordering facets.
      *
      * **Note:** Setting this to `false` implies that only the scores generated by a Coveo ML DNE model will be taken into account when automatically reordering facets. To disable automatic facet reordering entirely, set `freezeFacetOrder` to `true` instead.
-     *
      * @default `true`
      */
     enableIndexFacetOrdering?: boolean;
@@ -1305,7 +1191,6 @@ export interface RestFacetOptions {
      * Whether facets should be returned in the same order they were requested.
      *
      * **Note:** Setting this to `true` entirely prevents automatic score-based facet reordering. To allow automatic facet reordering, but only take into account the scores generated by a Coveo ML DNE model, set `enableIndexFacetOrdering` to `false` instead.
-     *
      * @default `false`
      */
     freezeFacetOrder?: boolean;
@@ -1313,7 +1198,6 @@ export interface RestFacetOptions {
 export interface RestSpecificFacetRequest {
     /**
      * The values displayed by the facet in the search interface at the moment of the request.
-     *
      * @default `[]`
      */
     currentValues?: RestFacetValue[];
@@ -1325,13 +1209,11 @@ export interface RestSpecificFacetRequest {
      * The name of the field on which to base the facet request.
      *
      * **Note:** Must reference a field whose **Facet** option is enabled (see [Add or Edit Fields](https://docs.coveo.com/en/1982)).
-     *
      * @example `author`
      */
     field: string;
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
-     *
      * @default `true`
      */
     filterFacetCount?: boolean;
@@ -1339,7 +1221,6 @@ export interface RestSpecificFacetRequest {
      * Whether to include the facet request’s `currentValues` in corresponding facet response’s `values` array.
      *
      * **Note:** Setting this to `true` is useful to ensure that the facet does not move around while the end-user is interacting with it in the search interface.
-     *
      * @default `false`
      */
     freezeCurrentValues?: boolean;
@@ -1347,13 +1228,11 @@ export interface RestSpecificFacetRequest {
      * The maximum number of items to scan for facet values.
      *
      * **Note:** A high `injectionDepth` may negatively impact the facet request performance.
-     *
      * @default `100`
      */
     injectionDepth?: number;
     /**
      * Whether the facet is expanded in the search interface at the moment of the request.
-     *
      * @default `false`
      */
     isFieldExpanded?: boolean;
@@ -1364,13 +1243,11 @@ export interface RestSpecificFacetRequest {
      * **Notes:**
      * - If `freezeCurrentValues` is `true` or if requesting range facet values, `numberOfValues` is automatically set to the `currentValues` array length.
      * - When requesting hierarchical facet values, `numberOfValues` is only taken account when the `currentValues` array is empty (i.e., when retrieving the first level of values).
-     *
      * @default `8`
      */
     numberOfValues?: number;
     /**
      * Whether to prevent Coveo ML from automatically selecting values.
-     *
      * @default `false`
      */
     preventAutoSelect?: boolean;
@@ -1398,7 +1275,6 @@ export interface RestSpecificFacetRequest {
 export interface RestDateRangeFacetRequest {
     /**
      * The values displayed by the facet in the search interface at the moment of the request.
-     *
      * @default `[]`
      */
     currentValues?: RestFacetValue[];
@@ -1410,13 +1286,11 @@ export interface RestDateRangeFacetRequest {
      * The name of the field on which to base the facet request.
      *
      * **Note:** Must reference a field whose **Facet** option is enabled (see [Add or Edit Fields](https://docs.coveo.com/en/1982)).
-     *
      * @example `author`
      */
     field: string;
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
-     *
      * @default `true`
      */
     filterFacetCount?: boolean;
@@ -1424,7 +1298,6 @@ export interface RestDateRangeFacetRequest {
      * Whether to include the facet request’s `currentValues` in corresponding facet response’s `values` array.
      *
      * **Note:** Setting this to `true` is useful to ensure that the facet does not move around while the end-user is interacting with it in the search interface.
-     *
      * @default `false`
      */
     freezeCurrentValues?: boolean;
@@ -1437,7 +1310,6 @@ export interface RestDateRangeFacetRequest {
      * - Setting `generateAutomaticRanges` to `true` only makes sense when the Facet `field` references a numeric or date field in the index.
      * - The index cannot automatically generate range values of a field generated by a query function. In such cases, you must rather use the `rangeValues` Facet parameter.
      * - Automatic range generation will fail if the referenced `field` is dynamically generated by a query function.
-     *
      * @default `false`
      */
     generateAutomaticRanges?: boolean;
@@ -1445,13 +1317,11 @@ export interface RestDateRangeFacetRequest {
      * The maximum number of items to scan for facet values.
      *
      * **Note:** A high `injectionDepth` may negatively impact the facet request performance.
-     *
      * @default `100`
      */
     injectionDepth?: number;
     /**
      * Whether the facet is expanded in the search interface at the moment of the request.
-     *
      * @default `false`
      */
     isFieldExpanded?: boolean;
@@ -1462,13 +1332,11 @@ export interface RestDateRangeFacetRequest {
      * **Notes:**
      * - If `freezeCurrentValues` is `true` or if requesting range facet values, `numberOfValues` is automatically set to the `currentValues` array length.
      * - When requesting hierarchical facet values, `numberOfValues` is only taken account when the `currentValues` array is empty (i.e., when retrieving the first level of values).
-     *
      * @default `8`
      */
     numberOfValues?: number;
     /**
      * Whether to prevent Coveo ML from automatically selecting values.
-     *
      * @default `false`
      */
     preventAutoSelect?: boolean;
@@ -1498,7 +1366,6 @@ export interface RestDateRangeFacetRequest {
      * |0      |500  |299               |
      * |500    |1000 |0                 |
      * |1000   |1500 |1                 |
-     *
      * @default `equiprobable`
      */
     rangeAlgorithm?: RestRangeAlgorithm;
@@ -1513,7 +1380,6 @@ export interface RestDateRangeFacetRequest {
      *
      * **Notes:**
      * - The Coveo ML DNE feature only works with the `score` sort criterion.
-     *
      * @default `ascending`
      */
     sortCriteria?: RestRangeFacetSortCriteria;
@@ -1525,7 +1391,6 @@ export interface RestDateRangeFacetRequest {
 export interface RestNumericalRangeFacetRequest {
     /**
      * The values displayed by the facet in the search interface at the moment of the request.
-     *
      * @default `[]`
      */
     currentValues?: RestFacetValue[];
@@ -1537,13 +1402,11 @@ export interface RestNumericalRangeFacetRequest {
      * The name of the field on which to base the facet request.
      *
      * **Note:** Must reference a field whose **Facet** option is enabled (see [Add or Edit Fields](https://docs.coveo.com/en/1982)).
-     *
      * @example `author`
      */
     field: string;
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
-     *
      * @default `true`
      */
     filterFacetCount?: boolean;
@@ -1551,7 +1414,6 @@ export interface RestNumericalRangeFacetRequest {
      * Whether to include the facet request’s `currentValues` in corresponding facet response’s `values` array.
      *
      * **Note:** Setting this to `true` is useful to ensure that the facet does not move around while the end-user is interacting with it in the search interface.
-     *
      * @default `false`
      */
     freezeCurrentValues?: boolean;
@@ -1564,7 +1426,6 @@ export interface RestNumericalRangeFacetRequest {
      * - Setting `generateAutomaticRanges` to `true` only makes sense when the Facet `field` references a numeric or date field in the index.
      * - The index cannot automatically generate range values of a field generated by a query function. In such cases, you must rather use the `rangeValues` Facet parameter.
      * - Automatic range generation will fail if the referenced `field` is dynamically generated by a query function.
-     *
      * @default `false`
      */
     generateAutomaticRanges?: boolean;
@@ -1572,13 +1433,11 @@ export interface RestNumericalRangeFacetRequest {
      * The maximum number of items to scan for facet values.
      *
      * **Note:** A high `injectionDepth` may negatively impact the facet request performance.
-     *
      * @default `100`
      */
     injectionDepth?: number;
     /**
      * Whether the facet is expanded in the search interface at the moment of the request.
-     *
      * @default `false`
      */
     isFieldExpanded?: boolean;
@@ -1589,13 +1448,11 @@ export interface RestNumericalRangeFacetRequest {
      * **Notes:**
      * - If `freezeCurrentValues` is `true` or if requesting range facet values, `numberOfValues` is automatically set to the `currentValues` array length.
      * - When requesting hierarchical facet values, `numberOfValues` is only taken account when the `currentValues` array is empty (i.e., when retrieving the first level of values).
-     *
      * @default `8`
      */
     numberOfValues?: number;
     /**
      * Whether to prevent Coveo ML from automatically selecting values.
-     *
      * @default `false`
      */
     preventAutoSelect?: boolean;
@@ -1625,7 +1482,6 @@ export interface RestNumericalRangeFacetRequest {
      * |0      |500  |299               |
      * |500    |1000 |0                 |
      * |1000   |1500 |1                 |
-     *
      * @default `equiprobable`
      */
     rangeAlgorithm?: RestRangeAlgorithm;
@@ -1640,7 +1496,6 @@ export interface RestNumericalRangeFacetRequest {
      *
      * **Notes:**
      * - The Coveo ML DNE feature only works with the `score` sort criterion.
-     *
      * @default `ascending`
      */
     sortCriteria?: RestRangeFacetSortCriteria;
@@ -1656,13 +1511,11 @@ export interface RestHierarchicalFacetRequest {
     basePath?: string[];
     /**
      * The values displayed by the facet in the search interface at the moment of the request.
-     *
      * @default `[]`
      */
     currentValues?: RestFacetValue[];
     /**
      * The character to use to split field values into a hierarchical sequence.
-     *
      * @example
      * For a multi-value field containing the following values:
      *
@@ -1673,7 +1526,6 @@ export interface RestHierarchicalFacetRequest {
      * For a hierarchical field containing the following values: `c;folder2;folder3;`
      *
      * The delimiting character is `;`.
-     *
      * @default `;`
      */
     delimitingCharacter?: string;
@@ -1685,19 +1537,16 @@ export interface RestHierarchicalFacetRequest {
      * The name of the field on which to base the facet request.
      *
      * **Note:** Must reference a field whose **Facet** option is enabled (see [Add or Edit Fields](https://docs.coveo.com/en/1982)).
-     *
      * @example `author`
      */
     field: string;
     /**
      * Whether to use `basePath` as a filter for the results.
-     *
      * @default `true`
      */
     filterByBasePath?: boolean;
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
-     *
      * @default `true`
      */
     filterFacetCount?: boolean;
@@ -1705,13 +1554,11 @@ export interface RestHierarchicalFacetRequest {
      * The maximum number of items to scan for facet values.
      *
      * **Note:** A high `injectionDepth` may negatively impact the facet request performance.
-     *
      * @default `100`
      */
     injectionDepth?: number;
     /**
      * Whether the facet is expanded in the search interface at the moment of the request.
-     *
      * @default `false`
      */
     isFieldExpanded?: boolean;
@@ -1722,13 +1569,11 @@ export interface RestHierarchicalFacetRequest {
      * **Notes:**
      * - If `freezeCurrentValues` is `true` or if requesting range facet values, `numberOfValues` is automatically set to the `currentValues` array length.
      * - When requesting hierarchical facet values, `numberOfValues` is only taken account when the `currentValues` array is empty (i.e., when retrieving the first level of values).
-     *
      * @default `8`
      */
     numberOfValues?: number;
     /**
      * Whether to prevent Coveo ML from automatically selecting values.
-     *
      * @default `false`
      */
     preventAutoSelect?: boolean;
@@ -1742,7 +1587,6 @@ export interface RestHierarchicalFacetRequest {
      *
      * **Notes:**
      * - The Coveo ML DNE feature only works with the `score` sort criterion.
-     *
      * @default `occurrences`
      */
     sortCriteria?: RestHierarchicalFacetSortCriteria;
@@ -1765,7 +1609,6 @@ export interface RestFacetValue {
      * The value to end the range at. Must be greater (or later) than the `start` value.
      *
      * **Note:** Timezone of date ranges are determined by the timezone parameter of the search request.
-     *
      * @example `100`
      * @example `2019/12/31@23:59:59`
      */
@@ -1774,13 +1617,11 @@ export interface RestFacetValue {
      * Whether to include the `end` value in the range.
      *
      * **Note:** In an Elasticsearch index, this parameter cannot be set to `true`.
-     *
      * @default `false`
      */
     endInclusive?: boolean;
     /**
      * Whether to prevent Coveo ML from automatically selecting the facet value.
-     *
      * @default `false`
      */
     preventAutoSelect?: boolean;
@@ -1796,14 +1637,12 @@ export interface RestFacetValue {
      * The value to start the range at.
      *
      * **Note:** Timezone of date ranges are determined by the timezone parameter of the search request.
-     *
      * @example `0`
      * @example `2019/01/01@00:00:00`
      */
     start?: string;
     /**
      * The current facet value state in the search interface.
-     *
      * @default `idle`
      */
     state?: string;
@@ -1811,7 +1650,6 @@ export interface RestFacetValue {
      * The facet value name.
      *
      * **Note:** In the case of a hierarchical facet value, this represents a single path segment.
-     *
      * @example `Alice Smith`
      */
     value: string;
@@ -1824,7 +1662,6 @@ export interface RestGroupByRangeValue {
      * The value to end the range at. Must be greater (or later) than the `start` value.
      *
      * **Note:** Timezone of date ranges are determined by the timezone parameter of the search request.
-     *
      * @example `100`
      * @example `2019/12/31@23:59:59`
      */
@@ -1833,7 +1670,6 @@ export interface RestGroupByRangeValue {
      * Whether to include the `end` value in the range.
      *
      * **Note:** In an Elasticsearch index, this parameter cannot be set to `true`.
-     *
      * @default `false`
      */
     endInclusive?: boolean;
@@ -1841,7 +1677,6 @@ export interface RestGroupByRangeValue {
      * The label to associate with the range.
      *
      * **Note:** Not currently leveraged.
-     *
      * @example `0 - 100`
      * @example `In 2019`
      */
@@ -1850,7 +1685,6 @@ export interface RestGroupByRangeValue {
      * The value to start the range at.
      *
      * **Note:** Timezone of date ranges are determined by the timezone parameter of the search request.
-     *
      * @example `0`
      * @example `2019/01/01@00:00:00`
      */
@@ -1861,7 +1695,6 @@ export interface RestGroupByRequest {
      * The query expression that should override the advanced query expression on which the Group By operation is being performed (see the `aq` query parameter).
      *
      * **Note:**  If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `@year==2017`
      */
     advancedQueryOverride?: string;
@@ -1871,7 +1704,6 @@ export interface RestGroupByRequest {
      * See also the `completeFacetWithStandardValues` Group By operation parameter.
      *
      * If you do not explicitly specify an array of `allowedValues`, or if you specify an empty array, all field values are allowed.
-     *
      * @example
      * ```json
      * [
@@ -1889,7 +1721,6 @@ export interface RestGroupByRequest {
      * See also the `allowedValues` Group By operation parameter.
      *
      * If you do not explicitly specify a pattern type, the legacy pattern is used by default, which only support trailing wildcards.
-     *
      * @example `regex`
      */
     allowedValuesPatternType?: string;
@@ -1897,7 +1728,6 @@ export interface RestGroupByRequest {
      * Whether to complete the Group By operation result set with standard values.
      *
      * If you set this parameter to `true` and the number of specified `allowedValues` is lower than the `maximumNumberOfValues`, the Group By operation also attempts to returns standard values until the result set contains the `maximumNumberOfValues`.
-     *
      * @default `false`
      */
     completeFacetWithStandardValues?: boolean;
@@ -1911,7 +1741,6 @@ export interface RestGroupByRequest {
      * The query expression that should override the constant query expression on which the Group By operation is being performed (see the `cq` query parameter).
      *
      * **Note:** If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `@filetype==forumpost`
      */
     constantQueryOverride?: string;
@@ -1919,7 +1748,6 @@ export interface RestGroupByRequest {
      * The query expression that should override the disjunction query expression on which the Group By operation is being performed (see the `dq` query parameter).
      *
      * **Note:** If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `@date=2016-12-01..2016-12-31`
      */
     disjunctionQueryOverride?: string;
@@ -1927,13 +1755,11 @@ export interface RestGroupByRequest {
      * The name of the field on which to perform the Group By operation. The operation returns a Group By value for each distinct value of this field found in the query result items.
      *
      * **Note:** You must ensure that the **Facet** option is enabled for this field in your index (see [Add or Edit Fields](https://docs.coveo.com/en/1982/)).
-     *
      * @example `@author`
      */
     field: string;
     /**
      * Whether to exclude folded result parents when estimating the result count for each facet value.
-     *
      * @default `true`
      */
     filterFacetCount?: boolean;
@@ -1946,7 +1772,6 @@ export interface RestGroupByRequest {
      * - Setting `generateAutomaticRanges` to `true` only makes sense when the Group By `field` references a numeric or date field in the index.
      * - The index cannot automatically generate range values of a field generated by a query function. In such cases, you must rather use the `rangeValues` Group By parameter.
      * - Automatic range generation will fail if the referenced `field` is dynamically generated by a query function.
-     *
      * @default `false`
      */
     generateAutomaticRanges?: boolean;
@@ -1954,13 +1779,11 @@ export interface RestGroupByRequest {
      * The maximum number of query result items to scan for Group By values.
      *
      * **Note:** Specifying a high `injectionDepth` value can negatively impact query performance.
-     *
      * @default `1000`
      */
     injectionDepth?: number;
     /**
      * The maximum number of values the Group By operation should return.
-     *
      * @default `10`
      */
     maximumNumberOfValues?: number;
@@ -1968,7 +1791,6 @@ export interface RestGroupByRequest {
      * The query expression that should override the basic query expression on which the Group By operation is being performed (see the `q` query parameter).
      *
      * **Note:** If *any* query override parameter (e.g., `queryOverride`, `advancedQueryOverride`, etc.) is set in a Group By operation, **all** original parts of the query expression (i.e., `q`, `aq`, `cq`, and `dq`) will be ignored.
-     *
      * @example `Coveo Cloud V2 Platform`
      */
     queryOverride?: string;
@@ -1990,7 +1812,6 @@ export interface RestGroupByRequest {
      * - `computedfieldascending`/`computedfielddescending`: sort on the value of the first computed field for each Group By operation result (see the `ComputedFields` Group By parameter).
      * - `chisquare`: sort based on the relative frequency of field values in the query result set compared to their frequency in the entire index. This means that a field value that does not appear often in the index, but does appear often in the query result set will tend to appear higher.
      * - `nosort`: do not sort the results of the Group By operation. The field values will be appear in a random order.
-     *
      * @default `score`
      */
     sortCriteria?: RestGroupBySortCriteria;
@@ -2007,7 +1828,6 @@ export interface RestHierarchicalFacetValue {
     children?: RestHierarchicalFacetValue[];
     /**
      * Whether to prevent Coveo ML from automatically selecting the facet value.
-     *
      * @default `false`
      */
     preventAutoSelect?: boolean;
@@ -2021,7 +1841,6 @@ export interface RestHierarchicalFacetValue {
     retrieveCount?: number;
     /**
      * The current facet value state in the search interface.
-     *
      * @default `idle`
      */
     state?: string;
@@ -2029,7 +1848,6 @@ export interface RestHierarchicalFacetValue {
      * The facet value name.
      *
      * **Note:**  In the case of a hierarchical facet value, this represents a single path segment.
-     *
      * @example `Alice Smith`
      */
     value?: string;
@@ -2039,7 +1857,6 @@ export interface RestQueryFunctionRequest {
      * The name of the dynamic, temporary field in which to store the query function expression output.
      *
      * **Note:** The `fieldName` value must not correspond to an existing field in the index.
-     *
      * @example `numberoflikesplusone`
      */
     fieldName: string;
@@ -2049,7 +1866,6 @@ export interface RestQueryFunctionRequest {
      * **Notes:**
      * - The `function` expression can be defined using the ExprTk library syntax, but control and loop structures (e.g., if-then-else, while loop, etc.) are **not** supported.
      * - If the `function` expression references a numeric field, enable the **Use cache for computed fields** option on that field to speed up evaluation (see [Add or Edit Fields](https://docs.coveo.com/en/1982/)).
-     *
      * @example `@numberoflikes+1`
      */
     function: string;
@@ -2072,7 +1888,6 @@ export interface RestRankingFunctionRequest {
      * - `DAY`: A value corresponding to the duration of a day.
      *
      * **Tip:** If your query ranking function expression references certain numeric fields, you should ensure that the **Use cache for computed fields** option is enabled for each of those fields in order to speed up evaluation (see [Add or Edit Fields](https://docs.coveo.com/en/1982/)).
-     *
      * @example `-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))`
      */
     expression: string;
@@ -2080,7 +1895,6 @@ export interface RestRankingFunctionRequest {
      * The maximum boost this query ranking function can add to the ranking score of any given query result.
      *
      * This property only has a meaning if `normalizeWeight` is set to `true`.
-     *
      * @default `600`
      */
     modifier?: number;
@@ -2088,7 +1902,6 @@ export interface RestRankingFunctionRequest {
      * Whether to normalize the ranking score boosts resulting from the evaluation of this query ranking function using the standard index scale.
      *
      * Unless you want to completely override the index ranking and use the results of this query ranking function directly to boost the ranking scores of query results, you should set this to `true`.
-     *
      * @default `false`
      */
     normalizeWeight?: boolean;
@@ -2099,7 +1912,6 @@ export interface RestRankingFunctionRequest {
 export interface RestUserActionsParameters {
     /**
      * The user ID or visitor ID to retrieve user actions for.
-     *
      * @example `asmith@example.com`
      * @example `c7ab60e2-e6b8-41e8-be6a-ad5c8edc662e`
      */
@@ -2116,7 +1928,6 @@ export interface ItemPreviewHtmlParameters extends RestQueryParams {
     page?: number;
     /**
      * The approximate number of bytes to request in the HTML response.
-     *
      * @default 0 // meaning that the entire HTML document is requested
      */
     requestedOutputSize?: number;
@@ -2140,7 +1951,6 @@ export interface RestHierarchicalFacetResponseValue {
     path: string[];
     /**
      * The current facet value state in the search interface.
-     *
      * @default 'idle'
      */
     state: 'idle' | 'selected' | 'excluded';
@@ -2176,7 +1986,6 @@ export interface RestFacetResultValue extends RestHierarchicalFacetResponseValue
     end?: string | number;
     /**
      * Whether to include the `end` value in the range.
-     *
      * @default false
      */
     endInclusive?: boolean;
@@ -2189,7 +1998,6 @@ export interface RestFacetResultValue extends RestHierarchicalFacetResponseValue
 export interface RestFacetResult {
     /**
      * The name of the field on which the facet is based.
-     *
      * @example 'author'
      */
     field: string;
@@ -2422,7 +2230,6 @@ export interface RestQueryResult {
 export interface RestSuggestedFacetValue {
     /**
      * A DNE facet value suggestion.
-     *
      * @example 'Alice Smith'
      */
     value: string;
@@ -2436,7 +2243,6 @@ export interface RestSuggestedFacetValue {
 export interface RestSuggestedFacet {
     /**
      * The name of the field on which the DNE facet suggestion is based.
-     *
      * @example 'author'
      */
     field: string;