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

67 lines
4.3 KiB
Plaintext

[[reference-cat-ml_trained_models]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.cat.mlTrainedModels
Get trained models. Returns configuration and usage information about inference trained models. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
{ref}/cat-trained-model.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CatMlTrainedModelsRequest, options?): Promise<CatMlTrainedModelsResponse>
----
[discrete]
===== `CatMlTrainedModelsRequest`
[source,ts]
----
interface CatMlTrainedModelsRequest extends CatCatRequestBase {
model_id?: <<shared-type-id, Id>>
allow_no_match?: boolean
bytes?: <<shared-type-bytes, Bytes>>
h?: CatCatTrainedModelsColumns
s?: CatCatTrainedModelsColumns
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
}
----
[discrete]
===== `CatMlTrainedModelsResponse`
[source,ts]
----
type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[]
----