AddCategory - 新增类目

更新时间:2025-02-12 08:55:49

在指定的业务空间中创建一个类目,用于分类和管理文档。每个业务空间最多创建500个类目。

接口说明

  • 不支持通过 API 创建结构化数据表,请通过控制台的数据管理操作。您可以将知识库与云数据库 RDS 关联,以实现结构化知识库的自动更新。更多信息,请参见知识库
  • RAM 用户(子账号)需要首先获取百炼的 OpenAPI 管理权限(已包括 sfm:AddCategory 权限点),然后才能调用本接口,详见为 RAM 用户授予 OpenAPI 权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 本接口不具备幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 5 次/秒。如遇限流,请稍后重试。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
sfm:AddCategorycreate
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
WorkspaceIdstring

业务空间 ID,即在该业务空间中新增类目。在百炼的控制台首页,单击页面左上角业务空间详情图标获取。

llm-3z7uw7fwz0vxxxx
CategoryNamestring

类目名称。长度为 1~20 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

产品清单
CategoryTypestring

类目类型。目前仅支持非结构化类目。取值范围:

  • UNSTRUCTURED:非结构化数据。
UNSTRUCTURED
ParentCategoryIdstring

父类目的类目 ID。在此父类目下创建新类目,此值为空时创建一级类目。

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

Codestring

错误状态码。

success
Dataobject

接口业务数据字段。

CategoryIdstring

类目 ID。请妥善保管该值,它将用于后续所有与此类目相关的 API 操作。

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CategoryNamestring

类目名称。

类目名称
Messagestring

错误信息。

Requests throttling triggered.
RequestIdstring

请求 ID。

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

接口返回的状态码。

200
Successboolean

接口调用是否成功,可能值为:

  • 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
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等