範囲検索
Contact Sales to Enable BYOC

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

概要

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

Sewjwp5DShFgKAbC1Mwcrr7enOD

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

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

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

メトリックタイプ	表記	radiusとrange_filterの設定要件
`L2`	より小さいL2距離はより高い類似性を示します。	最も類似するベクトル埋め込みを無視するには、 `range_filter` <= distance < `radius`を確実に満たしてください
`IP`	より大きなIP距離はより高い類似性を示します。	最も類似するベクトル埋め込みを無視するには、 `radius` < distance <= `range_filter`を確実に満たしてください
`COSINE`	より大きなCOSINE距離はより高い類似性を示します。	最も類似するベクトル埋め込みを無視するには、 `radius` < distance <= `range_filter`を確実に満たしてください
`JACCARD`	より小さいJaccard距離はより高い類似性を示します。	最も類似するベクトル埋め込みを無視するには、 `range_filter` <= distance < `radius`を確実に満たしてください
`HAMMING`	より小さいHamming距離はより高い類似性を示します。	最も類似するベクトル埋め込みを無視するには、 `range_filter` <= distance < `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":[]}

概要​

例​

概要

例