UpsertCollectionData を使用してベクトルデータをアップロード - AnalyticDB

ベクトルデータをベクトルコレクションにアップロードします。

操作説明

重要

SDK が 2023 年 11 月 8 日にアップグレードされ、最大リクエストサイズが 512 KB から 10 MB に拡大されました。 最新版 SDK、またはそれ以降のバージョンをご使用ください：

Java：1.2.1
Go：v3.3.1
Python：3.3.1

今すぐお試しください

この 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:UpsertCollectionData

create

*Collection

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	任意	インスタンス ID。説明 DescribeDBInstances 操作を呼び出して、リージョン内のすべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）に関する情報を照会できます。	gp-bp152460513z****
Collection	string	必須	コレクションの名前。	document
Namespace	string	任意	名前空間の名前。デフォルト値：public。説明 CreateNamespace 操作を呼び出して名前空間を作成し、ListNamespaces 操作を呼び出して名前空間の一覧を照会できます。	mynamespace
NamespacePassword	string	必須	名前空間のパスワード。	testpassword
Rows	array<object>	任意	アップロードするベクトルデータ。
	array<object>	任意	アップロードするベクトルデータ。
Id	string	任意	ベクトルデータの一意の ID。説明このパラメーターを空欄のままにした場合、uuidgen を使用して自動的に一意の ID が生成されます。既存の ID と同じ値を指定した場合は、更新されたベクトルデータ ID が使用されます。	854c6949-411c-4b47-aec4-e324735f9574
Metadata	object	任意	ベクトルデータのメタデータ。このパラメーターのキー項目は、CreateCollection 操作呼び出し時に指定した Metadata のキー項目と一致している必要があります。
	string	任意	ベクトルデータのメタデータ。	{"title":"test title", "content": "test content"}
Vector	array	必須	ベクトルデータ。ベクトルデータの長さは、CreateCollection 操作呼び出し時に指定した Dimension の値と一致している必要があります。
	number	任意	ベクトルデータ。	[1.0123,-0.1234]
SparseVector	object	任意	疎ベクトルデータ。
Indices	array	任意	インデックス。説明インデックスのサイズは 4000 を超えることはできません。
	integer	任意	インデックス値。	1
Values	array	任意	疎ベクトルの値。
	number	任意	疎ベクトルの値。	1.2345
RegionId	string	必須	インスタンスのリージョン ID。説明 DescribeRegions 操作を呼び出して、最新のリージョン一覧を照会できます。	cn-hangzhou
WorkspaceId	string	任意	複数の AnalyticDB for PostgreSQL インスタンスで構成されるワークスペースの ID。WorkspaceId または DBInstanceId のいずれか一方を指定する必要があります。両方を指定した場合は、WorkspaceId が優先されます。	gp-ws-*****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返されたメッセージ。	success
Status	string	リクエストが成功したかどうかを示します。有効な値： success fail	success

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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