80 lines
4.0 KiB
Plaintext
80 lines
4.0 KiB
Plaintext
[[reference-ml-get_categories]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.getCategories]]
|
|
=== client.ml.getCategories
|
|
|
|
Get anomaly detection job results for categories.
|
|
|
|
{ref}/ml-get-category.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(MlGetCategoriesRequest, options?): Promise<MlGetCategoriesResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== MlGetCategoriesRequest
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface MlGetCategoriesRequest extends <<RequestBase>> {
|
|
job_id: <<Id>>
|
|
category_id?: <<CategoryId>>
|
|
from?: <<integer>>
|
|
partition_field_value?: string
|
|
size?: <<integer>>
|
|
page?: MlPage
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== MlGetCategoriesResponse
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface MlGetCategoriesResponse {
|
|
categories: MlCategory[]
|
|
count: <<long>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|