Test run of new docs

2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
--- a/docs/reference-ml-get_categories.asciidoc
+++ b/docs/reference-ml-get_categories.asciidoc
@ -0,0 +1,68 @@
+[[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
+
+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`
+
+[source,ts]
+----
+interface MlGetCategoriesRequest extends <<shared-type-request-base, RequestBase>> {
+  job_id: <<shared-type-id, Id>>
+  category_id?: <<shared-type-category-id, CategoryId>>
+  from?: <<shared-type-integer, integer>>
+  partition_field_value?: string
+  size?: <<shared-type-integer, integer>>
+  page?: MlPage
+}
+----
+
+[discrete]
+===== `MlGetCategoriesResponse`
+
+[source,ts]
+----
+interface MlGetCategoriesResponse {
+  categories: MlCategory[]
+  count: <<shared-type-long, long>>
+}
+----
+