Files
elasticsearch-js/docs/reference-ml-get_filters.asciidoc
2024-12-05 14:46:46 -06:00

66 lines
3.9 KiB
Plaintext

[[reference-ml-get_filters]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.ml.getFilters
Get filters. You can get a single filter or all filters.
{ref}/ml-get-filter.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetFiltersRequest, options?): Promise<MlGetFiltersResponse>
----
[discrete]
===== `MlGetFiltersRequest`
[source,ts]
----
interface MlGetFiltersRequest extends <<shared-type-request-base, RequestBase>> {
filter_id?: <<shared-type-ids, Ids>>
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
}
----
[discrete]
===== `MlGetFiltersResponse`
[source,ts]
----
interface MlGetFiltersResponse {
count: <<shared-type-long, long>>
filters: MlFilter[]
}
----