Skip to content

Commit 0fa1060

Browse files
authored
[DOCS] Collapses content in machine learning APIs (#54234) (#54453)
1 parent 56047f7 commit 0fa1060

15 files changed

+643
-349
lines changed

docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ configuration details and cardinality estimates for the fields it references.
2626

2727
`analysis_config`::
2828
(Required, object) For a list of the properties that you can specify in the
29-
`analysis_config` component of the body of this API, see <<put-analysisconfig>>.
29+
`analysis_config` component of the body of this API, see <<put-analysisconfig,`analysis_config`>>.
3030

3131
`max_bucket_cardinality`::
3232
(Optional, object) Estimates of the highest cardinality in a single bucket

docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ default, the buckets are sorted by the `timestamp` field.
7777
`start`::
7878
(Optional, string) Returns buckets with timestamps after this time.
7979

80+
[role="child_attributes"]
8081
[[ml-get-bucket-results]]
8182
==== {api-response-body-title}
8283

@@ -89,49 +90,52 @@ records in the bucket contribute to this score. This value might be updated as
8990
new data is analyzed.
9091

9192
`bucket_influencers`::
92-
(array) An array of bucket influencer objects, which have the following
93-
properties:
94-
95-
`bucket_influencers`.`anomaly_score`:::
93+
(array) An array of bucket influencer objects.
94+
+
95+
.Properties of `bucket_influencers`
96+
[%collapsible%open]
97+
====
98+
`anomaly_score`:::
9699
(number) A normalized score between 0-100, which is calculated for each bucket
97100
influencer. This score might be updated as newer data is analyzed.
98101
99-
`bucket_influencers`.`bucket_span`:::
102+
`bucket_span`:::
100103
(number)
101104
include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-span-results]
102105
103-
`bucket_influencers`.`initial_anomaly_score`:::
106+
`initial_anomaly_score`:::
104107
(number) The score between 0-100 for each bucket influencer. This score is the
105108
initial value that was calculated at the time the bucket was processed.
106109
107-
`bucket_influencers`.`influencer_field_name`:::
110+
`influencer_field_name`:::
108111
(string) The field name of the influencer.
109112
110-
`bucket_influencers`.`influencer_field_value`:::
113+
`influencer_field_value`:::
111114
(string) The field value of the influencer.
112115
113-
`bucket_influencers`.`is_interim`:::
116+
`is_interim`:::
114117
(boolean)
115118
include::{docdir}/ml/ml-shared.asciidoc[tag=is-interim]
116119
117-
`bucket_influencers`.`job_id`:::
120+
`job_id`:::
118121
(string)
119122
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
120123
121-
`bucket_influencers`.`probability`:::
124+
`probability`:::
122125
(number) The probability that the bucket has this behavior, in the range 0 to 1.
123126
This value can be held to a high precision of over 300 decimal places, so the
124127
`anomaly_score` is provided as a human-readable and friendly interpretation of
125128
this.
126129
127-
`bucket_influencers`.`raw_anomaly_score`:::
130+
`raw_anomaly_score`:::
128131
(number) Internal.
129132
130-
`bucket_influencers`.`result_type`:::
133+
`result_type`:::
131134
(string) Internal. This value is always set to `bucket_influencer`.
132135
133-
`bucket_influencers`.`timestamp`:::
136+
`timestamp`:::
134137
(date) The start time of the bucket for which these results were calculated.
138+
====
135139

136140
`bucket_span`::
137141
(number)

docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ all {dfeeds}.
6060
(Optional, boolean)
6161
include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
6262

63+
[role="child_attributes"]
6364
[[ml-get-datafeed-stats-results]]
6465
==== {api-response-body-title}
6566

@@ -77,18 +78,23 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
7778
`node`::
7879
(object)
7980
include::{docdir}/ml/ml-shared.asciidoc[tag=node-datafeeds]
80-
81-
`node`.`id`:::
81+
+
82+
--
83+
[%collapsible%open]
84+
====
85+
`id`:::
8286
include::{docdir}/ml/ml-shared.asciidoc[tag=node-id]
8387
84-
`node`.`name`::: The node name. For example, `0-o0tOo`.
88+
`name`::: The node name. For example, `0-o0tOo`.
8589
86-
`node`.`ephemeral_id`:::
90+
`ephemeral_id`:::
8791
include::{docdir}/ml/ml-shared.asciidoc[tag=node-ephemeral-id]
8892
89-
`node`.`transport_address`::: The host and port where transport HTTP connections are
93+
`transport_address`::: The host and port where transport HTTP connections are
9094
accepted. For example, `127.0.0.1:9300`.
91-
`node`.`attributes`::: For example, `{"ml.machine_memory": "17179869184"}`.
95+
`attributes`::: For example, `{"ml.machine_memory": "17179869184"}`.
96+
====
97+
--
9298

9399
`state`::
94100
(string)
@@ -97,27 +103,32 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=state-datafeed]
97103
`timing_stats`::
98104
(object) An object that provides statistical information about timing aspect of
99105
this {dfeed}.
100-
101-
`timing_stats`.`average_search_time_per_bucket_ms`:::
106+
+
107+
--
108+
[%collapsible%open]
109+
====
110+
`average_search_time_per_bucket_ms`:::
102111
(double)
103112
include::{docdir}/ml/ml-shared.asciidoc[tag=search-bucket-avg]
104113
105-
`timing_stats`.`bucket_count`:::
114+
`bucket_count`:::
106115
(long)
107116
include::{docdir}/ml/ml-shared.asciidoc[tag=bucket-count]
108117
109-
`timing_stats`.`exponential_average_search_time_per_hour_ms`:::
118+
`exponential_average_search_time_per_hour_ms`:::
110119
(double)
111120
include::{docdir}/ml/ml-shared.asciidoc[tag=search-exp-avg-hour]
112121
113-
`timing_stats`.`job_id`:::
122+
`job_id`:::
114123
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
115124
116-
`timing_stats`.`search_count`:::
125+
`search_count`:::
117126
include::{docdir}/ml/ml-shared.asciidoc[tag=search-count]
118127
119-
`timing_stats`.`total_search_time_ms`:::
128+
`total_search_time_ms`:::
120129
include::{docdir}/ml/ml-shared.asciidoc[tag=search-time]
130+
====
131+
--
121132

122133

123134
[[ml-get-datafeed-stats-response-codes]]

0 commit comments

Comments
 (0)