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

79 lines
4.0 KiB
Plaintext

[[reference-ml-update_filter]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.updateFilter]]
=== client.ml.updateFilter
Update a filter. Updates the description of a filter, adds items, or removes items from the list.
{ref}/ml-update-filter.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlUpdateFilterRequest, options?): Promise<MlUpdateFilterResponse>
----
[discrete]
==== MlUpdateFilterRequest
[pass]
++++
<pre>
++++
interface MlUpdateFilterRequest extends <<RequestBase>> {
filter_id: <<Id>>
add_items?: string[]
description?: string
remove_items?: string[]
}
[pass]
++++
</pre>
++++
[discrete]
==== MlUpdateFilterResponse
[pass]
++++
<pre>
++++
interface MlUpdateFilterResponse {
description: string
filter_id: <<Id>>
items: string[]
}
[pass]
++++
</pre>
++++