SearchAggregation

公测版

SearchAggregation 实例为向量搜索定义一层桶聚合。它控制桶键、桶数量上限、每个桶的指标、桶排序、代表性命中以及可选的嵌套聚合。

python
class pymilvus.SearchAggregation

构造函数

python
SearchAggregation(
    fields: list[str],
    size: int,
    metrics: dict[str, dict[str, str]] | None = None,
    order: list[dict[str, str]] | None = None,
    top_hits: TopHits | None = None,
    sub_aggregation: SearchAggregation | None = None,
)

参数：

fields (list[str]) [必需] -

由标量字段名称组成的非空列表，用于构成桶键。多个字段会按列表顺序组成复合键。不接受诸如 meta["region"] 之类的 JSON 路径。
size (int) [必需] -

此聚合层级返回的最大桶数量。该值必须为正整数。
metrics (dict[str, dict[str, str]] | None) -

每个桶的指标定义。每个键都是指标别名，每个值都是形如 {operation: field} 的单键字典。支持的操作包括 count、sum、avg、min 和 max。只有 count 接受 "*"；其他操作需要字段名或 _score。
order (list[dict[str, str]] | None) -

按列表顺序求值的桶排序规则。每一项都必须包含一个指标别名、_count 或 _key，并映射为 "asc" 或 "desc"。
top_hits (TopHits | None) -

配置从每个桶返回的代表性 Entity。
sub_aggregation (SearchAggregation | None) -

在当前层级的每个桶下定义一个嵌套桶层级。

返回类型：

SearchAggregation

异常：

ParamError - 在字段为空或无效、size 非正、指标定义不受支持、排序键或方向无效，或对象类型错误时引发。

示例

python
from pymilvus import SearchAggregation, TopHits

aggregation = SearchAggregation(
    fields=["category"],
    size=5,
    metrics={
        "product_count": {"count": "*"},
        "avg_price": {"avg": "price"},
    },
    order=[{"product_count": "desc"}, {"_key": "asc"}],
    sub_aggregation=SearchAggregation(
        fields=["brand"],
        size=3,
        top_hits=TopHits(
            size=2,
            sort=[{"rating": "desc"}, {"_score": "desc"}],
        ),
    ),
)

构造函数​

示例​

构造函数

示例