Skip to content

Commit 84a1f4e

Browse files
refactor(specs): add interface to manipulate query parameter between composition API & Search API (#5123)
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent b26a192 commit 84a1f4e

File tree

7 files changed

+756
-1067
lines changed

7 files changed

+756
-1067
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
enableABTest:
2+
type: boolean
3+
description: |
4+
Whether to enable index level A/B testing for this run request.
5+
If the composition mixes multiple indices, the A/B test is ignored.
6+
default: true
7+
x-categories:
8+
- Advanced
9+
10+
enableRules:
11+
type: boolean
12+
description: Whether to enable composition rules.
13+
default: true
14+
15+
getRankingInfo:
16+
type: boolean
17+
description: Whether the run response should include detailed ranking information.
18+
19+
ruleContexts:
20+
type: array
21+
items:
22+
type: string
23+
description: |
24+
Assigns a rule context to the run query
25+
[Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
26+
default: []
27+
example: [mobile]
28+
x-categories:
29+
- Rules

0 commit comments

Comments
 (0)