A request to perform a query experiment on a collection using a pipeline.
| Name | Type | Description | Notes |
|---|---|---|---|
| variables | {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | The initial values for the variables the pipeline operates on and transforms throughout its steps. The most important variable is `q` which is the query the user entered, for example: ```json { "q": "search terms" } ``` To paginate through results, set the variables `page` and `resultsPerPage`, for example: ```json { "q": "search terms", "page": 5, "resultsPerPage": 20 } ``` To sort results, set the variable `sort` to the name of one of your collection's schema fields, for example: ```json { "q": "search terms", "sort": "name" } ``` To sort in reverse, prefix the schema field with a minus sign `-`, for example: ```json { "q": "search terms", "sort": "-name" } ``` | |
| custom_pipeline | Pipeline | [optional] | |
| pipeline | ExperimentRequestPipeline | [optional] | |
| promotions | [Promotion] | The promotions to consider active when running the search. Provided promotions override existing promotions with the same ID. | [optional] |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |