O GroupByField agrupa resultados de consultas por valor de campo. Use este método de agregação para organizar os resultados com base nos valores dos campos. Valores idênticos são reunidos no mesmo grupo. O retorno inclui o valor correspondente a cada grupo e a quantidade de ocorrências desse valor.
Parâmetros da solicitação
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;
}|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
field_name |
string |
Sim |
Campo usado para agregação. |
|
size |
int32 |
Sim |
Número de grupos a retornar. Valor padrão: 10. Valor máximo: 2000. Se o número de grupos ultrapassar 2.000, apenas os primeiros 2.000 serão retornados. |
|
sort |
Não |
Regras de ordenação dos itens em um grupo. Por padrão, os itens do grupo são classificados em ordem decrescente. Se você configure várias regras de ordenação, os dados serão classificados conforme a ordem de configuração das regras. |
|
|
sub_aggs |
Não |
Operação de subagregação executada nos resultados do agrupamento. |
|
|
sub_group_bys |
Não |
Operação de sub-GroupBy executada nos resultados do agrupamento. |
|
|
min_doc_count |
int64 |
Não |
Número mínimo de linhas. Se o número de linhas em um grupo for menor que o mínimo definido, os resultados de agregação desse grupo não serão retornados. |
Parâmetros de resposta
message GroupByFieldResult {
repeated GroupByFieldResultItem group_by_field_result_items = 1;
}|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
group_by_field_result_items |
repeated GroupByFieldResultItem |
Sim |
Informações sobre os grupos retornados. |