全部產品
Search
文件中心

:AddCategory - 新增類目

更新時間:Oct 13, 2025

在指定的業務空間中建立一個類目,用於分類和管理文檔。每個業務空間最多建立500個類目。

介面說明

  • 不支援通過 API 建立結構化資料表,請通過控制台的應用資料操作。您可以將知識庫與雲資料庫 RDS 關聯,以實現結構化知識庫的自動更新。更多資訊,請參見知識庫

  • RAM 使用者(子帳號)需先擷取阿里雲百鍊的資料許可權(需要AliyunBailianDataFullAccess,已包括 sfm:AddCategory 許可權點),並加入一個業務空間後,方可調用本介面。阿里雲帳號(主帳號)可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。

  • 本介面不具備等冪性。

限流說明: 本介面頻繁調用會被限流,頻率請勿超過 5 次/秒。如遇限流,請稍後重試。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:AddCategory

create

*全部資源

*

請求文法

POST /{WorkspaceId}/datacenter/category/ HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

WorkspaceId

string

業務空間 ID,即在該業務空間中新增類目。擷取方式請參見如何使用業務空間

llm-3z7uw7fwz0vxxxx

CategoryName

string

類目名稱。長度為 1~20 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。

產品清單

CategoryType

string

類目類型。目前僅支援非結構化類目。取值範圍:

  • UNSTRUCTURED:非結構化資料。

UNSTRUCTURED

ParentCategoryId

string

父類目的類目 ID。在此父類目下建立新類目,此值為空白時建立一級類目。

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

Code

string

錯誤狀態代碼。

success

Data

object

介面業務資料欄位。

CategoryId

string

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

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

CategoryName

string

類目名稱。

類目名稱

Message

string

錯誤資訊。

Requests throttling triggered.

RequestId

string

請求 ID。

778C0B3B-xxxx-5FC1-A947-36EDD13606AB

Status

string

介面返回的狀態代碼。

200

Success

boolean

介面調用是否成功,可能值為:

  • true:成功。

  • false:失敗。

true

樣本

正常返回樣本

JSON格式

{
  "Code": "success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CategoryName": "類目名稱"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情