Table Store Go SDK 向量檢索 - Tablestore

前提條件

開始前，完成以下準備工作：

安裝Tablestore Go SDK並初始化用戶端。
已建立包含 Vector 欄位的多元索引。具體操作請參見建立多元索引。

功能說明

向量檢索使用 KnnVectorQuery 計算查詢向量與 Vector 欄位中向量的距離，並返回最相似的 TopK 條資料。可以通過 Filter 先過濾候選資料，通過 MinScore 排除相似性不足的資料。

重要

向量欄位數量、向量維度和 TopK 等參數存在限制，具體請參見多元索引使用限制。

說明

多元索引服務端包含多個資料分區。每個分區返回自身最鄰近的 TopK 條資料，再由協調節點匯總。因此，使用 Token 翻頁時可擷取的總行數與索引分割區數有關。

func (client *tablestore.TableStoreClient) Search(request *tablestore.SearchRequest) (*tablestore.SearchResponse, error)

query := &search.KnnVectorQuery{
    FieldName:          "embedding",
    TopK:               proto.Int32(10),
    NumCandidates:      proto.Int32(100),
    Float32QueryVector: []float32{1, 0, 0, 0},
    MinScore:           proto.Float32(0.1),
    Filter: &search.TermQuery{
        FieldName: "category",
        Term:      "books",
    },
}
searchQuery := search.NewSearchQuery().
    SetQuery(query).
    SetSort(&search.Sort{Sorters: []search.Sorter{search.NewScoreSort()}})

response, err := client.Search(&tablestore.SearchRequest{
    TableName:   "example_table",
    IndexName:   "example_vector_index",
    SearchQuery: searchQuery,
    ColumnsToGet: &tablestore.ColumnsToGet{
        ReturnAllFromIndex: true,
    },
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(response.SearchHits)

參數說明

查詢請求

名稱	類型	說明
TableName（必選）	string	資料表名稱。
IndexName（必選）	string	多元索引名稱。
SearchQuery（必選）	search.SearchQuery	查詢條件和通用查詢配置。
ColumnsToGet（可選）	*tablestore.ColumnsToGet	返回列配置。未設定時只返回主鍵列。
RoutingValues（可選）	[]*tablestore.PrimaryKey	自訂路由欄位對應的主索引值列表。未配置自訂路由時無需設定。
TimeoutMs（可選）	*int32	請求級逾時時間，單位為毫秒。

查詢配置

名稱	類型	說明
SetQuery（必選）	search.Query	設定查詢條件。
SetOffset（可選）	int32	設定本次查詢的起始位置，預設值為 0。使用 Offset 翻頁時，Offset + Limit 不能超過 100000。
SetLimit（可選）	int32	設定本次查詢返回的最大行數，預設值為 10，最大值為 100。設定為 0 時不返回具體行。
SetCollapse（可選）	*search.Collapse	設定結果摺疊。配置方法請參見摺疊（去重）。
SetSort（可選）	*search.Sort	設定返回結果的排序方式。配置方法請參見排序和翻頁。
SetGetTotalCount（可選）	bool	是否統計匹配總行數，預設值為 false。
SetToken（可選）	[]byte	設定上一次響應返回的 NextToken，以繼續讀取後續資料。調用該方法會清除 Sort，因為 Token 已包含上一頁的排序條件。使用 Token 翻頁時不能設定 Offset。
SetSearchFilter（可選）	*search.SearchFilter	對查詢結果執行後過濾。配置方法請參見查詢後過濾。
Aggregation（可選）	...search.Aggregation	設定統計彙總。配置方法請參見統計彙總。
GroupBy（可選）	...search.GroupBy	設定分組。配置方法請參見統計彙總。

向量查詢條件

名稱	類型	說明
FieldName（必選）	string	Vector 欄位名稱。
TopK（必選）	*int32	返回的最鄰近資料數量。值越大，召回率通常越高，但查詢延遲和費用也越高。
Float32QueryVector（必選）	[]float32	查詢向量，其維度必須與索引欄位配置一致。
Filter（可選）	search.Query	候選資料過濾條件，支援除向量檢索外的查詢類型。
MinScore（可選）	*float32	最低評分閾值，取值必須大於或等於 0，預設值為 0。僅返回評分高於該值的資料。
NumCandidates（可選）	*int32	參與精排的候選向量數量，不小於 TopK。值越大，召回率通常越高，但查詢延遲也越高。
Weight（可選）	*float32	查詢條件的相關性權重。

返回列

名稱	類型	說明
Columns（可選）	[]string	要返回的屬性列名稱。僅 ReturnAll 和 ReturnAllFromIndex 均為 false 時生效。
ReturnAll（可選）	bool	是否返回資料表中的全部屬性列，預設值為 false。
ReturnAllFromIndex（可選）	bool	是否返回已建立索引的全部屬性列，預設值為 false。不能與 ReturnAll 同時設定為 true。

傳回值

名稱	類型	說明
TotalCount	int64	匹配總行數。傳回值取決於 SetGetTotalCount 配置。
Rows	[]*tablestore.Row	本次查詢返回的行資料，數量不超過 SetLimit 指定的值。
SearchHits	[]*tablestore.SearchHit	查詢命中結果。配置摘要與高亮、嵌套 InnerHits 或需要相關性評分時，從該欄位讀取結果。
NextToken	[]byte	下一頁憑證。值非空時，將其傳入下一次查詢繼續讀取。
IsAllSuccess	bool	是否已成功查詢全部索引分割區。值為 false 時返回的是部分結果，TotalCount 可能小於實際匹配行數。
AggregationResults	search.AggregationResults	統計彙總結果。
GroupByResults	search.GroupByResults	分組結果。