OpenSearch/docs/reference/ml/df-analytics/apis/index.asciidoc

46 lines
1.3 KiB
Plaintext

[role="xpack"]
[testenv="platinum"]
[[ml-df-analytics-apis]]
== {ml-cap} {dfanalytics} APIs
You can use the following APIs to perform {ml} {dfanalytics} activities.
* <<put-dfanalytics,Create {dfanalytics-jobs}>>
* <<delete-dfanalytics,Delete {dfanalytics-jobs}>>
* <<get-dfanalytics,Get {dfanalytics-jobs} info>>
* <<get-dfanalytics-stats,Get {dfanalytics-jobs} statistics>>
* <<start-dfanalytics,Start {dfanalytics-jobs}>>
* <<stop-dfanalytics,Stop {dfanalytics-jobs}>>
* <<evaluate-dfanalytics,Evaluate {dfanalytics}>>
* <<explain-dfanalytics,Explain {dfanalytics}>>
For the `analysis` object resources, check <<ml-dfa-analysis-objects>>.
You can use the following APIs to perform {infer} operations.
* <<get-inference>>
* <<get-inference-stats>>
* <<delete-inference>>
See also <<ml-apis>>.
//CREATE
include::put-dfanalytics.asciidoc[]
//DELETE
include::delete-dfanalytics.asciidoc[]
include::delete-inference-trained-model.asciidoc[]
//EVALUATE
include::evaluate-dfanalytics.asciidoc[]
//ESTIMATE_MEMORY_USAGE
include::explain-dfanalytics.asciidoc[]
//GET
include::get-dfanalytics.asciidoc[]
include::get-dfanalytics-stats.asciidoc[]
include::get-inference-trained-model.asciidoc[]
include::get-inference-trained-model-stats.asciidoc[]
//SET/START/STOP
include::start-dfanalytics.asciidoc[]
include::stop-dfanalytics.asciidoc[]