Skip to main content
資料連線（原應用程式資料）

AddFilesFromAuthorizedOss

將已授權 OSS Bucket 中的檔案匯入阿里雲百煉應用資料中。

介面說明

  • 請確保該 OSS Bucket 與阿里雲百煉同屬一個阿里雲帳號（主帳號），並已按從 OSS 匯入資料設定說明完成授權。
    • 支援的 Bucket 儲存類型不包括歸檔、冷歸檔或深度冷歸檔。支援內容加密的 Bucket。支援公共讀寫/公共讀/私有的 Bucket。
    • 如需使用開啟 Referer 防盜鏈的 Bucket，須參考僅允許受信任的網站存取將網域 *.console.alibabacloud.com 新增至白名單 Referer 中。
  • RAM 使用者（子帳號）需要首先取得阿里雲百煉的 API 權限（需要 AliyunBailianDataFullAccess，已包括 sfm:AddFilesFromAuthorizedOss 權限點）並加入一個業務空間方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。
  • 本介面不具有冪等性。
限流說明： 本介面頻繁呼叫會被限流，頻率請勿超過 5 次/秒。如遇限流，請稍後重試。

調試

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

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：
  • 操作：是指具體的許可權點。
  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：
    • 對於必選的資源類型，用前面加 * 表示。
    • 對於不支援資源級授權的操作，用全部資源表示。
  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。
  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:AddFilesFromAuthorizedOss

create

*All Resource

*

無無

請求文法 

POST /{WorkspaceId}/datacenter/file/fromoss HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

WorkspaceId

string

是

業務空間 ID，將檔案匯入至該業務空間。取得方式請參見如何使用業務空間。

llm-3z7uw7fwz0vxxxx

請求參數

名稱

類型

必填

描述

樣本值

CategoryId

string

是

用於指定檔案匯入目標類目。即 AddCategory 介面返回的 CategoryId。您也可以在應用資料-檔案頁籤，按一下類目名稱旁的 ID 圖示取得類目 ID。此處允許傳入 default，即使用系統建立的「預設類目」。

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

CategoryType

string

是

類目類型，可選，預設值為 UNSTRUCTURED，取值範圍：

  • UNSTRUCTURED：類目，用於建構知識庫場景。

枚舉值：

  • UNSTRUCTURED :

    UNSTRUCTURED

UNSTRUCTURED

OssRegionId

string

是

OSS Bucket 的地域 ID。取得方式請參見 OSS 地域和存取網域。

cn-beijing

OssBucketName

string

是

OSS Bucket 名稱，詳見儲存空間。

bucketNamexxxxx

FileDetails

array<object>

是

匯入檔案清單。一次最多可上傳 10 個檔案。

一次最多可上傳 10 個檔案。

array<object>

是

檔案物件。

FileName

string

是

匯入檔案的名稱，注意副檔名需要帶上檔案格式類型。

  • 支援格式：pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。

  • 檔案名稱長度限制 4-128 個字元。

  • 對檔案上傳要求限制，請參見知識庫配額與限制。

當匯入的檔案名稱與知識庫中已有檔案名稱重複時，介面仍會返回 Status 為 SUCCESS，但該檔案實際不會被匯入知識庫，已有的同名檔案保持不變。請確保每次匯入的檔案名稱唯一。

如需新增資料表並上傳資料，請使用阿里雲百煉主控台，API 不支援。

this_is_temp_xxxx.pdf

OssKey

string

是

匯入檔案在 OSS Bucket 中的鍵名（Key），詳見物件命名。

root/path/this_is_temp_xxxx.pdf

Parser

string

否

解析器類型。可能取值範圍包括：

  • DOCMIND（智慧文件解析）

  • DOCMIND_DIGITAL（電子文件解析）

  • DOCMIND_LLM_VERSION（大模型文件解析）

  • DASH_QWEN_VL_PARSER（Qwen VL 解析）

  • DOCMIND_LLM_VERSION_MEDIA（影音解析）

  • AUTO_SELECT（自動選擇解析器）

會以目前設定的解析器對您上傳的檔案進行解析，若輸入 AUTO_SELECT 則會使用所屬類目設定的解析器。

AUTO_SELECT

ParserConfig

object

否

解析器設定，僅當類型被設定為 Qwen VL 解析時才需要傳入。

ModelName

string

否

模型名稱。

qwen-vl-max

ModelPrompt

string

否

呼叫 Qwen VL 解析時的 Prompt。

#角色 你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片，详细描述图片中的内容。

Tags

array

否

檔案關聯的標籤清單。預設值為空，即檔案不關聯任何標籤。最多傳入 10 個標籤。

string

否

檔案的標籤。每個標籤最多 12 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等），底線 _，連字號 -。

产品介绍

OverWriteFileByOssKey

boolean

否

是否按照 OssKey 覆蓋類目中的相同檔案，預設值為 false，即不覆蓋。

false

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

Code

string

錯誤狀態碼。

success

Data

object

介面業務資料欄位。

AddFileResultList

array<object>

檔案匯入結果清單。

object

檔案匯入結果清單。

FileId

string

檔案 ID，請妥善保管該值，它將用於後續與此檔案相關的所有 API 操作。

file_809f469a59ac449586ec692576xxxxx_102248XXX

OssKey

string

匯入檔案在 OSS Bucket 中的鍵名（Key）。

root/path/this_is_temp_xxxx.pdf

Status

string

檔案匯入狀態。狀態可能值為：

  • SUCCESS：匯入（應用資料）完成。

  • FAILED：匯入（應用資料）失敗。

狀態為 SUCCESS 的檔案才能用於建立/更新知識庫。

SUCCESS

Msg

string

檔案匯入失敗時回傳錯誤資訊。

size too large

Message

string

錯誤資訊。

Cant find out category for category_id param.

RequestId

string

請求 ID。

17204B98-xxxx-4F9A-8464-2446A84821CA

Status

string

介面返回的狀態碼。

200

Success

string

介面呼叫是否成功，可能值為：

  • true：成功 。

  • false：失敗。

true

樣本

正常返回樣本 JSON格式 
{
  "Code": "success",
  "Data": {
    "AddFileResultList": [
      {
        "FileId": "file_809f469a59ac449586ec692576xxxxx_102248XXX",
        "OssKey": "root/path/this_is_temp_xxxx.pdf",
        "Status": "SUCCESS",
        "Msg": "size too large"
      }
    ]
  },
  "Message": "Cant find out category for category_id param.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": "true"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。
應用調用
應用組件
Assistant API（下線中）
更多