elasticsearch-js/docs/reference/api/QueryRules.md

QueryRules

Constructor

::: new QueryRules(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
deleteRule	deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;	Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.
deleteRule	deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md), unknown>>;
deleteRule	deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;
deleteRuleset	deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;	Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable.
deleteRuleset	deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md), unknown>>;
deleteRuleset	deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;
getRule	getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;	Get a query rule. Get details about a query rule within a query ruleset.
getRule	getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md), unknown>>;
getRule	getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;
getRuleset	getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;	Get a query ruleset. Get details about a query ruleset.
getRuleset	getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md), unknown>>;
getRuleset	getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;
listRulesets	listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;	Get all query rulesets. Get summarized information about the query rulesets.
listRulesets	listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md), unknown>>;
listRulesets	listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;
putRule	putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;	Create or update a query rule. Create or update a query rule within a query ruleset. IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.
putRule	putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md), unknown>>;
putRule	putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;
putRuleset	putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;	Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the xpack.applications.rules.max_rules_per_ruleset cluster setting. IMPORTANT: Due to limitations within pinned queries, you can only select documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.
putRuleset	putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md), unknown>>;
putRuleset	putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;
test	test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;	Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
test	test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesTestResponse](./QueryRulesTestResponse.md), unknown>>;
test	test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;