mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
HLRC: Add ML API PUT filter (#35175)
This commit is contained in:
parent
9d28a104e1
commit
a4442dacd7
12 changed files with 469 additions and 0 deletions
53
docs/java-rest/high-level/ml/put-filter.asciidoc
Normal file
53
docs/java-rest/high-level/ml/put-filter.asciidoc
Normal file
|
@ -0,0 +1,53 @@
|
|||
--
|
||||
:api: put-filter
|
||||
:request: PutFilterRequest
|
||||
:response: PutFilterResponse
|
||||
--
|
||||
[id="{upid}-{api}"]
|
||||
=== Put Filter API
|
||||
|
||||
The Put Filter API can be used to create a new {ml} filter
|
||||
in the cluster. The API accepts a +{request}+ object
|
||||
as a request and returns a +{response}+.
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Put Filter Request
|
||||
|
||||
A +{request}+ requires the following argument:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
<1> The configuration of the {ml} filter to create as a `MlFilter`
|
||||
|
||||
[id="{upid}-{api}-config"]
|
||||
==== Filter Configuration
|
||||
|
||||
The `MlFilter` object contains all the details about the {ml} filter
|
||||
configuration.
|
||||
|
||||
A `MlFilter` contains the following arguments:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-config]
|
||||
--------------------------------------------------
|
||||
<1> Required, the filter ID
|
||||
<2> Optional, the filter description
|
||||
<3> Optional, the items of the filter. A wildcard * can be used at the beginning or the end of an item.
|
||||
Up to 10000 items are allowed in each filter.
|
||||
|
||||
include::../execution.asciidoc[]
|
||||
|
||||
[id="{upid}-{api}-response"]
|
||||
==== Response
|
||||
|
||||
The returned +{response}+ returns the full representation of
|
||||
the new {ml} filter if it has been successfully created.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> The newly created `MlFilter`
|
|
@ -260,6 +260,7 @@ The Java High Level REST Client supports the following Machine Learning APIs:
|
|||
* <<{upid}-get-calendars>>
|
||||
* <<{upid}-put-calendar>>
|
||||
* <<{upid}-delete-calendar>>
|
||||
* <<{upid}-put-filter>>
|
||||
|
||||
include::ml/put-job.asciidoc[]
|
||||
include::ml/get-job.asciidoc[]
|
||||
|
@ -288,6 +289,7 @@ include::ml/get-categories.asciidoc[]
|
|||
include::ml/get-calendars.asciidoc[]
|
||||
include::ml/put-calendar.asciidoc[]
|
||||
include::ml/delete-calendar.asciidoc[]
|
||||
include::ml/put-filter.asciidoc[]
|
||||
|
||||
== Migration APIs
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue