KnnVectorQuery使用數值向量進行近似最近鄰查詢,可以在大規模資料集中找到最相似的資料項目。
前提條件
在資料表上建立多元索引並配置向量欄位。
注意事項
Table StorePython SDK從5.4.4版本開始支援向量檢索功能,推薦您使用最新版本的Table StorePython SDK。
說明Python SDK的歷史迭代版本資訊請參見Python SDK歷史迭代版本。
向量欄位類型的個數、維度等存在限制。更多資訊,請參見多元索引使用限制。
由於多元索引服務端是多分區的,多元索引服務端的每個分區均會返回自身最鄰近的TopK個值並在協調節點進行匯總,因此如果要使用Token翻頁擷取所有資料,則擷取到的總行數與多元索引服務端的分區數有關。
參數
參數 | 是否必選 | 說明 |
field_name | 是 | 向量欄位名稱。 |
top_k | 是 | 查詢最鄰近的topK個值。關於最大值的說明請參見多元索引使用限制。 重要 K值越大,召回率越好,但是查詢延遲和費用越高。 |
float32_query_vector | 是 | 要查詢相似性的向量。 |
filter | 否 | 查詢過濾器,支援組合使用任意的非向量檢索的查詢條件。 |
樣本
以下樣本用於查詢表中與指定向量最鄰近的10個向量資料,並且最鄰近的向量需要滿足col_keyword列值等於"0"且col_long列值在0到50之間的條件。
def knn_vector_query(client):
filter_query = BoolQuery(
must_queries=[
TermQuery(field_name='col_keyword', column_value="0"),
RangeQuery(field_name='col_long', range_from=0, range_to=50),
]
)
query = KnnVectorQuery(field_name='col_vector', top_k=10, float32_query_vector=[1.0, 1.1, 1.2, -1.3], filter=filter_query)
# 按照分數排序。
sort = Sort(sorters=[ScoreSort(sort_order=SortOrder.DESC)])
search_query = SearchQuery(query, limit=10, get_total_count=False, sort=sort)
search_response = client.search(
table_name='<TABLE_NAME>',
index_name='<SEARCH_INDEX_NAME>',
search_query=search_query,
columns_to_get=ColumnsToGet(column_names=["col_keyword", "col_long"], return_type=ColumnReturnType.SPECIFIED)
)
print("requestId:", search_response.request_id)
# 如果您當前使用的SDK版本無法擷取search_hits,請將SDK版本提升到6.1.0及以上。
for hit in search_response.search_hits:
# 擷取行資料。
row = hit.row
print(row)
# 擷取分數。
score = hit.score
print(score)