OpenAPI は、AnalyticDB for PostgreSQL のベクトルに対するデータ定義言語 (DDL) およびデータ操作言語 (DML) 操作をカプセル化します。これにより、OpenAPI を使用してベクトルデータを管理できます。このトピックでは、Java ソフトウェア開発キット (SDK) の操作を呼び出して、ベクトルデータをインポートおよびクエリする方法について説明します。
前提条件
Resource Access Management (RAM) ユーザーを使用する場合、その RAM ユーザーに必要な権限が付与されている必要があります。詳細については、「Python SDK の例」をご参照ください。
操作手順
ベクトルデータベースの初期化
ベクトル検索を使用する前に、ナレッジベースデータベースとフルテキストインデックス機能を初期化する必要があります。
次の例は、API 操作を呼び出す方法を示しています:
InitVectorDatabaseRequest request = new InitVectorDatabaseRequest();
request.setDBInstanceId("gp-bp1c62r3l489****");
request.setManagerAccount("myaccount");
request.setManagerAccountPassword("myaccount_password");
request.setRegionId("ap-southeast-1");
InitVectorDatabaseResponse response = client.getAcsResponse(request);
System.out.println(new Gson().toJson(response));パラメーターの詳細については、「InitVectorDatabase - ベクトルデータベースの初期化」をご参照ください。
名前空間の作成
名前空間はスキーマの隔離に使用されます。ベクトルを使用する前に、少なくとも 1 つの名前空間を作成するか、パブリック名前空間を使用する必要があります。
次の例は、API 操作を呼び出す方法を示しています:
CreateNamespaceRequest request = new CreateNamespaceRequest();
request.setDBInstanceId("gp-bp1c62r3l489****");
request.setManagerAccount("myaccount");
request.setManagerAccountPassword("myaccount_password");
request.setNamespace("vector_test");
request.setNamespacePassword("vector_test_password");
request.setRegionId("ap-southeast-1");
CreateNamespaceResponse response = client.getAcsResponse(request);
System.out.println(new Gson().toJson(response));パラメーターの詳細については、「CreateNamespace - 名前空間の作成」をご参照ください。
名前空間が作成された後、インスタンスのナレッジベースデータベースで対応するスキーマを表示できます。
SELECT schema_name FROM information_schema.schemata;コレクションの作成
コレクションはベクトルデータを格納し、名前空間によって隔離されます。
次の例は、呼び出しのサンプルを示しています:
Map<String,String> metadata = new HashMap<>();
metadata.put("title", "text");
metadata.put("link", "text");
metadata.put("content", "text");
metadata.put("pv", "int");
List<String> fullTextRetrievalFields = Arrays.asList("title", "content");
CreateCollectionRequest request = new CreateCollectionRequest();
request.setDBInstanceId("gp-bp1c62r3l489****");
request.setManagerAccount("myaccount");
request.setManagerAccountPassword("myaccount_password");
request.setNamespace("vector_test");
request.setCollection("document");
request.setDimension(10L);
request.setFullTextRetrievalFields(StringUtils.join(fullTextRetrievalFields, ","));
request.setMetadata(new Gson().toJson(metadata));
request.setParser("zh_cn");
request.setRegionId("ap-southeast-1");
CreateCollectionResponse response = client.getAcsResponse(request);
System.out.println(new Gson().toJson(response));パラメーターの詳細については、「CreateCollection - ベクトルデータセットの作成」をご参照ください。
コレクションが作成された後、インスタンスのナレッジベースデータベースで対応するテーブルを表示できます。
SELECT tablename FROM pg_tables WHERE schemaname='vector_test';ベクトルデータのアップロード
準備した埋め込みベクトルデータを対応するコレクションにアップロードします。
次の例は、API 操作を呼び出す方法を示しています:
UpsertCollectionDataRequest request = new UpsertCollectionDataRequest();
request.setDBInstanceId("gp-bp1c62r3l489****");
request.setCollection("document");
request.setNamespace("vector_test");
request.setNamespacePassword("vector_test_password");
request.setRegionId("ap-southeast-1");
List<UpsertCollectionDataRequest.UpsertCollectionDataRequestRows> rows = new ArrayList<>();
UpsertCollectionDataRequest.UpsertCollectionDataRequestRows row = new UpsertCollectionDataRequest.UpsertCollectionDataRequestRows();
row.setId("0CB55798-ECF5-4064-B81E-FE35B19E01A6");
row.setVector(Arrays.asList(0.2894745251078251,0.5364747050266715,0.1276845661831275,0.22528871956822372,0.7009319238651552,0.40267406135256123,0.8873626696379067,0.1248525955774931,0.9115507046412368,0.2450859133174706));
Map<String, String> rowsMetadata = new HashMap<>();
rowsMetadata.put("title", "Test document");
rowsMetadata.put("content","Test content");
rowsMetadata.put("link","http://127.0.0.1/document1");
rowsMetadata.put("pv","1000");
row.setMetadata(rowsMetadata);
rows.add(row);
request.setRows(rows);
UpsertCollectionDataResponse response = client.getAcsResponse(request);
System.out.println(new Gson().toJson(response));パラメーターの詳細については、「UpsertCollectionData - ベクトルデータのアップロード」をご参照ください。
アップロードが完了した後、インスタンスのナレッジベースデータベースでデータを表示できます。
SELECT * FROM vector_test.document;ベクトルデータの取得
クエリベクトルまたはフルテキストインデックスフィールドを準備し、クエリ API 操作を呼び出します。
次の例は、API 操作を呼び出す方法を示しています:
QueryCollectionDataRequest request = new QueryCollectionDataRequest();
request.setDBInstanceId("gp-bp1c62r3l489****");
request.setCollection("document");
request.setNamespace("vector_test");
request.setNamespacePassword("vector_test_password");
request.setContent("Test");
request.setFilter("pv > 10");
request.setTopK(10L);
request.setVector(Arrays.asList(0.7152607422256894,0.5524872066437732,0.1168505269851303,0.704130971473022,0.4118874999967596,0.2451574619214022,0.18193414783144812,0.3050522957905741,0.24846180714868163,0.0549715380856951));
request.setRegionId("ap-southeast-1");
QueryCollectionDataResponse response = client.getAcsResponse(request);
System.out.println(new Gson().toJson(response));次の結果が返されます:
{
"Matches": {
"match": [
{
"Id": "0CB55798-ECF5-4064-B81E-FE35B19E01A6",
"Metadata": {
"title":"Test document",
"content":"Test content",
"link":"http://127.0.0.1/document1",
"pv":"1000"
},
"Values": [
0.2894745251078251,
0.5364747050266715,
0.1276845661831275,
0.22528871956822372,
0.7009319238651552,
0.40267406135256123,
0.8873626696379067,
0.1248525955774931,
0.9115507046412368,
0.2450859133174706
]
}
]
},
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Status": "success"
}