{
  "name": "RestQueryParameters",
  "structure": {
    "allOf": [
      {
        "type": "object",
        "properties": {
          "q": {
            "$ref": "#/components/schemas/Q"
          },
          "aq": {
            "$ref": "#/components/schemas/AQ"
          },
          "cq": {
            "$ref": "#/components/schemas/CQ"
          },
          "dq": {
            "$ref": "#/components/schemas/DQ"
          },
          "lq": {
            "$ref": "#/components/schemas/LQ"
          },
          "queryCorrection": {
            "type": "object",
            "required": [
              "enabled"
            ],
            "description": "This parameter controls the behavior of the Coveo query correction feature.\n\nOnce enabled, this feature will:\n  - Attempt to correct your query if it doesn't return enough results.\n  - If corrections are found, the API will automatically correct your query.\n\nQuery corrections are derived from the index's _Did You Mean_ feature and ML query corrections.\n\nCorrection information will be returned in the `queryCorrection` property of the response.\n\nIf the query was automatically corrected, it will return:\n\n  - The original query\n  - The corrected query\n\nOtherwise, it will return:\n\n  - A list of corrections generated by our system.\n\nThis feature is off by default for backward compatiblity reasons.\n",
            "properties": {
              "enabled": {
                "type": "boolean",
                "description": "Whether or not this feature should be enabled. If it's set to false, other `queryCorrection` properties will be ignored.\n\n> **Note:**\n> You don't have to set `enableDidYouMean` or `enableMlDidYouMean` to use this feature. The `queryCorrection` parameter takes precedence over them.\n"
              },
              "options": {
                "type": "object",
                "properties": {
                  "automaticallyCorrect": {
                    "type": "string",
                    "enum": [
                      "never",
                      "whenNoResults"
                    ],
                    "default": "whenNoResults",
                    "description": "If set to `whenNoResults`, there are no results returned by the query and the original basic query expression (`q`) appears to have been misspelled, the Search API will attempt to correct the `q` value by either:\n\n  - applying keyword corrections, if any were provided by the _Did You Mean_ index feature, or otherwise\n  - replacing the original `q` value with the highest ranked Coveo ML query suggestion that will return results.\n\n  If the `q` value was corrected, the Search API will then automatically fetch results from the index using the corrected `q` rather than the original one.\n\nIf set to `never`, potential corrections found by the _Did You Mean_ index feature will be returned instead of being automatically applied.\n"
                  }
                }
              }
            }
          },
          "enableDidYouMean": {
            "type": "boolean",
            "description": "Whether to enable the _Did You Mean_ feature of the index, which populates the `queryCorrections` property of a successful response with keyword correction suggestions.\n\n**Notes:**\n\n- The Did You Mean feature only processes the basic query expression (see the `q` parameter).\n- When both `enableDidYouMean` and `enableMLDidYouMean` parameter are set to `true`, the output of both features will appear in the `queryCorrections` array.\n- 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.\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "mlDidYouMeanMaxCandidates": {
            "type": "integer",
            "description": "The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model.\n\n**Default:** `3`",
            "format": "int32",
            "example": 5,
            "default": 3
          },
          "mlDidYouMeanMinScore": {
            "type": "number",
            "description": "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`].\n\n**Default:** `1.0`",
            "format": "double",
            "example": 0.8,
            "default": 1
          },
          "mlDidYouMeanUseFacetCount": {
            "type": "boolean",
            "description": "Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing.\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "enableMLDidYouMean": {
            "type": "boolean",
            "description": "**Important:** This feature is still in an experimental state.\n\nWhether to enable the Coveo ML query suggestions _Did You Mean_ feature, which populates the `queryCorrections` property of a successful response with keyword correction suggestions.\n\n**Notes:**\n\n- The Coveo ML query suggestions Did You Mean feature only processes the basic query expression (see the `q` parameter).\n- When both `enableDidYouMean` and `enableMLDidYouMean` parameter are set to `true`, the output of both features will appear in the `queryCorrections` array.\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "partialMatch": {
            "type": "boolean",
            "description": "Whether to convert a basic expression containing at least `partialMatchKeywords` to a _partial match expression_, so that any item containing at least `partialMatchThreshold` of those keywords will match the expression.\n\nIf you do not set this parameter to `true`, an item must contain all of the basic expression keywords to match the expression.\n\n**Notes:**\n\n- This feature only applies to the basic expression (`q`) of a query, and to the basic `queryOverride` of its Group By operations.\n- 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.).\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "partialMatchKeywords": {
            "type": "integer",
            "description": "The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression.\n\n**Notes:**\n\n- This parameter has no meaning unless the `partialMatch` parameter is set to `true`.\n- Repeated keywords in a basic expression count as a single keyword.\n- Thesaurus expansions in a basic expression count towards the `partialMatchKeywords` count.\n- Stemming expansions **do not** count towards the `partialMatchKeywords` count.\n\nSee also the `partialMatchThreshold` parameter.\n\n**Default:** `5`",
            "format": "int32",
            "example": 4,
            "default": 5
          },
          "partialMatchThreshold": {
            "type": "string",
            "description": "An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression.\n\nIf specified, the `partialMatchThreshold` value must either be:\n\n- a 32-bits unsigned integer (e.g., `3`),\n- a percentage value between 0% and 100% (e.g., `75%`),\n- the empty string, or\n- the `all` string.\n\nThe `\"\"` and the `all` value are both equivalent to `100%`.\n\n**Notes:**\n\n- This parameter has no meaning unless the `partialMatch` parameter is set to `true`.\n- A keyword and its stemming expansions count as a single keyword when evaluating whether an item meets the `partialMatchThreshold`.\n\nSee also the `partialMatchKeywords` parameter.\n\n**Examples:**\n\n- `3`\n- `75%`\n- `all`\n\n**Default:** `50%`",
            "example": "75%",
            "default": "50%"
          },
          "lqPartialMatchMaxKeywords": {
            "type": "integer",
            "description": "The maximum number of keywords from the large query expression (see the `lq` parameter) that will be included in the partial match expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression.\n\n**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`).\n\nSetting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results.\n\nSee also the `lqPartialMatchThreshold` parameter.\n\n**Default value**: `100`",
            "format": "int32",
            "example": 20,
            "default": 100
          },
          "lqPartialMatchKeywords": {
            "type": "integer",
            "description": "The minimum number of keywords that need to be present in the large query expression (see the `lq` parameter) to convert it to a partial match expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression.\n\n**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`).\n\nSee also the `lqPartialMatchThreshold` parameter.\n\n**Default**: `5`",
            "format": "int32",
            "example": 4,
            "default": 5
          },
          "lqPartialMatchThreshold": {
            "type": "string",
            "description": "An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression.\n\nIf specified, the `lqPartialMatchThreshold` value must either be:\n\n- a 32-bits unsigned integer (e.g., `3`),\n- a percentage value between 0% and 100% (e.g., `75%`),\n- the empty string (`\"\"`), or\n- the `all` string.\n\nThe `\"\"` and `all` values are both equivalent to `100%`.\n\n**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`).\n\nSee also the `lqPartialMatchKeywords` parameter.\n\n**Examples:**\n\n- `3`\n- `75%`\n- `all`\n\n**Default:** `50%`",
            "example": "75%",
            "default": "50%"
          },
          "wildcards": {
            "type": "boolean",
            "description": "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.\n\nSee [Using Wildcards in Queries](https://docs.coveo.com/en/1580/).\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "questionMark": {
            "type": "boolean",
            "description": "Whether to enable question mark characters (`?`) in the *wildcards* feature of the index in order to expand basic expression keywords (see the `q` parameter) containing question mark characters (`?`) to the possible matching keywords.\n\n**Note:** Setting this parameter to `true` has no effect unless you also set the `wildcards` parameter to `true`.\n\nSee [Using Wildcards in Queries](https://docs.coveo.com/en/1580/).\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "enableQuerySyntax": {
            "type": "boolean",
            "description": "Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the `q` parameter). See also the `lowercaseOperators` parameter.\n\n**Default:** `true`",
            "example": true,
            "default": true
          },
          "lowercaseOperators": {
            "type": "boolean",
            "description": "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.\n\n**Note:** Setting this parameter to `true` has no effect unless you also set the `enableQuerySyntax` parameter to `true`.\n\n**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.\n\n**Default:** `false`",
            "example": false,
            "default": false
          },
          "excerptLength": {
            "type": "integer",
            "description": "The maximum length of result excerpts (in number of characters).\n\nAn *excerpt* is a segmented text generated at query time by the index from the body of an item. When a query is performed, the *excerpt* yields relevant item body sections in which the queried terms are highlighted.\n\nAn *excerpt* includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters.\n\n**Note:** 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).\n\n**Default:** `200`",
            "format": "int32",
            "example": 250,
            "default": 200
          },
          "retrieveFirstSentences": {
            "type": "boolean",
            "description": "Whether to include the first sentences of textual items in the query results.\n\nFirst 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).\n\n**Note:** The maximum length of the retrieved sentences (in number of characters) is determined by the value of the `excerptLength` parameter.\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "fieldsToInclude": {
            "type": "array",
            "description": "The names of the fields to include with each item in the query results. If specified, no other fields will be included.\n\n**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.\n\nIf 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": [
              "clickableuri",
              "author",
              "date",
              "filetype",
              "language",
              "conversationid",
              "messageid",
              "childid",
              "adjustednumberoflikes"
            ],
            "items": {
              "type": "string"
            }
          },
          "fieldsToExclude": {
            "type": "array",
            "description": "The names of the fields to exclude from the query results. All other fields will be included with each item in the query result.\n\n**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.\n\nIf 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": [
              "documenttype",
              "size",
              "source"
            ],
            "items": {
              "type": "string"
            }
          },
          "groupBy": {
            "type": "array",
            "description": "The Group By operations to perform on the query results, typically to extract facets.",
            "items": {
              "$ref": "#/components/schemas/RestGroupBy"
            }
          },
          "facets": {
            "type": "array",
            "description": "The facet operations to perform on the query results.",
            "items": {
              "$ref": "#/components/schemas/RestFacetRequest"
            }
          },
          "generateAutomaticFacets": {
            "type": "object",
            "description": "Generate facets based on the most relevant fields in the index.",
            "properties": {
              "desiredCount": {
                "type": "integer",
                "format": "int32",
                "description": "The desired number of automatically generated facets.",
                "minimum": 0,
                "maximum": 20
              },
              "generationStrategy": {
                "type": "string",
                "description": "Defines the strategy used to decide which facets will be automatically generated.\n  - `mostRelevant`: Returns a maximum of `desiredCount` **relevant** facets. If fewer relevant facets are available, only those will be returned. This option prioritizes quality over quantity.\n  - `matchDesiredCount`: Returns all available `desiredCount` facets in your organization, even if some have lower relevance. This option prioritizes quantity over quality.",
                "enum": [
                  "mostRelevant",
                  "matchDesiredCount"
                ],
                "default": "mostRelevant"
              },
              "numberOfValues": {
                "type": "integer",
                "format": "int32",
                "description": "The desired number of automatically generated facet values.",
                "default": 8,
                "minimum": 1
              },
              "fields": {
                "$ref": "#/components/schemas/RestAutomaticFacetScope"
              },
              "currentFacets": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "field",
                    "currentValues"
                  ],
                  "properties": {
                    "field": {
                      "type": "string",
                      "description": "The name of the field on which to base the facet request.\n\n**Note:** Must reference a field whose **Facet** option is enabled (see [Manage fields](https://docs.coveo.com/en/1833/)).",
                      "example": "author"
                    },
                    "label": {
                      "type": "string",
                      "description": "A human-readable title that describes the facet."
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "specific"
                      ],
                      "description": "Request facet values representing specific values (e.g., Alice Smith, Bob Jones, etc.)."
                    },
                    "currentValues": {
                      "type": "array",
                      "description": "The values displayed by the facet in the search interface at the moment of the request.\n\n**Default:** `[]`",
                      "items": {
                        "$ref": "#/components/schemas/RestFacetSpecificValue"
                      }
                    }
                  }
                }
              },
              "sortCriteria": {
                "type": "string",
                "enum": [
                  "score",
                  "occurrences",
                  "alphaAscending",
                  "alphaDescending"
                ],
                "description": "The criterion to use when sorting the Group By operation results.\n\n**Allowed values:**\n\n- `score`: sort using the score value which is computed from the number of occurrences of a field value, and also from the position where query result items with this field value appear in the ranked query result set. When using this sort criterion, a field value with 100 occurrences might appear after one with only 10 occurrences, if the occurrences of the latter field value tend to appear higher in the ranked query result set.\n- `occurrences`: sort by occurrences, with field values that have the highest number of occurrences appearing first.\n- `alphaAscending`/`alphaDescending`: sort field values alphabetically.",
                "example": "score"
              },
              "tags": {
                "type": "array",
                "description": "Optional tag filters used to scope automatic facet candidates by property.\n\nIf you leave this parameter empty or undefined, automatic facet candidates are not tag filtered.",
                "maxItems": 50,
                "items": {
                  "type": "string",
                  "maxLength": 64,
                  "pattern": "^[A-Za-z0-9._:-]+$"
                }
              }
            }
          },
          "facetOptions": {
            "$ref": "#/components/schemas/RestFacetOptions"
          },
          "categoryFacets": {
            "type": "array",
            "description": "Data to easily query a hierarchical field using a path of hierarchical values.",
            "items": {
              "$ref": "#/components/schemas/RestCategoryFacetRequest"
            }
          },
          "sortCriteria": {
            "type": "string",
            "description": "The criteria to use for sorting the query results.\n\n**Allowed values:**\n\n- `relevancy`: use standard index ranking factors (adjacency, TDIDF, etc.) and custom ranking expressions (QREs and QRFs) to compute a ranking `score` for each query result item, and sort the query results by descending `score` value.\n- `date ascending`/`date descending`: use the `@date` field to sort the query results. This field typically contains the last modification date of each item.\n- `qre`: use only custom ranking expressions (QREs and QRFs) to compute a ranking `score` for each query result item, and sort the query results by descending `score` value.\n- `nosort`: do not sort the query results; the index will return result items in an essentially random order.\n- `@[field] ascending`/`@[field] descending`: sort using the value of a specific sortable field (replace `[field]` by the target field name).\n\nYou can specify a list of comma-separated sort criteria. However, this only works when combining:\n- two or more field criteria (e.g., `@views descending,@likes descending`).\n- a single date criteria with one or more field criteria (e.g., `date ascending,@views descending`).\n\n**Examples:**\n\n- `date ascending`\n- `@author ascending`\n- `date descending,@views descending,@likes descending`\n\n**Default:** `relevancy`",
            "example": "DateDescending",
            "default": "Relevancy"
          },
          "rankingFunctions": {
            "type": "array",
            "description": "The array of [ranking functions](https://docs.coveo.com/en/1448/) to execute on each query result item.\n\nThe result of a ranking function is added to the result score, which can affect sorting (see the `Relevancy` and `qre` values of the `sortCriteria` parameter).",
            "items": {
              "$ref": "#/components/schemas/RestRankingFunction"
            }
          },
          "queryFunctions": {
            "type": "array",
            "description": "The array of [query functions](https://docs.coveo.com/en/1451/) to execute on each query result item.\n\nThe result of a query function is stored in a temporary, dynamic field created at query time.",
            "items": {
              "$ref": "#/components/schemas/RestQueryFunction"
            }
          },
          "firstResult": {
            "type": "integer",
            "description": "The 0-based position of the first result to return in the non-paginated result set.\n\nAlong with the `numberOfResults` parameter, this allows you to retrieve a specific page of result items.\n\n**Note:** This can't be greater than the `maximumResults` value configured for your index. By default, `maximumResults` is set to 5,000 items.\n\n**Default:** `0`",
            "format": "int32",
            "example": 2,
            "default": 0
          },
          "numberOfResults": {
            "type": "integer",
            "description": "The number of results to return.\n\nAlong with the `firstResult` parameter, this allows you to retrieve a specific page of result items.\n\nThis parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature.\n\n**Note:** The maximum `numberOfResults` value is 2,000 items.\n\n**Default:** `10`",
            "format": "int32",
            "example": 5,
            "default": 10,
            "minimum": 0
          },
          "enableDuplicateFiltering": {
            "type": "boolean",
            "description": "Whether to filter out duplicates, so that items resembling one another only appear once in the query results.\n\n**Notes:**\n- Two items must be at least 85% similar to one another to be considered duplicates.\n- When a pair of duplicates is found, only the higher-ranked item of the two is kept in the result set.\n- 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.\n- Duplicate filtering and [result folding](https://docs.coveo.com/en/1466/) are mutually exclusive.\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "filterField": {
            "type": "string",
            "description": "The `@`-prefixed name of the field to use to group items into distinct folded query results (see [Result Folding](https://docs.coveo.com/en/1466/)).\n\nUse a field whose value is identical for all items to group under the same folded query result.\n\nSee also the `parentField`, `childField`, and `filterFieldRange` parameters.\n\n**Notes:**:\n\n- Result folding and duplicate filtering (using the `enableDuplicateFiltering` parameter) are mutually exclusive.",
            "example": "@foldingcollection"
          },
          "parentField": {
            "type": "string",
            "description": "The `@`-prefixed name of the field to use to be able to identify an item as a parent in a folded query result (see [Result Folding](https://docs.coveo.com/en/1466/)).\n\nUse a field whose value can uniquely identify each item. All items whose `childField` value is identical to the `parentField` value of another item are considered children of that other item.\n\nSee also the `filterField`, `childField`, and `filterFieldRange` parameters.\n\n**Notes:**\n\n- 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.\n- The values of the `parentField` must contain 60 characters or less (60 being the default maximum of characters for a word in the index).\n- Result folding and duplicate filtering (using the `enableDuplicateFiltering` parameter) are mutually exclusive.",
            "example": "@foldingchild"
          },
          "childField": {
            "type": "string",
            "description": "The `@`-prefixed name of the field to use to be able to identify an item as a child of another item in a folded query result (see [Result Folding](https://docs.coveo.com/en/1466/)).\n\nUse a field whose value points to the `parentField` value of the intended parent. Whenever an item is a child of another item, its `childField` value must be identical to the `parentField` value of that other item.\n\nSee also the `filterField`, `parentField`, and `filterFieldRange` parameters.\n\n**Notes:**\n\n- 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.\n- The values of the `childField` must contain 60 characters or less (60 being the default maximum of characters for a word in the index).\n- Result folding and duplicate filtering (using the `enableDuplicateFiltering` parameter) are mutually exclusive.",
            "example": "@foldingparent"
          },
          "filterFieldRange": {
            "type": "integer",
            "description": "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/)).\n\nSee also the `filterField`, `parentField`, and `childField`.\n\n**Notes:**:\n\n- Result folding and duplicate filtering (using the `enableDuplicateFiltering` parameter) are mutually exclusive.\n\n**Default:** `5`",
            "format": "int32",
            "example": 8,
            "default": 5
          },
          "summaryLength": {
            "type": "integer",
            "description": "The length of the automatically generated item summary.\n\nThe Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item *summary* made of sentences identified to be the most important ones in the item.\n\nThis *summary* is generated independently from the query, as opposed to a result item *excerpt*, which is generated based on query keywords.\n\n**Default:** `0`",
            "format": "int32",
            "default": 0
          },
          "sortField": {
            "type": "string",
            "description": "This parameter is exposed for backward compatibility reasons. Use the `sortCriteria` parameter along with the `@[field] ascending/@[field] descending` syntax instead.",
            "deprecated": true
          },
          "disableQuerySyntax": {
            "type": "boolean",
            "description": "This parameter is exposed for backward compatibility reasons. Use the `enableQuerySyntax` parameter instead.",
            "default": false,
            "deprecated": true
          },
          "staticQuery": {
            "type": "boolean",
            "description": "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/)).\n\n**Note:** Setting this parameter to `true` overwrites the `maximumAge` parameter value for this query.\n\n**Default:** `false`",
            "example": true,
            "default": false
          },
          "userActions": {
            "$ref": "#/components/schemas/RestUserActionParameter"
          },
          "commerce": {
            "$ref": "#/components/schemas/RestCommerceParameters"
          },
          "dictionaryFieldContext": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "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.\n\n**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.",
            "example": {
              "price": "storeA"
            }
          },
          "freeTextSearchFields": {
            "type": "array",
            "description": "The fields to use when performing free-text search.\n\nWhen provided, only these fields are searched for free-text terms.",
            "maxItems": 5,
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 510,
              "pattern": "^@?[a-zA-Z0-9_]+$"
            }
          },
          "fieldAliases": {
            "$ref": "#/components/schemas/RestFieldAliases"
          }
        }
      },
      {
        "type": "object",
        "properties": {
          "pipeline": {
            "$ref": "#/components/schemas/Pipeline"
          },
          "maximumAge": {
            "$ref": "#/components/schemas/MaximumAge"
          },
          "searchHub": {
            "$ref": "#/components/schemas/SearchHub"
          },
          "tab": {
            "$ref": "#/components/schemas/Tab"
          },
          "referrer": {
            "$ref": "#/components/schemas/Referrer"
          },
          "context": {
            "$ref": "#/components/schemas/Context"
          },
          "actionsHistory": {
            "$ref": "#/components/schemas/ActionsHistory"
          },
          "recommendation": {
            "$ref": "#/components/schemas/Recommendation"
          },
          "locale": {
            "$ref": "#/components/schemas/Locale"
          },
          "timezone": {
            "$ref": "#/components/schemas/Timezone"
          },
          "format": {
            "$ref": "#/components/schemas/Format"
          },
          "debug": {
            "$ref": "#/components/schemas/Debug"
          },
          "indexToken": {
            "$ref": "#/components/schemas/IndexToken"
          },
          "visitorId": {
            "$ref": "#/components/schemas/VisitorId"
          },
          "language": {
            "$ref": "#/components/schemas/Language"
          },
          "mlParameters": {
            "$ref": "#/components/schemas/MlParameters"
          },
          "pipelineRuleParameters": {
            "$ref": "#/components/schemas/PipelineRuleParameters"
          },
          "indexType": {
            "$ref": "#/components/schemas/IndexType"
          },
          "index": {
            "$ref": "#/components/schemas/Index"
          },
          "logicalIndex": {
            "$ref": "#/components/schemas/LogicalIndex"
          },
          "maximumTimeoutMs": {
            "$ref": "#/components/schemas/MaximumTimeoutMs"
          },
          "analytics": {
            "$ref": "#/components/schemas/AnalyticsRequestParameters"
          },
          "commerce": {
            "$ref": "#/components/schemas/RestCommerceParameters"
          }
        }
      }
    ]
  }
}