Skip to content

Commit 2d23399

Browse files
authored
[ML] [Data Frame] Adding supported aggs in docs (#42728)
* [ML] [Data Frame] Adding supported aggs in docs * [DOCS] Moves pivot to definitions list
1 parent 026f0f7 commit 2d23399

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[role="xpack"]
2+
[testenv="basic"]
3+
[[data-frame-transform-pivot]]
4+
=== Pivot resources
5+
6+
A pivot configuration object has the following properties:
7+
8+
`group_by` (required):: (object) Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are supported:
9+
* {ref}/search-aggregations-bucket-composite-aggregation.html#_terms[Terms]
10+
* {ref}/search-aggregations-bucket-composite-aggregation.html#_histogram[Histogram]
11+
* {ref}/search-aggregations-bucket-composite-aggregation.html#_date_histogram[Date Histogram]
12+
13+
`aggregations` (required):: (object) Defines how to aggregate the grouped data.
14+
The following aggregations are supported:
15+
* {ref}/search-aggregations-metrics-avg-aggregation.html[Average]
16+
* {ref}/search-aggregations-metrics-weight-avg-aggregation.html[Weighted Average]
17+
* {ref}/search-aggregations-metrics-cardinality-aggregation.html[Cardinality]
18+
* {ref}/search-aggregations-metrics-geocentroid-aggregation.html[Geo Centroid]
19+
* {ref}/search-aggregations-metrics-max-aggregation.html[Max]
20+
* {ref}/search-aggregations-metrics-min-aggregation.html[Min]
21+
* {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Scripted Metric]
22+
* {ref}/search-aggregations-metrics-sum-aggregation.html[Sum]
23+
* {ref}/search-aggregations-metrics-valuecount-aggregation.html[Value Count]
24+
* {ref}/search-aggregations-metrics-bucket_script-aggregation.html[Bucket Script]
25+
26+
//For more information, see {stack-ov}/ml-dataframes.html[dataframes-cap}].

docs/reference/data-frames/apis/put-transform.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ a `query`.
3939
`dest` (required):: (object) The destination configuration, consisting of `index`.
4040

4141
`pivot`:: (object) Defines the pivot function `group by` fields and the aggregation to
42-
reduce the data.
42+
reduce the data. See <<data-frame-transform-pivot, data frame transform pivot objects>>.
4343

4444
`description`:: Optional free text description of the data frame transform
4545

docs/reference/rest-api/defs.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ These resource definitions are used in APIs related to {ml-features} and
1212
* <<ml-job-resource,Jobs>>
1313
* <<ml-jobstats,Job statistics>>
1414
* <<ml-snapshot-resource,Model snapshots>>
15+
* <<data-frame-transform-pivot,Pivots>>
1516
* <<ml-results-resource,Results>>
1617
* <<role-mapping-resources,Role mappings>>
1718
* <<ml-event-resource,Scheduled Events>>
@@ -22,6 +23,7 @@ include::{es-repo-dir}/ml/apis/filterresource.asciidoc[]
2223
include::{es-repo-dir}/ml/apis/jobresource.asciidoc[]
2324
include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[]
2425
include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[]
26+
include::{es-repo-dir}/data-frames/apis/pivotresource.asciidoc[]
2527
include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[]
2628
include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[]
2729
include::{es-repo-dir}/ml/apis/eventresource.asciidoc[]

0 commit comments

Comments
 (0)