From 0e133ada9e2492152a45c5bc393bc9f1e172c4fc Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 19 Jun 2017 19:31:39 -0700 Subject: [PATCH] [DOCS]Fix links to ML APIs (elastic/x-pack-elasticsearch#1779) Original commit: elastic/x-pack-elasticsearch@81be1e49b695720dff6675ae8ac4f3f6e23f9595 --- docs/en/ml/api-quickref.asciidoc | 75 ++++++++++++---------------- docs/en/ml/configuring.asciidoc | 4 +- docs/en/ml/functions.asciidoc | 3 +- docs/en/ml/functions/count.asciidoc | 6 +-- docs/en/ml/functions/geo.asciidoc | 5 +- docs/en/ml/functions/info.asciidoc | 4 +- docs/en/ml/functions/metric.asciidoc | 24 ++++----- docs/en/ml/functions/rare.asciidoc | 8 +-- docs/en/ml/functions/sum.asciidoc | 8 +-- docs/en/ml/functions/time.asciidoc | 8 +-- docs/en/ml/getting-started.asciidoc | 4 +- docs/en/ml/limitations.asciidoc | 10 ++-- docs/en/ml/overview.asciidoc | 8 +-- docs/en/rest-api/xindex.asciidoc | 6 +-- 14 files changed, 82 insertions(+), 91 deletions(-) diff --git a/docs/en/ml/api-quickref.asciidoc b/docs/en/ml/api-quickref.asciidoc index b311dda4b2b..6805a5cf733 100644 --- a/docs/en/ml/api-quickref.asciidoc +++ b/docs/en/ml/api-quickref.asciidoc @@ -20,66 +20,55 @@ The main {ml} resources can be accessed with a variety of endpoints: [[ml-api-jobs]] === /anomaly_detectors/ -* <+++>>: Create a job -* </_open>>: Open a job -* </_data>>: Send data to a job -* <>: List jobs -* <+++>>: Get job details -* </_stats>>: Get job statistics -* </_update>>: Update certain properties of the job configuration -* </_flush>>: Force a job to analyze buffered data -* </_close>>: Close a job -* <+++>>: Delete a job +* {ref}/ml-put-job.html[PUT /anomaly_detectors/+++]: Create a job +* {ref}/ml-open-job.html[POST /anomaly_detectors//_open]: Open a job +* {ref}/ml-post-data.html[POST /anomaly_detectors//_data]: Send data to a job +* {ref}/ml-get-job.html[GET /anomaly_detectors]: List jobs +* {ref}/ml-get-job.html[GET /anomaly_detectors/+++]: Get job details +* {ref}/ml-get-job-stats.html[GET /anomaly_detectors//_stats]: Get job statistics +* {ref}/ml-update-job.html[POST /anomaly_detectors//_update]: Update certain properties of the job configuration +* {ref}/ml-flush-job.html[POST anomaly_detectors//_flush]: Force a job to analyze buffered data +* {ref}/ml-close-job.html[POST /anomaly_detectors//_close]: Close a job +* {ref}/ml-delete-job.html[DELETE /anomaly_detectors/+++]: Delete a job [float] [[ml-api-datafeeds]] === /datafeeds/ -* <+++>>: Create a {dfeed} -* </_start>>: Start a {dfeed} -* <>: List {dfeeds} -* <+++>>: Get {dfeed} details -* </_stats>>: Get statistical information for {dfeeds} -* </_preview>>: Get a preview of a {dfeed} -* </_update>>: Update certain settings for a {dfeed} -* </_stop>>: Stop a {dfeed} -* <+++>>: Delete {dfeed} +* {ref}/ml-put-datafeed.html[PUT /datafeeds/+++]: Create a {dfeed} +* {ref}/ml-start-datafeed.html[POST /datafeeds//_start]: Start a {dfeed} +* {ref}/ml-get-datafeed.html[GET /datafeeds]: List {dfeeds} +* {ref}/ml-get-datafeed.html[GET /datafeeds/+++]: Get {dfeed} details +* {ref}/ml-get-datafeed-stats.html[GET /datafeeds//_stats]: Get statistical information for {dfeeds} +* {ref}/ml-preview-datafeed.html[GET /datafeeds//_preview]: Get a preview of a {dfeed} +* {ref}/ml-update-datafeed.html[POST /datafeeds//_update]: Update certain settings for a {dfeed} +* {ref}/ml-stop-datafeed.html[POST /datafeeds//_stop]: Stop a {dfeed} +* {ref}/ml-delete-datafeed.html[DELETE /datafeeds/+++]: Delete {dfeed} [float] [[ml-api-results]] === /results/ -* <>: List the buckets in the results -* <+++>>: Get bucket details -* <>: List the categories in the results -* <+++>>: Get category details -* <>: Get influencer details -* <>: Get records from the results +* {ref}/ml-get-bucket.html[GET /results/buckets]: List the buckets in the results +* {ref}/ml-get-bucket.html[GET /results/buckets/+++]: Get bucket details +* {ref}/ml-get-category.html[GET /results/categories]: List the categories in the results +* {ref}/ml-get-category.html[GET /results/categories/+++]: Get category details +* {ref}/ml-get-influencer.html[GET /results/influencers]: Get influencer details +* {ref}/ml-get-record.html[GET /results/records]: Get records from the results [float] [[ml-api-snapshots]] === /model_snapshots/ -* <>: List model snapshots -* <+++>>: Get model snapshot details -* </_revert>>: Revert a model snapshot -* </_update>>: Update certain settings for a model snapshot -* <+++>>: Delete a model snapshot +* {ref}/ml-get-snapshot.html[GET /model_snapshots]: List model snapshots +* {ref}/ml-get-snapshot.html[GET /model_snapshots/+++]: Get model snapshot details +* {ref}/ml-revert-snapshot.html[POST /model_snapshots//_revert]: Revert a model snapshot +* {ref}/ml-update-snapshot.html[POST /model_snapshots//_update]: Update certain settings for a model snapshot +* {ref}/ml-delete-snapshot.html[DELETE /model_snapshots/+++]: Delete a model snapshot [float] [[ml-api-validate]] === /validate/ -* <>: Validate a detector -* <>: Validate a job -//[float] -//== Where to Go Next - -//<> :: Enable machine learning and start -//discovering anomalies in your data. - -//[float] -//== Have Comments, Questions, or Feedback? - -//Head over to our {forum}[Graph Discussion Forum] to share your experience, questions, and -//suggestions. +* {ref}/ml-valid-detector.html[POST /anomaly_detectors/_validate/detector]: Validate a detector +* {ref}/ml-valid-job.html[POST /anomaly_detectors/_validate]: Validate a job diff --git a/docs/en/ml/configuring.asciidoc b/docs/en/ml/configuring.asciidoc index 87fe209d559..9004f2cab63 100644 --- a/docs/en/ml/configuring.asciidoc +++ b/docs/en/ml/configuring.asciidoc @@ -14,8 +14,8 @@ send your data to that job. ** You can create a {dfeed}, which retrieves data from {es} for analysis. ** You can use {kib} to expedite the creation of jobs and {dfeeds}. -* If your data is not stored in {es}, you can <> from any -source directly to an API. +* If your data is not stored in {es}, you can +{ref}/ml-post-data.html[POST data] from any source directly to an API. The results of {ml} analysis are stored in {es} and you can use {kib} to help you visualize and explore the results. diff --git a/docs/en/ml/functions.asciidoc b/docs/en/ml/functions.asciidoc index 20b69c8aee6..a59b2892667 100644 --- a/docs/en/ml/functions.asciidoc +++ b/docs/en/ml/functions.asciidoc @@ -6,7 +6,8 @@ flexible ways to analyze data for anomalies. When you create jobs, you specify one or more detectors, which define the type of analysis that needs to be done. If you are creating your job by using {ml} APIs, -you specify the functions in <>. +you specify the functions in +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. If you are creating your job in {kib}, you specify the functions differently depending on whether you are creating single metric, multi-metric, or advanced jobs. For a demonstration of creating jobs in {kib}, see <>. diff --git a/docs/en/ml/functions/count.asciidoc b/docs/en/ml/functions/count.asciidoc index 9450e80abd4..7248021dce5 100644 --- a/docs/en/ml/functions/count.asciidoc +++ b/docs/en/ml/functions/count.asciidoc @@ -39,7 +39,7 @@ These functions support the following properties: * `partition_field_name` (optional) For more information about those properties, -see <>. +see {ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing events with the count function [source,js] @@ -123,7 +123,7 @@ These functions support the following properties: * `partition_field_name` (optional) For more information about those properties, -see <>. +see {ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. For example, if you have the following number of events per bucket: @@ -182,7 +182,7 @@ These functions support the following properties: * `partition_field_name` (optional) For more information about those properties, -see <>. +see {ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 6: Analyzing users with the distinct_count function [source,js] diff --git a/docs/en/ml/functions/geo.asciidoc b/docs/en/ml/functions/geo.asciidoc index 847aa92946e..19161db5547 100644 --- a/docs/en/ml/functions/geo.asciidoc +++ b/docs/en/ml/functions/geo.asciidoc @@ -21,7 +21,7 @@ This function supports the following properties: * `partition_field_name` (optional) For more information about those properties, -see <>. +see {ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing transactions with the lat_long function [source,js] @@ -74,4 +74,5 @@ format. For example, the following Painless script transforms } -------------------------------------------------- -For more information about `script_fields`, see <>. +For more information about `script_fields`, see +{ref}/ml-datafeed-resource.html[Datafeed Resources]. diff --git a/docs/en/ml/functions/info.asciidoc b/docs/en/ml/functions/info.asciidoc index 07b5f9f9fed..f964d4eb3ec 100644 --- a/docs/en/ml/functions/info.asciidoc +++ b/docs/en/ml/functions/info.asciidoc @@ -28,8 +28,8 @@ These functions support the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing subdomain strings with the info_content function [source,js] diff --git a/docs/en/ml/functions/metric.asciidoc b/docs/en/ml/functions/metric.asciidoc index 203d6b44e88..495fc6f3335 100644 --- a/docs/en/ml/functions/metric.asciidoc +++ b/docs/en/ml/functions/metric.asciidoc @@ -30,8 +30,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing minimum transactions with the min function [source,js] @@ -64,8 +64,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 2: Analyzing maximum response times with the max function [source,js] @@ -124,8 +124,8 @@ These functions support the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 4: Analyzing response times with the median function [source,js] @@ -161,8 +161,8 @@ These functions support the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 5: Analyzing response times with the mean function [source,js] @@ -225,8 +225,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 8: Analyzing response times with the metric function [source,js] @@ -261,8 +261,8 @@ These functions support the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 9: Analyzing response times with the varp function [source,js] diff --git a/docs/en/ml/functions/rare.asciidoc b/docs/en/ml/functions/rare.asciidoc index 86cbf33ca45..97081b21cba 100644 --- a/docs/en/ml/functions/rare.asciidoc +++ b/docs/en/ml/functions/rare.asciidoc @@ -41,8 +41,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing status codes with the rare function [source,js] @@ -97,8 +97,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 3: Analyzing URI values in a population with the freq_rare function [source,js] diff --git a/docs/en/ml/functions/sum.asciidoc b/docs/en/ml/functions/sum.asciidoc index 9c3e01c701b..3a0f0b264e9 100644 --- a/docs/en/ml/functions/sum.asciidoc +++ b/docs/en/ml/functions/sum.asciidoc @@ -41,8 +41,8 @@ These functions support the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing total expenses with the sum function [source,js] @@ -95,8 +95,8 @@ These functions support the following properties: * `by_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. NOTE: Population analysis (that is to say, use of the `over_field_name` property) is not applicable for this function. diff --git a/docs/en/ml/functions/time.asciidoc b/docs/en/ml/functions/time.asciidoc index e17301eb6f5..9dc74aaa8ee 100644 --- a/docs/en/ml/functions/time.asciidoc +++ b/docs/en/ml/functions/time.asciidoc @@ -48,8 +48,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 1: Analyzing events with the time_of_day function [source,js] @@ -78,8 +78,8 @@ This function supports the following properties: * `over_field_name` (optional) * `partition_field_name` (optional) -For more information about those properties, -see <>. +For more information about those properties, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. .Example 2: Analyzing events with the time_of_week function [source,js] diff --git a/docs/en/ml/getting-started.asciidoc b/docs/en/ml/getting-started.asciidoc index d340e477d63..f81655b3411 100644 --- a/docs/en/ml/getting-started.asciidoc +++ b/docs/en/ml/getting-started.asciidoc @@ -315,7 +315,7 @@ analytical task. -- This tutorial uses {kib} to create jobs and view results, but you can alternatively use APIs to accomplish most tasks. -For API reference information, see <>. +For API reference information, see {ref}/ml-apis.html[Machine Learning APIs]. The {xpackml} features in {kib} use pop-ups. You must configure your web browser so that it does not block pop-up windows or create an @@ -463,7 +463,7 @@ job is running. TIP: The `create_single_metic.sh` script creates a similar job and {dfeed} by using the {ml} APIs. You can download that script by clicking here: https://download.elastic.co/demos/machine_learning/gettingstarted/create_single_metric.sh[create_single_metric.sh] -For API reference information, see <>. +For API reference information, see {ref}/ml-apis.html[Machine Learning APIs]. [[ml-gs-job1-manage]] === Managing Jobs diff --git a/docs/en/ml/limitations.asciidoc b/docs/en/ml/limitations.asciidoc index 63b708cd083..5a36652cb90 100644 --- a/docs/en/ml/limitations.asciidoc +++ b/docs/en/ml/limitations.asciidoc @@ -66,7 +66,8 @@ of closing and re-opening large jobs when there are pauses in the {dfeed}. The post data API enables you to send data to a job for analysis. The data that you send to the job must use the JSON format. -For more information about this API, see <>. +For more information about this API, see +{ref}/ml-post-data.html[Post Data to Jobs]. [float] @@ -83,7 +84,7 @@ Missing fields might be expected due to the structure of the data and therefore do not generate poor results. For more information about `missing_field_count`, -see <>. +see {ref}/ml-datacounts.html[Data Counts Objects]. [float] @@ -116,7 +117,8 @@ this additional model information for every bucket might be problematic. If you are not certain that you need this option or if you experience performance issues, edit your job configuration to disable this option. -For more information, see <>. +For more information, see +{ref}/ml-apimodelplotconfig.html[Model Plot Config]. Likewise, when you create a single or multi-metric job in {kib}, in some cases it uses aggregations on the data that it retrieves from {es}. One of the @@ -131,4 +133,4 @@ in performance that is gained by pre-aggregating the data makes the potentially poorer precision worthwhile. If you want to view or change the aggregations that are used in your job, refer to the `aggregations` property in your {dfeed}. -For more information, see <>. +For more information, see {ref}/ml-datafeed-resource.html[Datafeed Resources]. diff --git a/docs/en/ml/overview.asciidoc b/docs/en/ml/overview.asciidoc index 3a098ee6abc..625c65e58bf 100644 --- a/docs/en/ml/overview.asciidoc +++ b/docs/en/ml/overview.asciidoc @@ -10,7 +10,7 @@ concepts from the outset will tremendously help ease the learning process. Machine learning jobs contain the configuration information and metadata necessary to perform an analytics task. For a list of the properties associated -with a job, see <>. +with a job, see {ref}ml-job-resource.html[Job Resources]. [float] [[ml-dfeeds]] @@ -18,7 +18,7 @@ with a job, see <>. Jobs can analyze either a one-off batch of data or continuously in real time. {dfeeds-cap} retrieve data from {es} for analysis. Alternatively you can -<> from any source directly to an API. +{ref}/ml-post-data.html[POST data] from any source directly to an API. [float] [[ml-detectors]] @@ -28,8 +28,8 @@ As part of the configuration information that is associated with a job, detectors define the type of analysis that needs to be done. They also specify which fields to analyze. You can have more than one detector in a job, which is more efficient than running multiple jobs against the same data. For a list -of the properties associated with detectors, -see <>. +of the properties associated with detectors, see +{ref}/ml-job-resource.html#ml-detectorconfig[Detector Configuration Objects]. [float] [[ml-buckets]] diff --git a/docs/en/rest-api/xindex.asciidoc b/docs/en/rest-api/xindex.asciidoc index 3ac7e3837b0..2bd1fa621b6 100644 --- a/docs/en/rest-api/xindex.asciidoc +++ b/docs/en/rest-api/xindex.asciidoc @@ -9,8 +9,8 @@ * <> * <> * <> -* Machine Learning APIs -* <> +* {ref}/ml-apis.html[Machine Learning APIs] +* {ref}/ml-api-definitions.html[Definitions] -- [[info-api]] @@ -118,5 +118,3 @@ include::security.asciidoc[] include::watcher.asciidoc[] include::graph.asciidoc[] -//include::ml-api.asciidoc[] -//include::defs.asciidoc[]