使用UpsertChunks上傳切分後的文檔到文件庫-雲原生資料倉儲AnalyticDB-阿里雲

將切分後的文檔列表向量化並上傳到文件庫。

介面說明

文檔的向量化演算法為建立知識庫 CreateDocumentCollection 介面指定的演算法。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:UpsertChunks

create

*Document

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 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 的取值，決定是否覆蓋上傳此檔案名稱對應的資料；為空白時，則直接將 chunks 資料追加上傳到文件庫中。	mydoc.txt
ShouldReplaceFile	boolean	否	在指定 FileName 入參的基礎上，該入參控制是否覆蓋上傳此檔案名稱對應的資料。如果 ShouldReplaceFile = true，則會在刪除該檔案名稱對應的所有資料後，再插入新資料。如果 ShouldReplaceFile = false，則不會在刪除該檔案名稱對應的資料，而是根據具體的 TextChunks 入參，決定 chunk 的插入和更新。該參數預設值為 true。	true
AllowInsertWithFilter	boolean	否	在指定 TextChunks 下 Filter 入參的基礎上，該入參控制是否支援在指定 Filter 參數的情況下插入資料。如果 AllowInsertWithFilter = true，則當 Filter 未匹配到任何資料時，會執行插入操作如果 AllowInsertWithFilter = false，則當 Filter 未匹配到任何資料時，不會執行任何操作該參數預設值為 true。	true
TextChunks	array<object>	否	切分後的文檔列表。
	array<object>	否	單個文檔對象。
Filter	string	否	要更新的資料的過濾條件，格式為 SQL 的 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	API 執行狀態，取值說明： success：執行成功。 fail：執行失敗。	success
EmbeddingTokens	string	向量化時使用的 token 數。說明 token 是指將輸入的文本分割成的最小單位。token 可以是一個單詞、一個片語、一個標點符號、一個字元等。	100
JobId	string	任務 ID，用於後續使用`GetGraphRAGJob`查看任務狀態。說明僅當知識庫開啟構建知識圖譜時返回該參數。	231460f8-75dc-405e-a669-0c5204887e91

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。