CrowdingSpec

Especificação para o efeito de aglomeração. A aglomeração melhora a diversidade dos resultados da pesquisa limitando o número de resultados que partilham o mesmo valor de campo. Por exemplo, o preenchimento excessivo no campo de cor com um maxCount de 3 e o modo DROP_CROWDED_RESULTS devolvem, no máximo, 3 resultados com a mesma cor em todas as páginas.

Representação JSON
{
  "field": string,
  "maxCount": integer,
  "mode": enum (Mode)
}
Campos
field

string

O campo a usar para a multidão. Os documentos podem ser preenchidos por um campo no objeto Document. O campo de aglomeração é sensível a maiúsculas e minúsculas.

maxCount

integer

O número máximo de documentos a manter por valor do campo. Quando existem, pelo menos, maxCount resultados anteriores que contêm o mesmo valor para o campo especificado (de acordo com a ordem especificada em orderBy), os resultados posteriores com o mesmo valor são "afastados". Se não for especificado, o valor predefinido é 1.

mode

enum (Mode)

Modo a usar para documentos que estão afastados.

Modo

Enum que descreve o modo a usar para documentos que estão demasiado próximos. Podem ser removidos ou rebaixados para as páginas posteriores.

Enumerações
MODE_UNSPECIFIED Modo de multidão não especificado. Neste caso, o comportamento do servidor é predefinido para Mode.DROP_CROWDED_RESULTS.
DROP_CROWDED_RESULTS Elimine resultados aglomerados.
DEMOTE_CROWDED_RESULTS_TO_END Diminuir a classificação dos resultados com muita informação para as páginas posteriores.