habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP better generated API reference docs

Browse Source
This commit is contained in:
Josh Mock
2025-05-27 15:30:21 -05:00
parent a1dc6f55ee
commit b627037af1
3745 changed files with 30211 additions and 15508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/reference/api/QueryRulesQueryRule.md Normal file
View File

@ -0,0 +1,9 @@
## Interface `QueryRulesQueryRule`
| Name | Type | Description |
| - | - | - |
| `actions` | [QueryRulesQueryRuleActions](./QueryRulesQueryRuleActions.md) | The actions to take when the rule is matched. The format of this action depends on the rule type. |
| `criteria` | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md) | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md)[] | The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied. |
| `priority` | [integer](./integer.md) |   |
| `rule_id` | [Id](./Id.md) | A unique identifier for the rule. |
| `type` | [QueryRulesQueryRuleType](./QueryRulesQueryRuleType.md) | The type of rule. `pinned` will identify and pin specific documents to the top of search results. `exclude` will exclude specific documents from search results. |