レンジ検索

レンジ検索は、返されるエンティティの距離またはスコアを特定の範囲内に制限することで、検索結果の関連性を向上させます。このページでは、レンジ検索とは何か、およびレンジ検索を実行する手順について説明します。

概要

レンジ検索リクエストを実行すると、Zilliz CloudはANN検索結果からクエリベクトルに最も類似したベクトルを中央として使用し、検索リクエストで指定されたradiusを外円の半径として、range_filterを内円の半径として2つの同心円を描画します。これら2つの同心円によって形成される環状領域内に類似度スコアが収まるすべてのベクトルが返されます。ここで、range_filterは0に設定でき、指定された類似度スコア（radius）内のすべてのエンティティが返されることを示します。

Sewjwp5DShFgKAbC1Mwcrr7enOD

上記の図は、レンジ検索リクエストがradiusとrange_filterの2つのパラメータを持つことを示しています。レンジ検索リクエストを受信すると、Zilliz Cloudは次のことを行います。

指定されたメトリックタイプ（COSINE）を使用して、クエリベクトルに最も類似したすべてのベクトル埋め込みを検索します。
クエリベクトルに対する距離またはスコアがradiusとrange_filterパラメータで指定された範囲内に収まるベクトル埋め込みをフィルタリングします。
フィルタリングされたエンティティから上位K個のエンティティを返します。

radiusとrange_filterの設定方法は、検索のメトリックタイプによって異なります。次の表は、異なるメトリックタイプでこれら2つのパラメータを設定するための要件を示しています。

メトリックタイプ	表記	radiusとrange_filterの設定要件
`L2`	L2距離が小さいほど類似度が高いことを示します。	最も類似したベクトル埋め込みを無視するには、以下を確認してください。 `range_filter` <= 距離 < `radius`
`IP`	IP距離が大きいほど類似度が高いことを示します。	最も類似したベクトル埋め込みを無視するには、以下を確認してください。 `radius` < 距離 <= `range_filter`
`COSINE`	COSINE距離が大きいほど類似度が高いことを示します。	最も類似したベクトル埋め込みを無視するには、以下を確認してください。 `radius` < 距離 <= `range_filter`
`JACCARD`	Jaccard距離が小さいほど類似度が高いことを示します。	最も類似したベクトル埋め込みを無視するには、以下を確認してください。 `range_filter` <= 距離 < `radius`
`HAMMING`	ハミング距離が小さいほど類似度が高いことを示します。	最も類似したベクトル埋め込みを無視するには、以下を確認してください。 `range_filter` <= 距離 < `radius`

例

このセクションでは、レンジ検索を実行する方法を示します。以下のコードスニペットの検索リクエストにはメトリックタイプが含まれていないため、デフォルトのメトリックタイプCOSINEが適用されます。この場合、radiusの値がrange_filterの値よりも小さいことを確認してください。

以下のコードスニペットでは、radiusを0.4に、range_filterを0.6に設定し、Zilliz Cloudがクエリベクトルに対する距離またはスコアが0.4から0.6の範囲内にあるすべてのエンティティを返すようにします。

Python
Java
Go
NodeJS
cURL

from pymilvus import MilvusClient

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

query_vector = [0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592]

res = client.search(
    collection_name="my_collection",
    data=[query_vector],
    limit=3,
    search_params={
        "params": {
            "radius": 0.4,
            "range_filter": 0.6
        }
    }
)

for hits in res:
    print("TopK results:")
    for hit in hits:
        print(hit)

import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
 io.milvus.v2.service.vector.request.SearchReq
import io.milvus.v2.service.vector.request.data.FloatVec;
import io.milvus.v2.service.vector.response.SearchResp

MilvusClientV2 client = new MilvusClientV2(ConnectConfig.builder()
        .uri("YOUR_CLUSTER_ENDPOINT")
        .token("YOUR_CLUSTER_TOKEN")
        .build());

FloatVec queryVector = new FloatVec(new float[]{0.3580376395471989f, -0.6023495712049978f, 0.18414012509913835f, -0.26286205330961354f, 0.9029438446296592f});
Map<String,Object> extraParams = new HashMap<>();
extraParams.put("radius", 0.4);
extraParams.put("range_filter", 0.6);
SearchReq searchReq = SearchReq.builder()
        .collectionName("my_collection")
        .data(Collections.singletonList(queryVector))
        .topK(5)
        .searchParams(extraParams)
        .build();

SearchResp searchResp = client.search(searchReq);

List<List<SearchResp.SearchResult>> searchResults = searchResp.getSearchResults();
for (List<SearchResp.SearchResult> results : searchResults) {
    System.out.println("TopK results:");
    for (SearchResp.SearchResult result : results) {
        System.out.println(result);
    }
}

// Output
// TopK results:
// SearchResp.SearchResult(entity={}, score=0.5975797, id=4)
// SearchResp.SearchResult(entity={}, score=0.46704385, id=5)

import (
    "context"
    "fmt"
    
    "github.com/milvus-io/milvus/client/v2/index"
    "github.com/milvus-io/milvus/client/v2/entity"
    "github.com/milvus-io/milvus/client/v2/milvusclient"
)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

milvusAddr := "YOUR_CLUSTER_ENDPOINT"
client, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: milvusAddr,
})
if err != nil {
    fmt.Println(err.Error())
    // handle error
}
defer client.Close(ctx)

queryVector := []float32{0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592}

annParam := index.NewCustomAnnParam()
annParam.WithRadius(0.4)
annParam.WithRangeFilter(0.6)
resultSets, err := client.Search(ctx, milvusclient.NewSearchOption(
    "my_collection", // collectionName
    5,               // limit
    []entity.Vector{entity.FloatVector(queryVector)},
).WithConsistencyLevel(entity.ClStrong).
    WithANNSField("vector").
    WithAnnParam(annParam))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

for _, resultSet := range resultSets {
    fmt.Println("IDs: ", resultSet.IDs.FieldData().GetScalars())
    fmt.Println("Scores: ", resultSet.Scores)
}

import { MilvusClient, DataType } from "@zilliz/milvus2-sdk-node";

const address = "YOUR_CLUSTER_ENDPOINT";
const token = "YOUR_CLUSTER_TOKEN";
const client = new MilvusClient({address, token});

var query_vector = [0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592]

res = await client.search({
    collection_name: "my_collection",
    data: [query_vector],
    limit: 5,
    params: {
        "radius": 0.4,
        "range_filter": 0.6
    }
})

export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
export TOKEN="YOUR_CLUSTER_TOKEN"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "my_collection",
    "data": [
        [0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592]
    ],
    "annsField": "vector",
    "limit": 5,
    "searchParams": {
        "params": {
            "radius": 0.4,
            "range_filter": 0.6
        }
    }
}'
# {"code":0,"cost":0,"data":[]}

📘Notes

クエリベクトルがターゲットコレクションにすでに存在する場合は、検索前に取得する代わりにidsを使用することを検討してください。詳細については、主キー検索を参照してください。

概要​

例​

概要

例