向量数据库精确查询-SDK 参考-文档中心-腾讯云

功能介绍
基于精确匹配的查询方式，query() 用于精确查找与查询条件完全匹配的数据，具体支持如下功能。
支持根据主键 id（Document ID），搭配自定义的标量字段的 Filter 表达式一并查找数据。
支持指定查询起始位置 offset 和返回数量 limit，实现数据 SCAN 能力。
接口约束
说明：
该接口目前仅支持主键 id（Document ID）结合 Filter 表达式查询，即只能根据文档的唯一标识符来进行查询。
请求示例
如下示例，检索满足 documentId 以及 tag 字段 Filter 条件表达式的数据。
var (
    ctx                 = context.Background()
    database            = "go-sdk-test-db"
    collectionName      = "go-sdk-test-coll"
)
col := client.Database(database).Collection(collectionName)
option := &tcvectordb.QueryDocumentParams{
    Filter: tcvectordb.NewFilter(tcvectordb.Include("tag", []string{"曹操", "刘备"})),
    OutputFields:   []string{"id", "bookName"},
    Limit: 100,
}
documentId := []string{"0001", "0002", "0003", "0004", "0005"}
result, err := col.Query(ctx, documentId, option)
for _, doc := range result.Documents {
    log.Printf("document: %+v", doc)
}
参数
子参数
是否必选
参数含义
参数配置
documentIds
-
否
表示要查询的文档的所有 ID。
每个 ID 长度限制为[1,128]。支持批量查询，数组元素范围[1,20]。
QueryDocumentParams
RetrieveVector
否
标识是否需要返回检索结果的向量值。
true：需要。
false：不需要。默认为 false。
﻿
Filter
否
设置 Filter 表达式。
使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 混合检索。其中： 
<field_name>：表示要过滤的字段名。
<operator>：表示要使用的运算符。
string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。
uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。
array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。
<value>：表示要匹配的值。
示例：Filter('author="jerry"').And('page>20')
﻿
Limit
否
每页返回的 Document 数量。
﻿
﻿
每页返回的 Document 数量。默认为 1。
数据类型：uint 64
取值范围：[1,16384]
注意：
若使用 query 检索数据时，不配置 documentIds 和 Filter 参数，则必须配置 Offeset 和 Limit 参数，返回从 Offset 开始的 Limit 条数据，避免遍历所有数据而浪费不必要的资源。
﻿
Offset
否
设置分页偏移量，用于控制分页查询返回结果的起始位置，方便用户对数据进行分页展示和浏览。
取值要求如下：
取值：为 Limit 整数倍。
计算公式：offset=limit*(page-1)。
例如：当 limit = 10，page = 2 时，分页偏移量 offset = 10 * (2 - 1) = 10，表示从查询结果的第 11 条记录开始返回数据。
﻿
OutputFields
否
配置需返回的字段。
以数组形式配置需返回的字段。若不配置，返回所有字段。
说明：
OutputFields 与 RetrieveVector参数均可以配置是否输出向量值，二者任意一个配置需输出向量字段，则将输出向量字段。
返回信息
2023/12/20 19:10:00 document: {Id:0003 Fields:map[bookName:三国演义]}
2023/12/20 19:10:00 document: {Id:0004 Fields:map[bookName:三国演义]}
参数名
参数含义
id
Document 的 ID 信息。
Vector
Document 的向量值。该示例未打印此数据。
Fields
Document 自定义扩展的标量字段。例如：bookName、author 等。

参数	子参数	是否必选	参数含义	参数配置
`documentIds`	-	否	表示要查询的文档的所有 ID。	每个 ID 长度限制为[1,128]。支持批量查询，数组元素范围[1,20]。
`QueryDocumentParams`	`RetrieveVector`	否	标识是否需要返回检索结果的向量值。	true：需要。 false：不需要。默认为 false。
		`Filter`	否	设置 Filter 表达式。	使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见混合检索。其中： <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 <value>：表示要匹配的值。示例：`Filter('author="jerry"').And('page>20')`
		`Limit`	否	每页返回的 Document 数量。	每页返回的 Document 数量。默认为 1。数据类型：uint 64 取值范围：[1,16384] 注意：若使用 query 检索数据时，不配置 documentIds 和 Filter 参数，则必须配置 Offeset 和 Limit 参数，返回从 Offset 开始的 Limit 条数据，避免遍历所有数据而浪费不必要的资源。
		`Offset`	否	设置分页偏移量，用于控制分页查询返回结果的起始位置，方便用户对数据进行分页展示和浏览。	取值要求如下：取值：为 Limit 整数倍。计算公式：offset=limit(page-1)。例如：当 limit = 10，page = 2 时，分页偏移量 offset = 10 (2 - 1) = 10，表示从查询结果的第 11 条记录开始返回数据。
		`OutputFields`	否	配置需返回的字段。	以数组形式配置需返回的字段。若不配置，返回所有字段。说明： OutputFields 与 RetrieveVector参数均可以配置是否输出向量值，二者任意一个配置需输出向量字段，则将输出向量字段。

参数名	参数含义
id	Document 的 ID 信息。
Vector	Document 的向量值。该示例未打印此数据。
Fields	Document 自定义扩展的标量字段。例如：bookName、author 等。

精确查询

本页目录：

功能介绍

接口约束

请求示例

返回信息