L'agrégation GroupByField regroupe les résultats de requête par valeur de champ. Utilisez cette méthode pour rassembler les résultats partageant la même valeur de champ. Le système renvoie la valeur commune de chaque groupe ainsi que le nombre d'occurrences correspondantes.
Paramètres de requête
message GroupByField {
optional string field_name = 1;
optional int32 size = 2;
optional GroupBySort sort = 3;
optional Aggregations sub_aggs = 4;
optional GroupBys sub_group_bys = 5;
optional int64 min_doc_count = 6;
}|
Parameter |
Type |
Required |
Description |
|
field_name |
string |
Yes |
Champ utilisé pour l'agrégation. |
|
size |
int32 |
Yes |
Nombre de groupes à renvoyer. Valeur par défaut : 10. Valeur maximale : 2 000. Si le nombre de groupes dépasse 2 000, seuls les 2 000 premiers sont renvoyés. |
|
sort |
No |
Règles de tri des éléments du groupe. Par défaut, le tri s'effectue par ordre décroissant. En cas de règles multiples, le système les applique selon leur ordre de configuration. |
|
|
sub_aggs |
No |
Sous-agrégation appliquée aux résultats du regroupement. |
|
|
sub_group_bys |
No |
Sous-opération GroupBy appliquée aux résultats du regroupement. |
|
|
min_doc_count |
int64 |
No |
Nombre minimal de lignes requis. Si un groupe contient moins de lignes que ce seuil, ses résultats d'agrégation ne sont pas renvoyés. |
Paramètres de réponse
message GroupByFieldResult {
repeated GroupByFieldResultItem group_by_field_result_items = 1;
}|
Parameter |
Type |
Required |
Description |
|
group_by_field_result_items |
repeated GroupByFieldResultItem |
Yes |
Informations sur les groupes renvoyés. |