CreateCollection API を使用してベクトルコレクションを作成 - AnalyticDB - Alibaba Cloud - AnalyticDB

ベクトルデータセットを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:CreateCollection

create

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	任意	インスタンス ID です。説明特定のリージョンにあるすべての AnalyticDB for PostgreSQL インスタンスの ID を照会するには、DescribeDBInstances オペレーションを呼び出します。	gp-bp152460513z****
ManagerAccount	string	必須	`rds_superuser` 権限を持つ管理アカウントの名前です。説明アカウントを作成するには、CreateAccount オペレーションを呼び出します。	testaccount
ManagerAccountPassword	string	必須	管理アカウントのパスワードです。	testpassword
Namespace	string	任意	名前空間です。説明名前空間を作成するには CreateNamespace オペレーションを、既存の名前空間を一覧表示するには ListNamespaces オペレーションを呼び出します。	mynamespace
Collection	string	必須	作成するコレクションの名前です。説明名前は PostgreSQL のオブジェクト命名規則に準拠する必要があります。	document
Dimension	integer	任意	ベクトルディメンションです。説明このパラメーターを指定すると、ベクターインデックスが作成されます。その後の UpsertCollectionData オペレーションの呼び出しでは、`Rows.Vector` の長さがこのディメンションと一致する必要があります。このパラメーターを指定しない場合は、後で CreateVectorIndex オペレーションを呼び出してインデックスを作成する必要があります。	1024
FullTextRetrievalFields	string	任意	全文検索に使用するフィールドです。複数のフィールド名はコンマ (`,`) で区切ります。これらのフィールドは、`Metadata` パラメーターで定義されたキーである必要があります。	title,content
Metadata	string	必須	メタデータスキーマをマップとして定義する JSON 文字列です。キーはフィールド名、値は対応するデータ型です。説明サポートされるデータ型サポートされるデータ型のリストについては、「データ型」をご参照ください。 `money` データ型はサポートされていません。警告フィールド名 `id`、`vector`、`to_tsvector`、`source` は予約済みであり、使用できません。	{"title":"text","content":"text","response":"int"}
Parser	string	任意	全文検索用のパーサです。デフォルトは `zh_cn` です。	zh_cn
RegionId	string	必須	インスタンスが配置されているリージョンの ID です。	cn-hangzhou
Metrics	string	任意	ベクターインデックスの構築に使用される距離メトリックです。有効な値： `l2`：ユークリッド距離。 `ip`：内積。 `cosine`：コサイン類似度。	cosine
HnswM	integer	任意	HNSW アルゴリズムの最大近傍数です。通常、このパラメーターを設定する必要はありません。システムがベクトルディメンションに基づいて値を自動的に決定するためです。説明有効値： AnalyticDB for PostgreSQL V6.0 インスタンスの場合：1～1000。 AnalyticDB for PostgreSQL V7.0 インスタンスの場合：2～100。デフォルト値は 16 です。説明このパラメーターは、ベクトルディメンションに基づいて設定することを推奨します： 384 以下のディメンションの場合は 16。 384 より大きく 768 以下のディメンションの場合は 32。 768 より大きく 1024 以下のディメンションの場合は 64。 1024 より大きいディメンションの場合は 128。	64
HnswEfConstruction	string	任意	HNSW インデックス構築のための候補セットのサイズです。値は `2 * HnswM` 以上である必要があります。説明有効値： AnalyticDB for PostgreSQL V6.0 インスタンスの場合：40～4000。 AnalyticDB for PostgreSQL V7.0 インスタンスの場合：4～1000。デフォルト値は 64 です。	128
PqEnable	integer	任意	インデックス高速化のために Product Quantization (PQ) を有効にするかどうかを指定します。500,000 を超えるエントリを持つデータセットに推奨されます。有効な値： `0`：無効。 `1`：(デフォルト) 有効。	1
ExternalStorage	integer	任意	`mmap` を使用して HNSW インデックスを構築するかどうかを指定します。デフォルト値は 0 です。データの削除が不要で、高パフォーマンスのデータインジェストが必要な場合は、この値を 1 に設定することを推奨します。有効な値： `0`：(デフォルト) セグメント化されたページストレージを使用してインデックスを構築します。このモードでは、PostgreSQL の `shared_buffer` をキャッシュに使用でき、`DELETE` および `UPDATE` 操作をサポートします。 `1`：`mmap` を使用してインデックスを構築します。このモードでは、`DELETE` または `UPDATE` 操作はサポートされません。重要 `ExternalStorage` パラメーターは AnalyticDB for PostgreSQL v6.0 インスタンスでのみ利用可能で、v7.0 ではサポートされていません。	0
WorkspaceId	string	任意	複数のデータベースインスタンスを含むワークスペースの ID です。`WorkspaceId` または `DBInstanceId` のいずれかを指定する必要があります。両方が指定された場合、`WorkspaceId` が優先されます。	gp-ws-*****
MetadataIndices	string	任意	スカラーインデックスフィールドです。複数のフィールドはコンマ (`,`) で区切ります。フィールドは `Metadata` で定義されたキーである必要があります。	title
SupportSparse	boolean	任意	疎ベクトルのサポートを有効にするかどうかを指定します。デフォルト値は `false` です。	true
SparseVectorIndexConfig	object	任意	疎ベクターインデックスの構成です。指定した場合、疎ベクターインデックスが作成されます。
HnswM	integer	任意	HNSW アルゴリズムの最大近傍数です。通常、このパラメーターを設定する必要はありません。システムがベクトルディメンションに基づいて値を自動的に決定するためです。説明有効値： AnalyticDB for PostgreSQL V6.0 インスタンスの場合：1～1000。 AnalyticDB for PostgreSQL V7.0 インスタンスの場合：2～100。デフォルト値は 16 です。説明このパラメーターは、ベクトルディメンションに基づいて設定することを推奨します： 384 以下のディメンションの場合は 16。 384 より大きく 768 以下のディメンションの場合は 32。 768 より大きく 1024 以下のディメンションの場合は 64。 1024 より大きいディメンションの場合は 128。	64
HnswEfConstruction	integer	任意	HNSW インデックス構築のための候補セットのサイズです。値は 4 から 1,000 までの整数である必要があります。デフォルトは 64 です。説明このパラメーターは AnalyticDB for PostgreSQL V7.0 インスタンスでのみ必須であり、その値は `2 * HnswM` 以上である必要があります。	128
Algorithm	string	任意	ベクターインデックスアルゴリズムです。有効な値： `hnswflat`：(デフォルト) 量子化圧縮なしの HNSW インデックス。 `novam`：量子化圧縮なしのグラフインデックス。このアルゴリズムは、リアルタイム推奨などの高パフォーマンスシナリオに適しています。	hnswflat
VectorIndexConfig	object	任意	密ベクターインデックスの構成です。
Nlist	integer	任意	`novad` インデックスのリスト (パーティション) の数です。値は 2 から 1,073,741,824 までの整数である必要があります。デフォルトは 256 です。	256
RabitqBits	integer	任意	`rabitq` 圧縮のビット数です。値は 1 から 8 までの整数である必要があります。デフォルトは 3 です。	3
Algorithm	string	任意	ベクターインデックスアルゴリズムです。有効な値： `hnswflat`：(デフォルト) 量子化圧縮なしの HNSW インデックス。 `novam`：量子化圧縮なしのグラフインデックス。このアルゴリズムは、リアルタイム推奨などの高パフォーマンスシナリオに適しています。 `novad`：`rabitq` 量子化を使用したパーティション分割インデックス。このアルゴリズムは、大規模で低コストの検索シナリオに適しています。	hnswflat

説明

コレクションを作成した後、DescribeCollection を使用して表示します。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	応答メッセージです。	create successfully
Status	string	操作のステータスです。有効な値： success：操作は成功しました。 fail：操作は失敗しました。	success

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "create successfully",
  "Status": "success"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。