Files
elasticsearch-js/docs/reference-query_rules-test.asciidoc
2024-12-05 14:46:52 -06:00

76 lines
3.9 KiB
Plaintext

[[reference-query_rules-test]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
[[client.queryRules.test]]
=== client.queryRules.test
Creates or updates a query ruleset.
{ref}/test-query-ruleset.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(QueryRulesTestRequest, options?): Promise<QueryRulesTestResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface QueryRulesTestRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
match_criteria: Record<string, any>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface QueryRulesTestResponse {
total_matched_rules: <<integer>>
matched_rules: QueryRulesTestQueryRulesetMatchedRule[]
}
[pass]
++++
</pre>
++++