背景介紹

在向量檢索的實際應用中，有些場景需要將向量檢索的結果分組返回。例如：

• 在RAG中，一篇文檔往往需要拆分為多個段落，每個段落生成一個向量存入DashVector。在向量檢索時，為了結果的多樣性，不希望所有結果都來自同一篇文檔的段落，而是希望結果返回多篇文檔，并且每篇文檔下僅返回最相似的若干個段落。

• 在商品圖像檢索時，每個商品通常有多個商品圖片，每個圖片生成一個向量存入DashVector。在向量檢索時，為了結果的多樣性，不希望所有結果都是同一個商品的圖片，而是希望返回多樣化商品，并且每個商品下僅返回最相似的若干個圖片。

向量檢索服務DashVector支持分組向量檢索，對于上面的兩個場景可以通過分組檢索Doc接口分別設置group_by_field為“文檔ID”和“商品ID”，然后執行分組向量檢索。

使用示例

前提條件

• 已創建Cluster：創建Cluster。

• 已獲得API-KEY：API-KEY管理。

• 已安裝最新版SDK：安裝DashVector SDK。

插入帶有Field的數據

import dashvector
import numpy as np

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)
ret = client.create(
    name='group_by_demo',
    dimension=4,
    fields_schema={'document_id': str, 'chunk_id': int}
)
assert ret

collection = client.get(name='group_by_demo')

ret = collection.insert([
    ('1', np.random.rand(4), {'document_id': 'paper-01', 'chunk_id': 1, 'content': 'xxxA'}),
    ('2', np.random.rand(4), {'document_id': 'paper-01', 'chunk_id': 2, 'content': 'xxxB'}),
    ('3', np.random.rand(4), {'document_id': 'paper-02', 'chunk_id': 1, 'content': 'xxxC'}),
    ('4', np.random.rand(4), {'document_id': 'paper-02', 'chunk_id': 2, 'content': 'xxxD'}),
    ('5', np.random.rand(4), {'document_id': 'paper-02', 'chunk_id': 3, 'content': 'xxxE'}),
    ('6', np.random.rand(4), {'document_id': 'paper-03', 'chunk_id': 1, 'content': 'xxxF'}),
])
assert ret

執行分組向量檢索

ret = collection.query_group_by(
    vector=[0.1, 0.2, 0.3, 0.4],
    group_by_field='document_id',  # 按document_id字段的值分組
    group_count=2,  # 返回2個分組
    group_topk=2,   # 每個分組最多返回2個doc
)
# 判斷是否成功
if ret:
    print('query_group_by success')
    print(len(ret))
    print('------------------------')
    for group in ret:
        print('group key:', group.group_id)
        for doc in group.docs:
            prefix = ' -'
            print(prefix, doc)

上面分組檢索的示例結果如下：

query_group_by success
4
------------------------
group key: paper-01
 - {"id": "2", "fields": {"document_id": "paper-01", "chunk_id": 2, "content": "xxxB"}, "score": 0.6807}
 - {"id": "1", "fields": {"document_id": "paper-01", "chunk_id": 1, "content": "xxxA"}, "score": 0.4289}
group key: paper-02
 - {"id": "3", "fields": {"document_id": "paper-02", "chunk_id": 1, "content": "xxxC"}, "score": 0.6553}
 - {"id": "5", "fields": {"document_id": "paper-02", "chunk_id": 3, "content": "xxxE"}, "score": 0.4401}

限制說明