跳到主要内容

搜索 (V2)

This operation conducts a vector similarity search with an optional scalar filtering expression.

POST/v2/vectordb/entities/search
连接端点

该 API 的 Base URL 格式如下:

https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530

📘说明
  • 如果您使用的是服务集群,请使用集群端点。
    • Free 与 Serverless 版

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated 版

      https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530

  • 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}
  • 您可以使用 查看集群详情 V2 来获取集群的 Endpoint.
shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zilliz.com.cn:19530"
参数
Authorizationstringheader必填项

认证令牌,应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码,如 username:password

示例值:Bearer {{TOKEN}}
请求体
dbNamestring

数据库名称。

collectionNamestring必填项

当前操作的目标 Collection 名称。

dataarray必填项

一个向量嵌入列表。
Zilliz Cloud 会搜索与指定向量嵌入最相似的向量。
该参数与 ids 互斥。

[]dataarray

一个向量嵌入。

idsarray

一个主键列表。
Zilliz Cloud 会搜索与指定 Entity 中的向量嵌入最相似的向量。
该参数与 data 互斥。

annsFieldstring

向量字段名称。

filterstring

在检索结果中根据标量字段进行过滤的表达式。

groupingFieldstring

对搜索结果进行分组,以确保结果的多样性,并避免返回来自同一组的多个结果。

groupSizeinteger

每个组返回的 Entity 数量。该参数仅在 groupingField 被指定时有效。

strictGroupSizeboolean

是否仅返回每个组的前 k 个 Entity。该参数仅在 groupingField 被指定时有效。

limitinteger

需要在搜索结果中返回的 Entity 数量。 您可以使用此参数与 offset 参数结合使用以实现分页。 此值与 offset 参数之和不应超过 16,384。

offsetinteger

需要在搜索结果中跳过的 Entity 数量。 您可以使用此参数与 limit 参数结合使用以实现分页。 此值与 limit 参数之和不应超过 16,384。

outputFieldsarray

需要在搜索结果中包含的字段名称列表。

[]outputFieldsstring

字段名称

searchParamsobject

当前操作的附加参数。

metricTypestring

当前操作使用的相似度度量类型。该值应与目标 Collection 的度量类型相同。

paramsobject

其它附加参数。

radiusnumber<float64>

确定最低相似度阈值。当设置 metric_type 为 L2 时,请确保该值大于 range_filter 的值。否则,该值应小于 range_filter 的值。

range_filternumber<float64>

优化搜索结果的相似度范围。当设置 metric_type 为 IP 或 COSINE 时,请确保该值大于 radius 的值。否则,该值应小于 radius 的值。

partitionNamesarray

一个 Partition 名称列表。设置此参数表示搜索仅限于指定的 Partition。否则,搜索会在 Collection 中搜索所有 Partition。

[]partitionNamesstring

一个 Partition 名称。

consistencyLevelstring

当前搜索操作的一致性级别。

exprParamsobject

一组键值对,可以回填 filter 字段中的变量,以启用过滤表达式模板。详情请参阅Filter Templating.

functionScoreobject

当前搜索请求的 Function 设置。

namestring

待应用的 Function 名称。

descriptionstring

待应用的 Function 描述。

typestring

待应用的 Function 类型。

inputFieldNamesarray

作为 Function 输入的标量字段名称列表。

[]inputFieldNamesstring

作为 Function 输入的一个标量字段名称。

outputFieldNamesarray

作为 Function 输出的向量字段名称列表。

[]outputFieldNamesstring

作为 Function 输出的一个向量字段名称。

paramsobject

Function 附加参数,以键值对形式提供。

paramsobject

搜索附加参数,以键值对形式提供。

functionChainsarray

搜索重排期间应用的 Function Chain 列表。

[]functionChainsobject

搜索重排期间应用的 Function Chain。

namestring

Function Chain 名称。

stagestring必填项

Function Chain 的执行阶段。

opsarray必填项

Function Chain 中的有序操作列表。

[]opsobject必填项

Function Chain 中的一个操作。

opstring必填项

操作名称。

exprobject

此操作执行的可选表达式。

namestring必填项

表达式函数名称。

argsarray

