StructArray を使用したハイブリッド検索
このページでは、StructArray のベクトル検索と他のベクトル検索を 1 つのハイブリッド検索リクエストにまとめる方法を説明します。StructArray ハイブリッド検索では、組み合わせる AnnSearchRequest オブジェクトに応じて、エンティティレベルの結果または要素レベルの結果を生成できます。
このページでは、StructArray フィールドの作成 で作成する tech_articles コレクションを使用します。コレクションには、title_vector という名前のトップレベルのベクトルフィールドと、chunks という名前の StructArray フィールドがあります。chunks[emb_list_vector] サブフィールドには EmbeddingList 検索用のインデックスが作成され、chunks[emb] には要素レベル検索用のインデックスが作成されています。
StructArray にハイブリッド検索を適用する
AnnSearchRequest の組み合わせ | 最終候補スコープ | 結果の動作 | element_scope |
|---|---|---|---|
| コレクションレベルのベクトルフィールド + StructArray の EmbeddingList サブフィールド | エンティティレベル | 最終候補のキーは主キーです。 | 使用しないでください。 |
| コレクションレベルのベクトルフィールド + StructArray の要素レベルサブフィールド | エンティティレベル | 要素レベルのヒットは、ハイブリッド再ランキングの前にエンティティレベルの候補へ集約されます。 | StructArray 要素レベルの AnnSearchRequest に対するオプションの集約設定。 |
| 同じ StructArray フィールド内の複数の要素レベルサブフィールド | 要素レベル | 最終候補のキーは主キーと Struct 要素のオフセットです。 | 使用しないでください。 |
| 異なる StructArray フィールド内の要素レベルサブフィールド | エンティティレベル | 要素のオフセットは同一性を共有しないため、各 StructArray 要素レベルの AnnSearchRequest は再ランキングの前に集約されます。 | 各 StructArray 要素レベルの AnnSearchRequest に対するオプションの集約設定。 |
element_scope は、同じ StructArray 内ではない要素レベルハイブリッド検索において、StructArray 要素レベルの AnnSearchRequest オブジェクトの集約を構成する場合にのみ使用してください。EmbeddingList リクエスト、コレクションレベルのベクトルリクエスト、または同じ StructArray 内の要素レベルハイブリッド検索には使用しないでください。
事前準備
ハイブリッド検索を実行する前に、コレクション、データ、インデックスを準備してください。
| 要件 | 詳細 |
|---|---|
| StructArray フィールド | コレクションに chunks などの StructArray フィールドが含まれている必要があります。 |
| ベクトルサブフィールド | EmbeddingList 検索と要素レベル検索には、別々のベクトルサブフィールドを使用します。 |
| インデックス | chunks[emb_list_vector] は MAX_SIM* メトリクスを使用します。chunks[emb] は COSINE、IP、L2 などの通常のベクトルメトリクスを使用します。 |
| リランカー | RRFRanker など、アプリケーションでサポートされているハイブリッドリランカーを選択します。 |
インデックスの設定については、StructArray フィールドのインデックス作成 を参照してください。
EmbeddingList リクエストを使用してハイブリッド検索を実行する
StructArray のベクトルサブフィールドに対する EmbeddingList 検索は、ハイブリッド検索ではエンティティレベルです。エンティティレベルのベクトル検索リクエストと同様に動作し、一致した 1 つの Struct 要素のオフセットは返しません。
- Python
- Java
- Go
- Rust
- C++
- NodeJS
- cURL
from pymilvus import AnnSearchRequest, MilvusClient, RRFRanker
from pymilvus.client.embedding_list import EmbeddingList
client = MilvusClient(
uri="YOUR_CLUSTER_ENDPOINT",
token="YOUR_CLUSTER_TOKEN",
)
query_vector = [0.19, 0.24, 0.30, 0.37]
query_list = EmbeddingList()
query_list.add([0.12, 0.21, 0.32, 0.44])
query_list.add([0.18, 0.23, 0.29, 0.36])
title_req = AnnSearchRequest(
data=[query_vector],
anns_field="title_vector",
param={},
limit=10,
)
chunk_list_req = AnnSearchRequest(
data=[query_list],
anns_field="chunks[emb_list_vector]",
param={},
limit=10,
)
results = client.hybrid_search(
collection_name="tech_articles",
reqs=[title_req, chunk_list_req],
ranker=RRFRanker(),
limit=5,
output_fields=[
"doc_id",
"title",
"category",
"chunks[text]",
"chunks[section]",
],
)
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.vector.request.AnnSearchReq;
import io.milvus.v2.service.vector.request.HybridSearchReq;
import io.milvus.v2.service.vector.request.data.EmbeddingList;
import io.milvus.v2.service.vector.request.data.FloatVec;
import io.milvus.v2.service.vector.request.ranker.RRFRanker;
import io.milvus.v2.service.vector.response.SearchResp;
import java.util.Arrays;
import java.util.Collections;
ConnectConfig connectConfig = ConnectConfig.builder()
.uri("YOUR_CLUSTER_ENDPOINT")
.token("YOUR_CLUSTER_TOKEN")
.build();
MilvusClientV2 client = new MilvusClientV2(connectConfig);
FloatVec queryVector = new FloatVec(Arrays.asList(0.19f, 0.24f, 0.30f, 0.37f));
EmbeddingList queryList = new EmbeddingList();
queryList.add(new FloatVec(Arrays.asList(0.12f, 0.21f, 0.32f, 0.44f)));
queryList.add(new FloatVec(Arrays.asList(0.18f, 0.23f, 0.29f, 0.36f)));
AnnSearchReq titleReq = AnnSearchReq.builder()
.vectorFieldName("title_vector")
.vectors(Collections.singletonList(queryVector))
.limit(10)
.build();
AnnSearchReq chunkListReq = AnnSearchReq.builder()
.vectorFieldName("chunks[emb_list_vector]")
.vectors(Collections.singletonList(queryList))
.limit(10)
.build();
SearchResp results = client.hybridSearch(HybridSearchReq.builder()
.collectionName("tech_articles")
.searchRequests(Arrays.asList(titleReq, chunkListReq))
.ranker(RRFRanker.builder().k(60).build())
.limit(5)
.outFields(Arrays.asList("doc_id", "title", "category", "chunks[text]", "chunks[section]"))
.build());
import (
"context"
"fmt"
"log"
"github.com/milvus-io/milvus/client/v3/entity"
milvusclient "github.com/milvus-io/milvus/client/v3/milvusclient"
)
ctx := context.Background()
cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
Address: "YOUR_CLUSTER_ENDPOINT",
APIKey: "YOUR_CLUSTER_TOKEN",
})
if err != nil {
log.Fatal(err)
}
queryVector := entity.FloatVector{0.19, 0.24, 0.30, 0.37}
queryList := entity.FloatVectorArray{
entity.FloatVector{0.12, 0.21, 0.32, 0.44},
entity.FloatVector{0.18, 0.23, 0.29, 0.36},
}
titleReq := milvusclient.NewAnnRequest("title_vector", 10, queryVector)
chunkListReq := milvusclient.NewAnnRequest("chunks[emb_list_vector]", 10, queryList)
results, err := cli.HybridSearch(ctx, milvusclient.NewHybridSearchOption("tech_articles", 5,
titleReq, chunkListReq).
WithReranker(milvusclient.NewRRFReranker()).
WithOutputFields("doc_id", "title", "category", "chunks[text]", "chunks[section]"))
if err != nil {
fmt.Println(err.Error())
}
fmt.Printf("hybrid search returned %d result sets\n", len(results))
use milvus::v2::prelude::*;
let config = ConnectConfig::new().uri("YOUR_CLUSTER_ENDPOINT").token("YOUR_CLUSTER_TOKEN");
let client = ClientV2::new(&config).await?;
let query_vector = vec![0.19f32, 0.24, 0.30, 0.37];
let query_list = EmbeddingList::new()
.add_vector(vec![0.12f32, 0.21, 0.32, 0.44])
.add_vector(vec![0.18f32, 0.23, 0.29, 0.36]);
let title_req = SubSearchRequest::builder()
.vector_field("title_vector")
.vectors(SearchVectors::Float(vec![query_vector.clone()]))
.limit(10)
.build()?;
let chunk_list_req = SubSearchRequest::builder()
.vector_field("chunks[emb_list_vector]")
.vectors(SearchVectors::EmbeddingLists(vec![query_list]))
.limit(10)
.build()?;
let request = HybridSearchRequest::builder()
.collection_name("tech_articles")
.sub_requests(vec![title_req, chunk_list_req])
.rerank(RRFRerank::new().k(60))
.limit(5)
.output_fields(vec!["doc_id", "title", "category", "chunks[text]", "chunks[section]"])
.build()?;
let results = client.hybrid_search(request).await?;
#include <iostream>
#include <memory>
#include <vector>
#include "milvus/MilvusClientV2.h"
#include "milvus/request/dql/HybridSearchRequest.h"
#include "milvus/types/SubSearchRequest.h"
#include "milvus/types/EmbeddingList.h"
auto client = milvus::MilvusClientV2::Create();
auto status = client->Connect(milvus::ConnectParam("YOUR_CLUSTER_ENDPOINT").WithToken("YOUR_CLUSTER_TOKEN"));
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
std::vector<float> query_vector = {0.19f, 0.24f, 0.30f, 0.37f};
milvus::EmbeddingList query_list;
query_list.AddFloatVector({0.12f, 0.21f, 0.32f, 0.44f});
query_list.AddFloatVector({0.18f, 0.23f, 0.29f, 0.36f});
auto title_req = std::make_shared<milvus::SubSearchRequest>();
title_req->WithAnnsField("title_vector").WithLimit(10);
title_req->AddFloatVector(query_vector);
auto chunk_list_req = std::make_shared<milvus::SubSearchRequest>();
chunk_list_req->WithAnnsField("chunks[emb_list_vector]").WithLimit(10);
chunk_list_req->AddEmbeddingList(std::move(query_list));
milvus::HybridSearchRequest request;
request.WithCollectionName("tech_articles")
.WithLimit(5)
.AddSubRequest(title_req)
.AddSubRequest(chunk_list_req)
.WithRerank(std::make_shared<milvus::RRFRerank>(60));
request.WithOutputFields({"doc_id", "title", "category", "chunks[text]", "chunks[section]"});
milvus::HybridSearchResponse response;
status = client->HybridSearch(request, response);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
import { MilvusClient } from "@zilliz/milvus2-sdk-node";
const client = new MilvusClient({ address: "YOUR_CLUSTER_ENDPOINT", token: "YOUR_CLUSTER_TOKEN" });
const query_vector = [0.19, 0.24, 0.30, 0.37];
const query_list = [
[0.12, 0.21, 0.32, 0.44],
[0.18, 0.23, 0.29, 0.36],
];
const results = await client.search({
collection_name: "tech_articles",
data: [
{ anns_field: "title_vector", data: [query_vector], limit: 10 },
{ anns_field: "chunks[emb_list_vector]", data: query_list, limit: 10 },
],
rerank: { strategy: "rrf", params: { k: 60 } },
limit: 5,
output_fields: ["doc_id", "title", "category", "chunks[text]", "chunks[section]"],
});
export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/hybrid_search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "tech_articles",
"search": [
{
"data": [[0.19, 0.24, 0.30, 0.37]],
"annsField": "title_vector",
"limit": 10
},
{
"data": [[[0.12, 0.21, 0.32, 0.44], [0.18, 0.23, 0.29, 0.36]]],
"annsField": "chunks[emb_list_vector]",
"limit": 10
}
],
"rerank": { "strategy": "rrf", "params": { "k": 60 } },
"limit": 5,
"outputFields": ["doc_id", "title", "category", "chunks[text]", "chunks[section]"]
}'
この例では、両方の AnnSearchRequest オブジェクトがエンティティレベルの候補を生成します。最終結果のキーは親エンティティの主キーです。EmbeddingList リクエストに element_scope を追加しないでください。
同じ StructArray 内で要素レベルのハイブリッド検索を実行する
すべての AnnSearchRequest オブジェクトが同じ StructArray フィールド内の要素レベルのベクトルサブフィールドを対象とする場合、ハイブリッド検索は再ランキングを通じて要素レベルの候補を維持できます。最終結果が要素レベルのままになる StructArray ハイブリッドモードはこれだけです。
次の例では、chunks StructArray フィールドに chunks[emb] と chunks[code_emb] という2つの要素レベルのベクトルサブフィールドがあり、どちらも通常のベクトルメトリクスを使用することを前提としています。
- Python
- Java
- Go
- Rust
- C++
- NodeJS
- cURL
query_vector = [0.19, 0.24, 0.30, 0.37]
code_query_vector = [0.20, 0.25, 0.31, 0.38]
index_chunk_req = AnnSearchRequest(
data=[query_vector],
anns_field="chunks[emb]",
limit=10,
param={},
expr='element_filter(chunks, $[section] == "index")',
)
code_chunk_req = AnnSearchRequest(
data=[code_query_vector],
anns_field="chunks[code_emb]",
limit=10,
param={},
expr='element_filter(chunks, $[has_code] == true)',
)
results = client.hybrid_search(
collection_name="tech_articles",
reqs=[index_chunk_req, code_chunk_req],
ranker=RRFRanker(),
limit=5,
output_fields=[
"doc_id",
"title",
"chunks[text]",
"chunks[section]",
"chunks[quality_score]",
],
)
for hits in results:
for hit in hits:
print(
"doc_id:", hit["doc_id"],
"distance:", hit["distance"],
"offset:", hit.get("offset"),
"entity:", hit["entity"],
)
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.vector.request.AnnSearchReq;
import io.milvus.v2.service.vector.request.HybridSearchReq;
import io.milvus.v2.service.vector.request.data.FloatVec;
import io.milvus.v2.service.vector.request.ranker.RRFRanker;
import io.milvus.v2.service.vector.response.SearchResp;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
ConnectConfig connectConfig = ConnectConfig.builder()
.uri("YOUR_CLUSTER_ENDPOINT")
.token("YOUR_CLUSTER_TOKEN")
.build();
MilvusClientV2 client = new MilvusClientV2(connectConfig);
FloatVec queryVector = new FloatVec(Arrays.asList(0.19f, 0.24f, 0.30f, 0.37f));
FloatVec codeQueryVector = new FloatVec(Arrays.asList(0.20f, 0.25f, 0.31f, 0.38f));
AnnSearchReq indexChunkReq = AnnSearchReq.builder()
.vectorFieldName("chunks[emb]")
.vectors(Collections.singletonList(queryVector))
.limit(10)
.filter("element_filter(chunks, $[section] == \"index\")")
.build();
AnnSearchReq codeChunkReq = AnnSearchReq.builder()
.vectorFieldName("chunks[code_emb]")
.vectors(Collections.singletonList(codeQueryVector))
.limit(10)
.filter("element_filter(chunks, $[has_code] == true)")
.build();
SearchResp results = client.hybridSearch(HybridSearchReq.builder()
.collectionName("tech_articles")
.searchRequests(Arrays.asList(indexChunkReq, codeChunkReq))
.ranker(RRFRanker.builder().k(60).build())
.limit(5)
.outFields(Arrays.asList("doc_id", "title", "chunks[text]", "chunks[section]", "chunks[quality_score]"))
.build());
for (List<SearchResp.SearchResult> hits : results.getSearchResults()) {
for (SearchResp.SearchResult hit : hits) {
System.out.println("doc_id: " + hit.getId() + ", distance: " + hit.getScore()
+ ", offset: " + hit.getElementOffset() + ", entity: " + hit.getEntity());
}
}
import (
"context"
"fmt"
"log"
"github.com/milvus-io/milvus/client/v3/entity"
milvusclient "github.com/milvus-io/milvus/client/v3/milvusclient"
)
ctx := context.Background()
cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
Address: "YOUR_CLUSTER_ENDPOINT",
APIKey: "YOUR_CLUSTER_TOKEN",
})
if err != nil {
log.Fatal(err)
}
queryVector := entity.FloatVector{0.19, 0.24, 0.30, 0.37}
codeQueryVector := entity.FloatVector{0.20, 0.25, 0.31, 0.38}
indexChunkReq := milvusclient.NewAnnRequest("chunks[emb]", 10, queryVector).
WithFilter("element_filter(chunks, $[section] == \"index\")")
codeChunkReq := milvusclient.NewAnnRequest("chunks[code_emb]", 10, codeQueryVector).
WithFilter("element_filter(chunks, $[has_code] == true)")
results, err := cli.HybridSearch(ctx, milvusclient.NewHybridSearchOption("tech_articles", 5,
indexChunkReq, codeChunkReq).
WithReranker(milvusclient.NewRRFReranker()).
WithOutputFields("doc_id", "title", "chunks[text]", "chunks[section]", "chunks[quality_score]"))
if err != nil {
fmt.Println(err.Error())
}
fmt.Printf("hybrid search returned %d result sets\n", len(results))
use milvus::v2::prelude::*;
let config = ConnectConfig::new().uri("YOUR_CLUSTER_ENDPOINT").token("YOUR_CLUSTER_TOKEN");
let client = ClientV2::new(&config).await?;
let query_vector = vec![0.19f32, 0.24, 0.30, 0.37];
let code_query_vector = vec![0.20f32, 0.25, 0.31, 0.38];
let index_chunk_req = SubSearchRequest::builder()
.vector_field("chunks[emb]")
.vectors(SearchVectors::Float(vec![query_vector]))
.limit(10)
.filter("element_filter(chunks, $[section] == \"index\")")
.build()?;
let code_chunk_req = SubSearchRequest::builder()
.vector_field("chunks[code_emb]")
.vectors(SearchVectors::Float(vec![code_query_vector]))
.limit(10)
.filter("element_filter(chunks, $[has_code] == true)")
.build()?;
let request = HybridSearchRequest::builder()
.collection_name("tech_articles")
.sub_requests(vec![index_chunk_req, code_chunk_req])
.rerank(RRFRerank::new().k(60))
.limit(5)
.output_fields(vec!["doc_id", "title", "chunks[text]", "chunks[section]", "chunks[quality_score]"])
.build()?;
let results = client.hybrid_search(request).await?;
#include <iostream>
#include <memory>
#include <vector>
#include "milvus/MilvusClientV2.h"
#include "milvus/request/dql/HybridSearchRequest.h"
#include "milvus/types/SubSearchRequest.h"
auto client = milvus::MilvusClientV2::Create();
auto status = client->Connect(milvus::ConnectParam("YOUR_CLUSTER_ENDPOINT").WithToken("YOUR_CLUSTER_TOKEN"));
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
std::vector<float> query_vector = {0.19f, 0.24f, 0.30f, 0.37f};
std::vector<float> code_query_vector = {0.20f, 0.25f, 0.31f, 0.38f};
auto index_chunk_req = std::make_shared<milvus::SubSearchRequest>();
index_chunk_req->WithAnnsField("chunks[emb]").WithLimit(10);
index_chunk_req->WithFilter("element_filter(chunks, $[section] == \"index\")");
index_chunk_req->AddFloatVector(query_vector);
auto code_chunk_req = std::make_shared<milvus::SubSearchRequest>();
code_chunk_req->WithAnnsField("chunks[code_emb]").WithLimit(10);
code_chunk_req->WithFilter("element_filter(chunks, $[has_code] == true)");
code_chunk_req->AddFloatVector(code_query_vector);
milvus::HybridSearchRequest request;
request.WithCollectionName("tech_articles")
.WithLimit(5)
.AddSubRequest(index_chunk_req)
.AddSubRequest(code_chunk_req)
.WithRerank(std::make_shared<milvus::RRFRerank>(60));
request.WithOutputFields({"doc_id", "title", "chunks[text]", "chunks[section]", "chunks[quality_score]"});
milvus::HybridSearchResponse response;
status = client->HybridSearch(request, response);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
const query_vector = [0.19, 0.24, 0.30, 0.37];
const code_query_vector = [0.20, 0.25, 0.31, 0.38];
const results = await client.search({
collection_name: "tech_articles",
data: [
{ anns_field: "chunks[emb]", data: query_vector, limit: 10, expr: "element_filter(chunks, $[section] == \"index\")" },
{ anns_field: "chunks[code_emb]", data: code_query_vector, limit: 10, expr: "element_filter(chunks, $[has_code] == true)" },
],
rerank: { strategy: "rrf", params: { k: 60 } },
limit: 5,
output_fields: ["doc_id", "title", "chunks[text]", "chunks[section]", "chunks[quality_score]"],
});
export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/hybrid_search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "tech_articles",
"search": [
{
"data": [[0.19, 0.24, 0.30, 0.37]],
"annsField": "chunks[emb]",
"limit": 10,
"filter": "element_filter(chunks, $[section] == \"index\")"
},
{
"data": [[0.20, 0.25, 0.31, 0.38]],
"annsField": "chunks[code_emb]",
"limit": 10,
"filter": "element_filter(chunks, $[has_code] == true)"
}
],
"rerank": { "strategy": "rrf", "params": { "k": 60 } },
"limit": 5,
"outputFields": ["doc_id", "title", "chunks[text]", "chunks[section]", "chunks[quality_score]"]
}'
両方の AnnSearchRequest オブジェクトは chunks 内のベクトルサブフィールドを検索します。同じ 0 始まりのオフセットは同じ Struct 要素を指すため、ハイブリッドリランカーは要素レベルの候補を直接ランキングできます。エンティティレベルの集約は行われないため、このモードでは element_scope を設定しないでください。
エンティティレベルのハイブリッド検索のために要素レベルのヒットを集約する
ハイブリッド検索で StructArray 要素レベルの AnnSearchRequest を、コレクションレベルのベクトルリクエスト、EmbeddingList リクエスト、または異なる StructArray フィールド内の要素レベルリクエストと組み合わせる場合、最終候補スコープはエンティティレベルになります。この場合、各 StructArray 要素レベルの AnnSearchRequest は、ハイブリッド再ランキングの前にエンティティレベルの候補へ集約されます。
同じエンティティから一致した複数の要素をどのように集約するかを制御する必要がある場合は、StructArray 要素レベルの AnnSearchRequest の params 内で element_scope を使用します。
- Python
- Java
- Go
- Rust
- C++
- NodeJS
- cURL
query_vector = [0.19, 0.24, 0.30, 0.37]
title_req = AnnSearchRequest(
data=[query_vector],
anns_field="title_vector",
param={},
limit=10,
)
chunk_req = AnnSearchRequest(
data=[query_vector],
anns_field="chunks[emb]",
param={
"params": {
"element_scope": {
"collapse": {
"strategy": "topk_sum",
"topk": 3,
},
},
},
},
limit=30,
expr='element_filter(chunks, $[quality_score] > 0.8)',
)
results = client.hybrid_search(
collection_name="tech_articles",
reqs=[title_req, chunk_req],
ranker=RRFRanker(),
limit=5,
output_fields=[
"doc_id",
"title",
"category",
"chunks[text]",
"chunks[section]",
"chunks[quality_score]",
],
)
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.vector.request.AnnSearchReq;
import io.milvus.v2.service.vector.request.HybridSearchReq;
import io.milvus.v2.service.vector.request.data.FloatVec;
import io.milvus.v2.service.vector.request.ranker.RRFRanker;
import io.milvus.v2.service.vector.response.SearchResp;
import java.util.Arrays;
import java.util.Collections;
ConnectConfig connectConfig = ConnectConfig.builder()
.uri("YOUR_CLUSTER_ENDPOINT")
.token("YOUR_CLUSTER_TOKEN")
.build();
MilvusClientV2 client = new MilvusClientV2(connectConfig);
FloatVec queryVector = new FloatVec(Arrays.asList(0.19f, 0.24f, 0.30f, 0.37f));
AnnSearchReq titleReq = AnnSearchReq.builder()
.vectorFieldName("title_vector")
.vectors(Collections.singletonList(queryVector))
.limit(10)
.build();
AnnSearchReq chunkReq = AnnSearchReq.builder()
.vectorFieldName("chunks[emb]")
.vectors(Collections.singletonList(queryVector))
.limit(30)
.filter("element_filter(chunks, $[quality_score] > 0.8)")
.params("{\"element_scope\": {\"collapse\": {\"strategy\": \"topk_sum\", \"topk\": 3}}}")
.build();
SearchResp results = client.hybridSearch(HybridSearchReq.builder()
.collectionName("tech_articles")
.searchRequests(Arrays.asList(titleReq, chunkReq))
.ranker(RRFRanker.builder().k(60).build())
.limit(5)
.outFields(Arrays.asList("doc_id", "title", "category", "chunks[text]", "chunks[section]", "chunks[quality_score]"))
.build());
import (
"context"
"fmt"
"log"
"github.com/milvus-io/milvus/client/v3/entity"
milvusclient "github.com/milvus-io/milvus/client/v3/milvusclient"
)
ctx := context.Background()
cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
Address: "YOUR_CLUSTER_ENDPOINT",
APIKey: "YOUR_CLUSTER_TOKEN",
})
if err != nil {
log.Fatal(err)
}
queryVector := entity.FloatVector{0.19, 0.24, 0.30, 0.37}
titleReq := milvusclient.NewAnnRequest("title_vector", 10, queryVector)
chunkReq := milvusclient.NewAnnRequest("chunks[emb]", 30, queryVector).
WithFilter("element_filter(chunks, $[quality_score] > 0.8)").
WithSearchParam("params", "{\"element_scope\": {\"collapse\": {\"strategy\": \"topk_sum\", \"topk\": 3}}}")
results, err := cli.HybridSearch(ctx, milvusclient.NewHybridSearchOption("tech_articles", 5,
titleReq, chunkReq).
WithReranker(milvusclient.NewRRFReranker()).
WithOutputFields("doc_id", "title", "category", "chunks[text]", "chunks[section]", "chunks[quality_score]"))
if err != nil {
fmt.Println(err.Error())
}
fmt.Printf("hybrid search returned %d result sets\n", len(results))
use milvus::v2::prelude::*;
let config = ConnectConfig::new().uri("YOUR_CLUSTER_ENDPOINT").token("YOUR_CLUSTER_TOKEN");
let client = ClientV2::new(&config).await?;
let query_vector = vec![0.19f32, 0.24, 0.30, 0.37];
let title_req = SubSearchRequest::builder()
.vector_field("title_vector")
.vectors(SearchVectors::Float(vec![query_vector.clone()]))
.limit(10)
.build()?;
let chunk_req = SubSearchRequest::builder()
.vector_field("chunks[emb]")
.vectors(SearchVectors::Float(vec![query_vector]))
.limit(30)
.filter("element_filter(chunks, $[quality_score] > 0.8)")
// Note: element_scope collapse is not yet supported in milvus-sdk-rust as of v3.0.2.
.build()?;
let request = HybridSearchRequest::builder()
.collection_name("tech_articles")
.sub_requests(vec![title_req, chunk_req])
.rerank(RRFRerank::new().k(60))
.limit(5)
.output_fields(vec!["doc_id", "title", "category", "chunks[text]", "chunks[section]", "chunks[quality_score]"])
.build()?;
let results = client.hybrid_search(request).await?;
#include <iostream>
#include <memory>
#include <vector>
#include "milvus/MilvusClientV2.h"
#include "milvus/request/dql/HybridSearchRequest.h"
#include "milvus/types/SubSearchRequest.h"
auto client = milvus::MilvusClientV2::Create();
auto status = client->Connect(milvus::ConnectParam("YOUR_CLUSTER_ENDPOINT").WithToken("YOUR_CLUSTER_TOKEN"));
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
std::vector<float> query_vector = {0.19f, 0.24f, 0.30f, 0.37f};
auto title_req = std::make_shared<milvus::SubSearchRequest>();
title_req->WithAnnsField("title_vector").WithLimit(10);
title_req->AddFloatVector(query_vector);
auto chunk_req = std::make_shared<milvus::SubSearchRequest>();
chunk_req->WithAnnsField("chunks[emb]").WithLimit(30);
chunk_req->WithFilter("element_filter(chunks, $[quality_score] > 0.8)");
chunk_req->AddExtraParam("params", "{\"element_scope\": {\"collapse\": {\"strategy\": \"topk_sum\", \"topk\": 3}}}");
chunk_req->AddFloatVector(query_vector);
milvus::HybridSearchRequest request;
request.WithCollectionName("tech_articles")
.WithLimit(5)
.AddSubRequest(title_req)
.AddSubRequest(chunk_req)
.WithRerank(std::make_shared<milvus::RRFRerank>(60));
request.WithOutputFields({"doc_id", "title", "category", "chunks[text]", "chunks[section]", "chunks[quality_score]"});
milvus::HybridSearchResponse response;
status = client->HybridSearch(request, response);
if (!status.IsOk()) {
std::cout << status.Message() << std::endl;
}
const query_vector = [0.19, 0.24, 0.30, 0.37];
const results = await client.search({
collection_name: "tech_articles",
data: [
{ anns_field: "title_vector", data: [query_vector], limit: 10 },
{
anns_field: "chunks[emb]",
data: query_vector,
limit: 30,
expr: "element_filter(chunks, $[quality_score] > 0.8)",
params: { element_scope: { collapse: { strategy: "topk_sum", topk: 3 } } },
},
],
rerank: { strategy: "rrf", params: { k: 60 } },
limit: 5,
output_fields: ["doc_id", "title", "category", "chunks[text]", "chunks[section]", "chunks[quality_score]"],
});
export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/hybrid_search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "tech_articles",
"search": [
{
"data": [[0.19, 0.24, 0.30, 0.37]],
"annsField": "title_vector",
"limit": 10
},
{
"data": [[0.19, 0.24, 0.30, 0.37]],
"annsField": "chunks[emb]",
"limit": 30,
"filter": "element_filter(chunks, $[quality_score] > 0.8)",
"params": {
"element_scope": {
"collapse": { "strategy": "topk_sum", "topk": 3 }
}
}
}
],
"rerank": { "strategy": "rrf", "params": { "k": 60 } },
"limit": 5,
"outputFields": ["doc_id", "title", "category", "chunks[text]", "chunks[section]", "chunks[quality_score]"]
}'
この例では、title_req がエンティティレベルであるため、最終的なハイブリッド検索結果もエンティティレベルになります。chunk_req リクエストはまず chunks[emb] から要素レベルのヒットを返し、次に同じエンティティから返された要素のうち上位3つの要素スコアを合計して集約します。エンティティレベルの集約が必要なときに element_scope を省略すると、集約戦略はデフォルトで max になります。
集約戦略を選択する
| 戦略 | 動作 | topk | メトリクスの要件 |
|---|---|---|---|
max | エンティティについて返された要素スコアの最大値を保持します。 | 指定できません。 | サポートされている通常のベクトルメトリクスであれば使用できます。 |
sum | エンティティについて返されたすべての要素スコアを合計します。 | 指定できません。 | IP や COSINE など、正相関メトリクスのみ使用できます。 |
avg | エンティティについて返されたすべての要素スコアを平均します。 | 指定できません。 | サポートされている通常のベクトルメトリクスであれば使用できます。 |
topk_sum | エンティティについて返された要素スコアのうち上位 K 個を合計します。 | 必須です。正の値である必要があります。 | IP や COSINE など、正相関メトリクスのみ使用できます。 |
topk_avg | エンティティについて返された要素スコアのうち上位 K 個を平均します。 | 必須です。正の値である必要があります。 | サポートされている通常のベクトルメトリクスであれば使用できます。 |
集約では、その StructArray 要素レベルの AnnSearchRequest によって返された要素ヒットのみを使用します。ANN 検索後にエンティティ内のすべての Struct 要素をスキャンするわけではありません。集約に使用する要素を十分に確保できるよう、リクエストの limit を高く設定してください。
フィルター、範囲検索、グループ化を追加する
スカラー条件を、ベクトル検索に参加する同じ Struct 要素に適用する必要がある場合は、StructArray 要素レベルの AnnSearchRequest に element_filter を付加できます。また、親エンティティの条件には hybrid_search() のトップレベルの filter を使用できます。
StructArray の要素レベルのベクトルフィールドは、ハイブリッド検索での範囲検索をサポートしています。要素レベルの AnnSearchRequest に radius と、必要に応じて range_filter を追加します。EmbeddingList レベルの StructArray リクエストは範囲検索をサポートしていません。
要素レベルのハイブリッドグループ化は、すべての AnnSearchRequest オブジェクトが同じ StructArray フィールド内の要素レベルのベクトルフィールドを対象とする場合にのみサポートされ、group_by_field は主キーである必要があります。リクエストにコレクションレベルのベクトルフィールド、異なる StructArray フィールド、または EmbeddingList レベルのリクエストが混在する場合、ハイブリッドグループ化はサポートされません。範囲検索とグループ化を組み合わせないでください。
ハイブリッド検索結果を解釈する
| 最終候補スコープ | 結果キー | オフセットの動作 | 発生条件 |
|---|---|---|---|
| エンティティレベル | 主キーです。 | 最終結果には要素のオフセットが含まれません。 | ハイブリッドリクエストに、コレクションレベルのベクトルフィールド、EmbeddingList リクエスト、または異なる StructArray フィールド内の要素レベルリクエストが含まれる場合です。 |
| 要素レベル | 主キーと親 StructArray フィールドおよび要素オフセットです。 | API または SDK で公開されている場合、選択した要素のオフセットを返すことができます。 | すべての AnnSearchRequest オブジェクトが要素レベルで、同じ StructArray フィールド内にある場合です。 |
制限事項
-
element_scopeは、ハイブリッド検索でエンティティレベルの候補に集約する必要がある StructArray 要素レベルのAnnSearchRequestオブジェクトにのみ使用してください。 -
EmbeddingList リクエスト、コレクションレベルのベクトルリクエスト、または同じ StructArray 内の要素レベルハイブリッド検索には、
element_scopeを使用しないでください。 -
sumおよびtopk_sumの集約戦略では、IPやCOSINEなどの正相関メトリクスが必要です。L2と組み合わせて使用しないでください。 -
topk_sumおよびtopk_avgでは、正のtopk値が必要です。他の集約戦略ではtopkを含めないでください。 -
EmbeddingList レベルの StructArray リクエストは、範囲検索やグループ化をサポートしていません。
-
ハイブリッドグループ化は、同じ StructArray 内の要素レベルハイブリッド検索でのみ、かつ主キーによる場合にのみサポートされます。
-
範囲検索とグループ化を組み合わせないでください。
よくある間違い
-
同じ StructArray 内の要素レベルハイブリッドリクエストに
element_scopeを追加する。このリクエストは要素レベルのままであり、エンティティレベルの集約は行われません。 -
chunks[emb_list_vector]にelement_scopeを追加する。EmbeddingList 検索はすでにエンティティレベルです。 -
2つの StructArray フィールドが要素のオフセットを共有していると想定する。
chunksのオフセット3と別の StructArray フィールドのオフセット3は異なる要素であるため、ハイブリッドリクエストはエンティティレベルになります。 -
topk_sumをL2と組み合わせて使用する。負の距離メトリクスにはmax、avg、またはtopk_avgを使用してください。 -
集約後のエンティティレベルのハイブリッド検索結果に、選択した Struct 要素のオフセットが含まれることを期待する。
次のステップ
-
StructArray の2つの基本的なベクトル検索モードについては、StructArray を使用した基本的なベクトル検索 を参照してください。
-
ハイブリッド検索にスカラーフィルターを追加する方法については、StructArray を使用したフィルター付き検索 を参照してください。
-
ハイブリッド検索でスコアまたは距離の境界を使用する方法については、StructArray を使用した範囲検索 を参照してください。
-
要素レベルのハイブリッド検索結果を親エンティティでグループ化する方法については、StructArray を使用したグループ化検索 を参照してください。
-
StructArray 検索の制限を確認するには、StructArray の制限 を参照してください。