habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/reference-ml-flush_job.asciidoc Normal file
View File

@ -0,0 +1,68 @@
[[reference-ml-flush_job]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.flushJob
Force buffered data to be processed. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.
{ref}/ml-flush-job.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlFlushJobRequest, options?): Promise<MlFlushJobResponse>
----
[discrete]
===== `MlFlushJobRequest`
[source,ts]
----
interface MlFlushJobRequest extends <<shared-type-request-base, RequestBase>> {
job_id: <<shared-type-id, Id>>
advance_time?: <<shared-type-date-time, DateTime>>
calc_interim?: boolean
end?: <<shared-type-date-time, DateTime>>
skip_time?: <<shared-type-date-time, DateTime>>
start?: <<shared-type-date-time, DateTime>>
}
----
[discrete]
===== `MlFlushJobResponse`
[source,ts]
----
interface MlFlushJobResponse {
flushed: boolean
last_finalized_bucket_end?: <<shared-type-integer, integer>>
}
----