标量查询 - QueryEntities

store_name

是

String

参数解释：

知识仓实例名称，region内唯一。

约束限制：

长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。

取值范围：

不涉及。

默认取值：

不涉及。

collection_name

是

String

参数解释：

collection名称，知识仓内唯一。

约束限制：

长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（ _ ），大小写敏感。第一个字符只能够是下划线（ _ ）和字母，中划线(-)不得出现在字符串末尾。

取值范围：

不涉及。

默认取值：

不涉及。

output_fields

否

Array of strings

参数解释：

field名称列表，配置需与搜索结果一起返回的字段。

约束限制：

当取值为["count(*)"]时，top_k必须为负数，表示统计符合条件的entity数量。

取值范围：

不涉及。

默认取值：

[ ]，不返回任何额外的字段数据。

top_k

否

Integer

参数解释：

返回的entity个数限制。可以将此参数与offset结合使用以启用分页。当取值为负数时，表示返回所有符合条件的数据。

约束限制：

与offset取值的总和应小于16384。当output_field为["count(*)"]时，top_k必须为负数。

取值范围：

小于等于16384

默认取值：

10

offset

否

Integer

参数解释：

在搜索结果中跳过的记录数。可以将此参数与 top_k 参数结合使用以启用分页。

约束限制：

与top_k取值的总和应小于16384。

取值范围：

大于等于0

默认取值:

0

filter

是

String

参数解释：

用于过滤匹配entity的标量过滤条件。

约束限制：

要构建标量过滤条件，请参阅filter表达式规则。

取值范围：

不涉及。

默认取值：

不涉及。

code

String

参数解释：

返回码。参见错误码章节。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

message

String

参数解释：

描述信息

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

data

entities_data object

参数解释：

响应数据。

约束限制：

不涉及。

entities

Array of entity objects

参数解释：

查询到的信息。

约束限制：

不涉及。

{自定义key}

Map<String,Object>

参数解释：

collection中的一个基本结构化数据实体，包含向量和标量等字段数据。

约束限制：

必须满足目标collection field schema。

取值范围：

不涉及。

默认取值:

不涉及。

code

String

参数解释：

返回码。参见错误码章节。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

message

String

参数解释：

描述信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

200

搜索成功

400

搜索失败