honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-27 10:28:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ML] [Data Frame] Adding supported aggs in docs (#42728) (#42842)

Browse Source 
* [ML] [Data Frame] Adding supported aggs in docs

* [DOCS] Moves pivot to definitions list
This commit is contained in:
Benjamin Trent 2019-06-04 07:19:58 -05:00 committed by GitHub
parent 440ec4d9f5
commit 32eae0dfe9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/reference/data-frames/apis/pivotresource.asciidoc Normal file
View File

@ -0,0 +1,26 @@
[role="xpack"]
[testenv="basic"]
[[data-frame-transform-pivot]]
=== Pivot resources
A pivot configuration object has the following properties:
`group_by` (required):: (object) Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are supported:
* {ref}/search-aggregations-bucket-composite-aggregation.html#_terms[Terms]
* {ref}/search-aggregations-bucket-composite-aggregation.html#_histogram[Histogram]
* {ref}/search-aggregations-bucket-composite-aggregation.html#_date_histogram[Date Histogram]
`aggregations` (required):: (object) Defines how to aggregate the grouped data.
The following aggregations are supported:
* {ref}/search-aggregations-metrics-avg-aggregation.html[Average]
* {ref}/search-aggregations-metrics-weight-avg-aggregation.html[Weighted Average]
* {ref}/search-aggregations-metrics-cardinality-aggregation.html[Cardinality]
* {ref}/search-aggregations-metrics-geocentroid-aggregation.html[Geo Centroid]
* {ref}/search-aggregations-metrics-max-aggregation.html[Max]
* {ref}/search-aggregations-metrics-min-aggregation.html[Min]
* {ref}/search-aggregations-metrics-scripted-metric-aggregation.html[Scripted Metric]
* {ref}/search-aggregations-metrics-sum-aggregation.html[Sum]
* {ref}/search-aggregations-metrics-valuecount-aggregation.html[Value Count]
* {ref}/search-aggregations-metrics-bucket_script-aggregation.html[Bucket Script]
//For more information, see {stack-ov}/ml-dataframes.html[dataframes-cap}].

2
docs/reference/data-frames/apis/put-transform.asciidoc
View File

@ -39,7 +39,7 @@ a `query`.
`dest` (required):: (object) The destination configuration, consisting of `index`.
`pivot`:: (object) Defines the pivot function `group by` fields and the aggregation to
reduce the data.
reduce the data. See <<data-frame-transform-pivot, data frame transform pivot objects>>.
`description`:: Optional free text description of the data frame transform

2
docs/reference/rest-api/defs.asciidoc
View File

@ -12,6 +12,7 @@ These resource definitions are used in APIs related to {ml-features} and
* <<ml-job-resource,Jobs>>
* <<ml-jobstats,Job statistics>>
* <<ml-snapshot-resource,Model snapshots>>
* <<data-frame-transform-pivot,Pivots>>
* <<ml-results-resource,Results>>
* <<role-mapping-resources,Role mappings>>
* <<ml-event-resource,Scheduled Events>>
@ -22,6 +23,7 @@ include::{es-repo-dir}/ml/apis/filterresource.asciidoc[]
include::{es-repo-dir}/ml/apis/jobresource.asciidoc[]
include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[]
include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[]
include::{es-repo-dir}/data-frames/apis/pivotresource.asciidoc[]
include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[]
include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[]
include::{es-repo-dir}/ml/apis/eventresource.asciidoc[]