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

71 lines
4.1 KiB
Plaintext

[[reference-ml-get_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.ml.getTrainedModels
Get trained model configuration info.
{ref}/get-trained-models.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetTrainedModelsRequest, options?): Promise<MlGetTrainedModelsResponse>
----
[discrete]
===== `MlGetTrainedModelsRequest`
[source,ts]
----
interface MlGetTrainedModelsRequest extends <<shared-type-request-base, RequestBase>> {
model_id?: <<shared-type-ids, Ids>>
allow_no_match?: boolean
decompress_definition?: boolean
exclude_generated?: boolean
from?: <<shared-type-integer, integer>>
include?: MlInclude
size?: <<shared-type-integer, integer>>
tags?: string | string[]
}
----
[discrete]
===== `MlGetTrainedModelsResponse`
[source,ts]
----
interface MlGetTrainedModelsResponse {
count: <<shared-type-integer, integer>>
trained_model_configs: MlTrainedModelConfig[]
}
----