elasticsearch/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc
Benjamin Trent b96d929af3
[ML] add documentation for get deployment stats API (#78412)
* [ML] add documentation for get deployment stats API

* Apply suggestions from code review

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2021-09-29 07:20:25 -04:00

41 lines
1.4 KiB
Text

[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>>
* <<evaluate-dfanalytics,Evaluate {dfanalytics}>>
* <<explain-dfanalytics,Explain {dfanalytics}>>
* <<preview-dfanalytics,Preview {dfanalytics}>>
* <<start-dfanalytics,Start {dfanalytics-jobs}>>
* <<stop-dfanalytics,Stop {dfanalytics-jobs}>>
* <<update-dfanalytics,Update {dfanalytics-jobs}>>
You can use the following APIs to perform {infer} operations:
* <<put-trained-models>>
* <<put-trained-model-definition-part>>
* <<put-trained-model-vocabulary>>
* <<put-trained-models-aliases>>
* <<delete-trained-models>>
* <<delete-trained-models-aliases>>
* <<get-trained-models>>
* <<get-trained-models-stats>>
* <<get-trained-model-deployment-stats>>
You can deploy a trained model to make predictions in an ingest pipeline or in
an aggregation. Refer to the following documentation to learn more:
* <<search-aggregations-pipeline-inference-bucket-aggregation,{infer-cap} bucket aggregation>>
* <<inference-processor,{infer-cap} processor>>
* <<infer-trained-model-deployment>>
* <<start-trained-model-deployment>>
* <<stop-trained-model-deployment>>
See also <<ml-apis>>.