UpsertChunks API を使用して RAG 用のドキュメントチャンクをアップロード - AnalyticDB for PostgreSQL

ドキュメントをチャンクに分割し、ベクトル化されたチャンクをドキュメントコレクションにアップロードします。

操作説明

ドキュメントに使用されるベクトルアルゴリズムは、CreateDocumentCollection 操作を呼び出す際に指定します。

今すぐお試しください

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

create

*Document

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	クラスターの ID です。説明すべての AnalyticDB for PostgreSQL インスタンス（リージョン内）の情報を照会するには、DescribeDBInstances 操作を呼び出します。この操作では、インスタンス ID を含む情報が返されます。	gp-xxxxxxxxx
RegionId	string	必須	クラスターのリージョン ID です。	cn-hangzhou
NamespacePassword	string	必須	名前空間のパスワードです。説明このパラメーターの値は、CreateNamespace 操作を呼び出す際に指定します。	testpassword
Namespace	string	任意	名前空間の名称です。デフォルト値は public です。説明名前空間を作成するには CreateNamespace 操作を呼び出し、名前空間の一覧を照会するには ListNamespaces 操作を呼び出します。	mynamespace
Collection	string	必須	ドキュメントコレクションの名称です。説明ドキュメントコレクションを作成するには CreateDocumentCollection 操作を呼び出し、ドキュメントコレクションの一覧を照会するには ListDocumentCollections 操作を呼び出します。	document
FileName	string	任意	ドキュメントのファイル名です。説明空でないファイル名を指定した場合、ShouldReplaceFile パラメーターの値に基づいて、該当ファイル名に関連付けられたデータを上書きするかどうかが決定されます。このパラメーターを空のままにした場合、チャンクのデータはドキュメントコレクションに追加されます。	mydoc.txt
ShouldReplaceFile	boolean	任意	FileName パラメーターで指定されたファイル名に関連付けられたデータを上書きするかどうかを指定します。 ShouldReplaceFile を true に設定すると、該当ファイル名に関連付けられたすべてのデータが削除され、その後新しいデータが挿入されます。 ShouldReplaceFile を false に設定すると、該当ファイル名に関連付けられたデータは削除されず、TextChunks パラメーターに基づいてチャンクのデータが挿入または更新されます。デフォルト値は true です。	true
AllowInsertWithFilter	boolean	任意	TextChunks の Filter 入力に基づき、フィルターが指定されている場合のデータ挿入を許可するかどうかを制御します。 AllowInsertWithFilter = true の場合、フィルター条件に一致するデータが存在しないときに挿入操作が実行されます。 AllowInsertWithFilter = false の場合、フィルター条件に一致するデータが存在しないときは、何の操作も実行されません。デフォルト値は true です。	true
TextChunks	array<object>	任意	ドキュメントを分割した後のチャンクのリストです。
	array<object>	任意	単一のドキュメントオブジェクトです。
Filter	string	任意	更新対象データをフィルターするための条件です。WHERE 句と同様の形式で指定します。	title = 'seagull'
Content	string	必須	ドキュメントの内容です。	云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。
Metadata	object	任意	メタデータです。	{"title":"test"}
Id	string	任意	ベクトルデータの固有 ID です。	273e3fc7-8f56-4167-a1bb-d35d2f3b9043

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの固有 ID です。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	応答メッセージです。	Successful
Status	string	操作のステータスです。有効な値は以下のとおりです。 success fail	success
EmbeddingTokens	string	ベクトル化処理で消費されたトークン数です。説明トークンはテキストを分割する最小単位であり、単語、句、句読点、文字などのいずれかになります。	100
JobId	string	ジョブ ID です。`GetGraphRAGJob` を使用してジョブのステータスを確認できます。説明このパラメーターは、ナレッジベースが有効な場合のみ返されます。	231460f8-75dc-405e-a669-0c5204887e91

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "EmbeddingTokens": "100",
  "JobId": "231460f8-75dc-405e-a669-0c5204887e91"
}

エラーコード

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

変更履歴

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