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

72 lines
4.1 KiB
Plaintext

[[reference-ml-get_model_snapshots]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.getModelSnapshots
Get model snapshots info.
{ref}/ml-get-snapshot.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetModelSnapshotsRequest, options?): Promise<MlGetModelSnapshotsResponse>
----
[discrete]
===== `MlGetModelSnapshotsRequest`
[source,ts]
----
interface MlGetModelSnapshotsRequest extends <<shared-type-request-base, RequestBase>> {
job_id: <<shared-type-id, Id>>
snapshot_id?: <<shared-type-id, Id>>
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
desc?: boolean
end?: <<shared-type-date-time, DateTime>>
page?: MlPage
sort?: <<shared-type-field, Field>>
start?: <<shared-type-date-time, DateTime>>
}
----
[discrete]
===== `MlGetModelSnapshotsResponse`
[source,ts]
----
interface MlGetModelSnapshotsResponse {
count: <<shared-type-long, long>>
model_snapshots: MlModelSnapshot[]
}
----