134 lines
4.9 KiB
Plaintext
134 lines
4.9 KiB
Plaintext
[[reference-shared-types-query-rules-types]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
|
|
|
|
== Shared QueryRules types
|
|
|
|
|
|
[discrete]
|
|
[[QueryRulesQueryRule]]
|
|
=== QueryRulesQueryRule
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface QueryRulesQueryRule {
|
|
rule_id: <<Id>>
|
|
type: <<QueryRulesQueryRuleType>>
|
|
criteria: <<QueryRulesQueryRuleCriteria>> | <<QueryRulesQueryRuleCriteria>>[]
|
|
actions: <<QueryRulesQueryRuleActions>>
|
|
priority?: <<integer>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[QueryRulesQueryRuleActions]]
|
|
=== QueryRulesQueryRuleActions
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface QueryRulesQueryRuleActions {
|
|
ids?: <<Id>>[]
|
|
docs?: <<QueryDslPinnedDoc>>[]
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[QueryRulesQueryRuleCriteria]]
|
|
=== QueryRulesQueryRuleCriteria
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface QueryRulesQueryRuleCriteria {
|
|
type: <<QueryRulesQueryRuleCriteriaType>>
|
|
metadata?: string
|
|
values?: any[]
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[QueryRulesQueryRuleCriteriaType]]
|
|
=== QueryRulesQueryRuleCriteriaType
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
type QueryRulesQueryRuleCriteriaType = 'global' | 'exact' | 'exact_fuzzy' | 'fuzzy' | 'prefix' | 'suffix' | 'contains' | 'lt' | 'lte' | 'gt' | 'gte' | 'always'
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[QueryRulesQueryRuleType]]
|
|
=== QueryRulesQueryRuleType
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
type QueryRulesQueryRuleType = 'pinned' | 'exclude'
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[QueryRulesQueryRuleset]]
|
|
=== QueryRulesQueryRuleset
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface QueryRulesQueryRuleset {
|
|
pass:[/**] @property ruleset_id <<Query>> Ruleset unique identifier */
|
|
ruleset_id: <<Id>>
|
|
pass:[/**] @property rules Rules associated with the query ruleset */
|
|
rules: <<QueryRulesQueryRule>>[]
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|