Skip to content

Commit e6c5165

Browse files
lcawllcawl
committed
[DOCS] Updates location of ML pages
1 parent f736755 commit e6c5165

File tree

3 files changed

+111
-8
lines changed

3 files changed

+111
-8
lines changed

‎docs/en/stack/index.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
:kib-repo-dir: {docdir}/../../../../kibana/docs
1515
:xes-repo-dir: {docdir}/../../../../elasticsearch/x-pack/docs/en
16+
:es-repo-dir: {docdir}/../../../../elasticsearch/docs/reference
1617

1718
include::{asciidoc-dir}/../../shared/versions.asciidoc[]
1819
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

‎docs/en/stack/ml/api-quickref.asciidoc

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
[role="xpack"]
2+
[[ml-api-quickref]]
3+
== API quick reference
4+
5+
All {ml} endpoints have the following base:
6+
7+
[source,js]
8+
----
9+
/_xpack/ml/
10+
----
11+
// NOTCONSOLE
12+
13+
The main {ml} resources can be accessed with a variety of endpoints:
14+
15+
* <<ml-api-jobs,+/anomaly_detectors/+>>: Create and manage {ml} jobs
16+
* <<ml-api-datafeeds,+/datafeeds/+>>: Select data from {es} to be analyzed
17+
* <<ml-api-results,+/results/+>>: Access the results of a {ml} job
18+
* <<ml-api-snapshots,+/model_snapshots/+>>: Manage model snapshots
19+
//* <<ml-api-validate,+/validate/+>>: Validate subsections of job configurations
20+
21+
[float]
22+
[[ml-api-jobs]]
23+
=== /anomaly_detectors/
24+
25+
* {ref}/ml-put-job.html[PUT /anomaly_detectors/<job_id+++>+++]: Create a job
26+
* {ref}/ml-open-job.html[POST /anomaly_detectors/<job_id>/_open]: Open a job
27+
* {ref}/ml-post-data.html[POST /anomaly_detectors/<job_id>/_data]: Send data to a job
28+
* {ref}/ml-get-job.html[GET /anomaly_detectors]: List jobs
29+
* {ref}/ml-get-job.html[GET /anomaly_detectors/<job_id+++>+++]: Get job details
30+
* {ref}/ml-get-job-stats.html[GET /anomaly_detectors/<job_id>/_stats]: Get job statistics
31+
* {ref}/ml-update-job.html[POST /anomaly_detectors/<job_id>/_update]: Update certain properties of the job configuration
32+
* {ref}/ml-flush-job.html[POST anomaly_detectors/<job_id>/_flush]: Force a job to analyze buffered data
33+
* {ref}/ml-forecast.html[POST anomaly_detectors/<job_id>/_forecast]: Forecast future job behavior
34+
* {ref}/ml-close-job.html[POST /anomaly_detectors/<job_id>/_close]: Close a job
35+
* {ref}/ml-delete-job.html[DELETE /anomaly_detectors/<job_id+++>+++]: Delete a job
36+
37+
[float]
38+
[[ml-api-calendars]]
39+
=== /calendars/
40+
41+
* {ref}/ml-put-calendar.html[PUT /calendars/<calendar_id+++>+++]: Create a calendar
42+
* {ref}/ml-post-calendar-event.html[POST /calendars/<calendar_id+++>+++/events]: Add a scheduled event to a calendar
43+
* {ref}/ml-put-calendar-job.html[PUT /calendars/<calendar_id+++>+++/jobs/<job_id+++>+++]: Associate a job with a calendar
44+
* {ref}/ml-get-calendar.html[GET /calendars/<calendar_id+++>+++]: Get calendar details
45+
* {ref}/ml-get-calendar-event.html[GET /calendars/<calendar_id+++>+++/events]: Get scheduled event details
46+
* {ref}/ml-delete-calendar-event.html[DELETE /calendars/<calendar_id+++>+++/events/<event_id+++>+++]: Remove a scheduled event from a calendar
47+
* {ref}/ml-delete-calendar-job.html[DELETE /calendars/<calendar_id+++>+++/jobs/<job_id+++>+++]: Disassociate a job from a calendar
48+
* {ref}/ml-delete-calendar.html[DELETE /calendars/<calendar_id+++>+++]: Delete a calendar
49+
50+
[float]
51+
[[ml-api-filters]]
52+
=== /filters/
53+
54+
* {ref}/ml-put-filter.html[PUT /filters/<filter_id+++>+++]: Create a filter
55+
* {ref}/ml-update-filter.html[POST /filters/<filter_id+++>+++/_update]: Update a filter
56+
* {ref}/ml-get-filter.html[GET /filters/<filter_id+++>+++]: List filters
57+
* {ref}/ml-delete-filter.html[DELETE /filter/<filter_id+++>+++]: Delete a filter
58+
59+
[float]
60+
[[ml-api-datafeeds]]
61+
=== /datafeeds/
62+
63+
* {ref}/ml-put-datafeed.html[PUT /datafeeds/<datafeed_id+++>+++]: Create a {dfeed}
64+
* {ref}/ml-start-datafeed.html[POST /datafeeds/<datafeed_id>/_start]: Start a {dfeed}
65+
* {ref}/ml-get-datafeed.html[GET /datafeeds]: List {dfeeds}
66+
* {ref}/ml-get-datafeed.html[GET /datafeeds/<datafeed_id+++>+++]: Get {dfeed} details
67+
* {ref}/ml-get-datafeed-stats.html[GET /datafeeds/<datafeed_id>/_stats]: Get statistical information for {dfeeds}
68+
* {ref}/ml-preview-datafeed.html[GET /datafeeds/<datafeed_id>/_preview]: Get a preview of a {dfeed}
69+
* {ref}/ml-update-datafeed.html[POST /datafeeds/<datafeedid>/_update]: Update certain settings for a {dfeed}
70+
* {ref}/ml-stop-datafeed.html[POST /datafeeds/<datafeed_id>/_stop]: Stop a {dfeed}
71+
* {ref}/ml-delete-datafeed.html[DELETE /datafeeds/<datafeed_id+++>+++]: Delete {dfeed}
72+
73+
[float]
74+
[[ml-api-results]]
75+
=== /results/
76+
77+
* {ref}/ml-get-bucket.html[GET /results/buckets]: List the buckets in the results
78+
* {ref}/ml-get-bucket.html[GET /results/buckets/<bucket_id+++>+++]: Get bucket details
79+
* {ref}/ml-get-overall-buckets.html[GET /results/overall_buckets]: Get overall bucket results for multiple jobs
80+
* {ref}/ml-get-category.html[GET /results/categories]: List the categories in the results
81+
* {ref}/ml-get-category.html[GET /results/categories/<category_id+++>+++]: Get category details
82+
* {ref}/ml-get-influencer.html[GET /results/influencers]: Get influencer details
83+
* {ref}/ml-get-record.html[GET /results/records]: Get records from the results
84+
85+
[float]
86+
[[ml-api-snapshots]]
87+
=== /model_snapshots/
88+
89+
* {ref}/ml-get-snapshot.html[GET /model_snapshots]: List model snapshots
90+
* {ref}/ml-get-snapshot.html[GET /model_snapshots/<snapshot_id+++>+++]: Get model snapshot details
91+
* {ref}/ml-revert-snapshot.html[POST /model_snapshots/<snapshot_id>/_revert]: Revert a model snapshot
92+
* {ref}/ml-update-snapshot.html[POST /model_snapshots/<snapshot_id>/_update]: Update certain settings for a model snapshot
93+
* {ref}/ml-delete-snapshot.html[DELETE /model_snapshots/<snapshot_id+++>+++]: Delete a model snapshot
94+
95+
////
96+
[float]
97+
[[ml-api-validate]]
98+
=== /validate/
99+
100+
* {ref}/ml-valid-detector.html[POST /anomaly_detectors/_validate/detector]: Validate a detector
101+
* {ref}/ml-valid-job.html[POST /anomaly_detectors/_validate]: Validate a job
102+
////

‎docs/en/stack/ml/index.asciidoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ include::overview.asciidoc[]
2424
:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/ml/getting-started.asciidoc
2525
include::getting-started.asciidoc[]
2626

27-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/configuring.asciidoc
28-
include::{xes-repo-dir}/ml/configuring.asciidoc[]
27+
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/configuring.asciidoc
28+
include::{es-repo-dir}/ml/configuring.asciidoc[]
2929

30-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/stopping-ml.asciidoc
31-
include::{xes-repo-dir}/ml/stopping-ml.asciidoc[]
30+
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/stopping-ml.asciidoc
31+
include::{es-repo-dir}/ml/stopping-ml.asciidoc[]
3232

33-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/api-quickref.asciidoc
34-
include::{xes-repo-dir}/ml/api-quickref.asciidoc[]
33+
:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/ml/api-quickref.asciidoc
34+
include::api-quickref.asciidoc[]
3535

36-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/ml/functions.asciidoc
37-
include::{xes-repo-dir}/ml/functions.asciidoc[]
36+
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/functions.asciidoc
37+
include::{es-repo-dir}/ml/functions.asciidoc[]

0 commit comments

Comments
 (0)