有序的表达式参数列表。

[]argsobject

表达式参数,可以是列或字面量。

columnstring

列名称。columnliteral 必须且只能指定一个。

literalundefined

字面量值。columnliteral 必须且只能指定一个。

paramsobject

表达式参数,以键值对形式提供。

inputsarray

输入列名称列表。

[]inputsstring

输入列名称。

outputsarray

输出列名称列表。

[]outputsstring

输出列名称。

paramsobject

操作参数,以键值对形式提供。

searchAggregationobject

搜索结果的聚合设置。此参数不能与 idsoffset 或分组参数同时使用。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

[]sortobject

Top Hits 的排序规则。

fieldNamestring必填项

用于对 Top Hits 排序的字段。

directionstring必填项

排序方向。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

[]orderobject

Aggregation Bucket 的排序规则。

keystring必填项

用于排序的 Bucket 数量或指标键。

directionstring必填项

排序方向。

topHitsobject

每个 Aggregation Bucket 的 Top Hits 设置。

sizeinteger必填项

每个 Bucket 返回的 Top Hits 数量。

取值范围:≥ 1
sortarray

Top Hits 的排序规则列表。

subAggregationobject

在每个 Bucket 内执行的嵌套聚合。

fieldsarray必填项

用于形成 Aggregation Bucket 的非空标量字段列表。

[]fieldsstring

用于形成 Aggregation Bucket 的标量字段。

sizeinteger必填项

需要返回的 Aggregation Bucket 数量。

取值范围:≥ 1
searchSizeinteger

搜索期间参与计算的 Bucket 数量。指定时必须大于或等于 size

取值范围:≥ 1
metricsobject

按结果名称索引的命名指标聚合。

orderarray

Aggregation Bucket 的排序规则列表。

topHitsundefined

每个 Aggregation Bucket 的 Top Hits 设置。

subAggregationundefined

在每个 Bucket 内执行的嵌套聚合。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "quick_setup",
"data": [
[
0.3580376395471989,
-0.6023495712049978,
0.18414012509913835,
-0.26286205330961354,
0.9029438446296592
]
],
"annsField": "vector",
"limit": 3,
"outputFields": [
"color"
],
"functionChains": [
{
"name": "l2",
"stage": "FunctionChainStageL2Rerank",
"ops": [
{
"op": "map",
"outputs": [
"new_score"
],
"expr": {
"name": "num_combine",
"args": [
{
"column": "$score"
},
{
"literal": 2.5
}
],
"params": {
"mode": "weighted"
}
}
}
]
}
],
"searchAggregation": {
"fields": [
"color"
],
"size": 10,
"order": [
{
"key": "_count",
"direction": "desc"
}
]
}
}'
响应

返回搜索结果。

codeinteger

响应码。

costinteger

当前操作的花费。仅用于 Free 和 Serverless 集群,表示当前操作消耗的 vCU。

dataarray

搜索结果,为一组 Entity 对象。

[]dataobject

一个返回的 Entity 对象。

recallsarray

每组搜索结果的召回率值。

[]recallsnumber
(待补充)
topksarray

每个查询向量返回的 Top-K 结果数量。

[]topksinteger
(待补充)
scanned_remote_bytesinteger

当部署使用 Tiered Storage 且已启用用量跟踪,并且操作从远程/磁盘存储读取数据时返回。当所有数据均从本地缓存提供时,此字段将被省略。

scanned_total_bytesinteger

当部署使用 Tiered Storage 且已启用用量跟踪,并且操作从远程/磁盘存储读取数据时返回。当所有数据均从本地缓存提供时,此字段将被省略。

cache_hit_rationumber

当部署使用 Tiered Storage 且已启用用量跟踪,并且操作从远程/磁盘存储读取数据时返回。当所有数据均从本地缓存提供时,此字段将被省略。

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

Successjson
{
"code": 0,
"data": [
{
"color": "orange_6781",
"distance": 1,
"id": 448300048035776800
},
{
"color": "red_4794",
"distance": 0.9353201,
"id": 448300048035776800
},
{
"color": "grey_8510",
"distance": 0.7733054,
"id": 448300048035776800
}
]
}
Ctrl I