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

83
docs/reference-ml-put_data_frame_analytics.asciidoc Normal file
View File

@ -0,0 +1,83 @@
[[reference-ml-put_data_frame_analytics]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.putDataFrameAnalytics
Create a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.
{ref}/put-dfanalytics.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlPutDataFrameAnalyticsRequest, options?): Promise<MlPutDataFrameAnalyticsResponse>
----
[discrete]
===== `MlPutDataFrameAnalyticsRequest`
[source,ts]
----
interface MlPutDataFrameAnalyticsRequest extends <<shared-type-request-base, RequestBase>> {
id: <<shared-type-id, Id>>
allow_lazy_start?: boolean
analysis: MlDataframeAnalysisContainer
analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[]
description?: string
dest: MlDataframeAnalyticsDestination
max_num_threads?: <<shared-type-integer, integer>>
model_memory_limit?: string
source: MlDataframeAnalyticsSource
headers?: <<shared-type-http-headers, HttpHeaders>>
version?: <<shared-type-version-string, VersionString>>
}
----
[discrete]
===== `MlPutDataFrameAnalyticsResponse`
[source,ts]
----
interface MlPutDataFrameAnalyticsResponse {
authorization?: MlDataframeAnalyticsAuthorization
allow_lazy_start: boolean
analysis: MlDataframeAnalysisContainer
analyzed_fields?: MlDataframeAnalysisAnalyzedFields | string[]
create_time: <<shared-type-epoch-time, EpochTime>><<<shared-type-unit-millis, UnitMillis>>>
description?: string
dest: MlDataframeAnalyticsDestination
id: <<shared-type-id, Id>>
max_num_threads: <<shared-type-integer, integer>>
model_memory_limit: string
source: MlDataframeAnalyticsSource
version: <<shared-type-version-string, VersionString>>
}
----