OpenSearch:ベクターベースのクエリ

説明

OpenSearch Vector Search Edition インスタンスにベクトルデータをインポートし、そのインスタンスを使用してベクターベースのクエリを実行できます。

注: データをベクトルに変換するためのベクトルモデルがない場合は、OpenSearch Vector Search Edition の 画像のベクトル化 および テキストのベクトル化 機能を使用し、組み込みのベクトルモデルを使用してデータをベクトルに変換できます。その後、予測ベースのクエリ を実行できます。

URL

/vector-service/query

• サンプル URL では、リクエストヘッダーやエンコーディングメソッドなどの情報は省略されています。

• サンプル URL では、OpenSearch アプリケーションへの接続に使用するエンドポイントも省略されています。

• 上記の URL に連結されているすべてのリクエストパラメーターの定義、使用方法、および値の例については、このトピックの「リクエストパラメーター」セクションをご参照ください。

プロトコル

HTTP

リクエストメソッド

POST

サポートされている形式

JSON

リクエスト署名

次の表のフィールドを使用して、リクエスト署名を計算できます。 リクエスト署名は 承認 ヘッダーに格納されます。

import com.aliyun.darabonba.encode.Encoder;
import com.aliyun.darabonbastring.Client;

public class GenerateAuthorization {

 public static void main(String[] args) throws Exception {
 String accessUserName = "username";
 String accessPassWord = "password";
 String realmStr = "" + accessUserName + ":" + accessPassWord + "";
 String authorization = Encoder.base64EncodeToString(Client.toBytes(realmStr, "UTF-8"));
 System.out.println(authorization);
		}
}

[authorization] ヘッダーの値の有効な形式:

cm9vdDp******mdhbA==

HTTP リクエストで [authorization] ヘッダーを指定する場合は、Basic プレフィックスを追加します。

例:

authorization: Basic cm9vdDp******mdhbA==

リクエストパラメーター

ソート:

単一ベクトルを使用したクエリ

{
    "tableName": "gist",
    "vector": [
        0.1,
        0.2,
        0.3
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true
}

名前空間ベースのクエリ

OpenSearch Vector Search Edition では、名前空間を使用してインデックスをパーティション分割できます。ベクトルインデックスに名前空間を設定した後、名前空間を指定してデータをクエリできます。このようにして、異なるクエリリクエストを送信することで、インデックスの異なるサブセットをクエリできます。

注: ベクトルインデックスに名前空間を設定する場合は、データをクエリするときに名前空間を指定する必要があります。

{
    "tableName": "gist",
    "namespace": "space_b",
    "vector": [
        0.1,
        0.2
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true
}

複数の名前空間を使用したクエリ

ベクトルインデックスに名前空間を設定する場合は、複数の名前空間のデータをクエリできます。

{
    "tableName": "gist",
    "queries": [
        {
            "vector": [
                0.1,
                0.2,
                0.3
            ],
            "namespace": "space_a"
        },
        {
            "vector": [
                0.4,
                0.5,
                0.6
            ],
            "namespace": "space_b"
        }
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true
}

フィルター条件を使用したクエリ

フィルター式 を使用して、データクエリのフィルター条件を指定できます。

{
    "tableName": "gist",
    "vector": [
        0.1,
        0.2
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "filter": "a > 10",
    "includeVector": true,
    "outputFields": [
        "a",
        "b"
    ]
}

複数ベクトルを使用したクエリ

複数のベクトルを同時にクエリできます。OpenSearch はすべてのベクトルの結果をマージしてソートし、上位 K 件の結果を返します。次のサンプルコードは、2 つの2次元ベクトルを同時にクエリする方法の例を示しています。

{
    "tableName": "gist",
    "vector": [
        0.1,
        0.2,
        0.3,
        0.4
    ],
    "vectorCount": 2,
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true,
    "outputFields": [
        "a",
        "b"
    ]
}

レスポンスパラメーター

Item

例:

{
    "result": [
        {
            "id": 1,
            "score": 1.0508723258972169,
            "vector": [
                0.1,
                0.2,
                0.3
            ]
        },
        {
            "id": 2,
            "score": 1.0329746007919312,
            "vector": [
                0.2,
                0.2,
                0.3
            ]
        },
        {
            "id": 3,
            "score": 0.980593204498291,
            "vector": [
                0.3,
                0.2,
                0.3
            ]
        }
    ],
    "totalCount": 3,
    "totalTime": 2.943
}