github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 23:27:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

HLRC: ML Add preview datafeed api (#34284)

Browse source 
* HLRC: ML Add preview datafeed api

* Changing deprecation handling for parser

* Removing some duplication in docs, will address other APIs in another PR
This commit is contained in:
Benjamin Trent 2018-10-04 11:28:44 -07:00 • committed by GitHub
parent dcfe64e0e4
commit 2dd058d607
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 600 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/java-rest/high-level/ml/preview-datafeed.asciidoc Normal file
View file

@ -0,0 +1,34 @@
--
:api: preview-datafeed
:request: PreviewDatafeedRequest
:response: PreviewDatafeedResponse
--
[id="{upid}-{api}"]
=== Preview Datafeed API
The Preview Datafeed API provides the ability to preview a {ml} datafeed's data
in the cluster. It accepts a +{request}+ object and responds
with a +{response}+ object.
[id="{upid}-{api}-request"]
==== Preview Datafeed Request
A +{request}+ object is created referencing a non-null `datafeedId`.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> Constructing a new request referencing an existing `datafeedId`
[id="{upid}-{api}-response"]
==== Preview Datafeed Response
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The raw +BytesReference+ of the data preview
<2> A +List<Map<String,Object>>+ that represents the previewed data
include::../execution.asciidoc[]

52
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -219,33 +219,36 @@ include::licensing/get-license.asciidoc[]
include::licensing/delete-license.asciidoc[]
== Machine Learning APIs
:upid: {mainid}-x-pack-ml
:doc-tests-file: {doc-tests}/MlClientDocumentationIT.java
The Java High Level REST Client supports the following Machine Learning APIs:
* <<java-rest-high-x-pack-ml-put-job>>
* <<java-rest-high-x-pack-ml-get-job>>
* <<java-rest-high-x-pack-ml-delete-job>>
* <<java-rest-high-x-pack-ml-open-job>>
* <<java-rest-high-x-pack-ml-close-job>>
* <<java-rest-high-x-pack-ml-flush-job>>
* <<java-rest-high-x-pack-ml-update-job>>
* <<java-rest-high-x-pack-ml-get-job-stats>>
* <<java-rest-high-x-pack-ml-put-datafeed>>
* <<java-rest-high-x-pack-ml-get-datafeed>>
* <<java-rest-high-x-pack-ml-delete-datafeed>>
* <<java-rest-high-x-pack-ml-start-datafeed>>
* <<java-rest-high-x-pack-ml-stop-datafeed>>
* <<java-rest-high-x-pack-ml-forecast-job>>
* <<java-rest-high-x-pack-ml-delete-forecast>>
* <<java-rest-high-x-pack-ml-get-buckets>>
* <<java-rest-high-x-pack-ml-get-overall-buckets>>
* <<java-rest-high-x-pack-ml-get-records>>
* <<java-rest-high-x-pack-ml-post-data>>
* <<java-rest-high-x-pack-ml-get-influencers>>
* <<java-rest-high-x-pack-ml-get-categories>>
* <<java-rest-high-x-pack-ml-get-calendars>>
* <<java-rest-high-x-pack-ml-put-calendar>>
* <<java-rest-high-x-pack-ml-delete-calendar>>
* <<{upid}-put-job>>
* <<{upid}-get-job>>
* <<{upid}-delete-job>>
* <<{upid}-open-job>>
* <<{upid}-close-job>>
* <<{upid}-flush-job>>
* <<{upid}-update-job>>
* <<{upid}-get-job-stats>>
* <<{upid}-put-datafeed>>
* <<{upid}-get-datafeed>>
* <<{upid}-delete-datafeed>>
* <<{upid}-preview-datafeed>>
* <<{upid}-start-datafeed>>
* <<{upid}-stop-datafeed>>
* <<{upid}-forecast-job>>
* <<{upid}-delete-forecast>>
* <<{upid}-get-buckets>>
* <<{upid}-get-overall-buckets>>
* <<{upid}-get-records>>
* <<{upid}-post-data>>
* <<{upid}-get-influencers>>
* <<{upid}-get-categories>>
* <<{upid}-get-calendars>>
* <<{upid}-put-calendar>>
* <<{upid}-delete-calendar>>
include::ml/put-job.asciidoc[]
include::ml/get-job.asciidoc[]
@ -257,6 +260,7 @@ include::ml/flush-job.asciidoc[]
include::ml/put-datafeed.asciidoc[]
include::ml/get-datafeed.asciidoc[]
include::ml/delete-datafeed.asciidoc[]
include::ml/preview-datafeed.asciidoc[]
include::ml/start-datafeed.asciidoc[]
include::ml/stop-datafeed.asciidoc[]
include::ml/get-job-stats.asciidoc[]