すべてのプロダクト
Search
ドキュメントセンター

:AddCategory

最終更新日:Oct 13, 2025

指定されたワークスペースにカテゴリを作成して、ドキュメントを分類および管理します。 各ワークスペースは最大 500 個のカテゴリをサポートします。

操作説明

  • API を使用して構造化データテーブルを作成することはできません。 コンソールの [アプリケーションデータ] ページで作成できます。 ナレッジベースを ApsaraDB RDS に関連付けて、構造化データを自動的に同期できます。 詳細については、「ナレッジベース」をご参照ください。

  • この操作を呼び出す前に、RAM ユーザーは Alibaba Cloud Model Studio のデータベース権限を取得 し、ワークスペースに参加 する必要があります。 sfm:AddCategory 権限を含む AliyunBailianDataFullAccess 権限が必要です。 Alibaba Cloud アカウントは、認証なしでこの操作を直接呼び出すことができます。 この操作を呼び出すには、最新バージョンの Alibaba Cloud Model Studio SDK を使用してください。

  • この操作はべき等ではありません。

速度制限: この操作への頻繁な呼び出しは速度制限されます。 1 秒あたり 5 回を超える呼び出しを行わないでください。 呼び出しが速度制限された場合は、後で再試行してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sfm:AddCategory

create

*All Resource

*

なし なし

リクエスト構文

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

WorkspaceId

string

必須

カテゴリを追加するワークスペースの ID。 ワークスペース ID の取得方法については、「ワークスペースの使用方法」をご参照ください。

llm-3z7uw7fwz0vxxxx

CategoryName

string

必須

カテゴリ名。 名前は 1 ~ 20 文字である必要があります。 文字 (漢字を含む)、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。

产品清单

CategoryType

string

必須

カテゴリタイプ。 非構造化カテゴリのみがサポートされています。 有効な値:

  • UNSTRUCTURED: 非構造化データ。

UNSTRUCTURED

ParentCategoryId

string

任意

新しいカテゴリを作成する親カテゴリの ID。 このパラメータを空のままにすると、レベル 1 のカテゴリが作成されます。

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx

レスポンスフィールド

パラメーター

説明

object

レスポンススキーマ。

Code

string

エラーコード。

success

Data

object

返されるデータ。

CategoryId

string

カテゴリ ID。 このカテゴリに関連する後続の API 操作のために、この ID を保存します。

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

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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