[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

範囲検索

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

概要

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

上記の図は、範囲検索リクエストが2つのパラメータ：radiusとrange_filterを含むことを示しています。Zilliz Cloudが範囲検索リクエストを受信すると、以下のことを行います：

• 指定されたメトリックタイプ（COSINE）を使用して、クエリベクトルに最も類似するすべてのベクトル埋め込みを見つけます。

• クエリベクトルからの距離またはスコアがradiusおよびrange_filterパラメータで指定された範囲内にあるベクトル埋め込みをフィルタリングします。

• フィルタリングされた中からtop-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	Hamming距離が小さいほど類似度が高い。	最も類似するベクトル埋め込みを無視するには、 range_filter <= 距離 < radius となるようにしてください

例

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

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

Python

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)

Java

import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
 import 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)

Go

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)
}

NodeJS

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
    }
})

cURL

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":[]}