指定されたワークスペースにカテゴリを作成し、ファイルを分類・管理します。各ワークスペースは最大 500 個のカテゴリをサポートします。
操作説明
- API を使用してデータテーブルを追加することはできません。データテーブルを追加するには、コンソールの アプリケーションデータ ページに移動してください。
- RAM ユーザーがこの操作を呼び出すには、Alibaba Cloud Model Studio の必要な API 権限を取得し、ワークスペースに参加する必要があります。
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要素でアスタリスク (*) でマークされます。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
-
条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。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 文字である必要があります。Unicode 文字 (英字、漢字など)、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を使用できます。 | 产品清单 |
| CategoryType | string | 必須 | カテゴリのタイプ。有効な値:
| UNSTRUCTURED |
| ParentCategoryId | string | 任意 | 新しいカテゴリを作成する親カテゴリの ID。このパラメーターを空のままにすると、トップレベルカテゴリが作成されます。 | cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx |
| ConnectorId | string | 任意 | コネクタインスタンスの ID。ID は Alibaba Cloud Model Studio コンソールから取得できます。 | conn_xxxx |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
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 | 返される HTTP ステータスコード。 | 200 |
| Success | boolean | リクエストが成功したかどうかを示します。有効な値:
| true |
例
成功レスポンス
JSONJSON
{
"Code": "success",
"Data": {
"CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
"CategoryName": "类目名称"
},
"Message": "Requests throttling triggered.",
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"Status": "200",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。