ナレッジベースファイルまたはエージェントアプリケーションの会話インタラクション用ファイルをアップロードするためのアップロードリースをリクエストします。
操作説明
- RAM ユーザー（サブアカウント）は、この API を呼び出す前に、Alibaba Cloud Model Studio の API 権限（
AliyunBailianDataFullAccess（sfm:ApplyFileUploadLease 権限を含む）が必要）を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウント（プライマリアカウント）は、権限付与なしでこの API を直接呼び出すことができます。最新のAlibaba Cloud Model Studio SDK を使用してこの API を呼び出してください。 - この API はべき等ではありません。
速度制限: この API は、頻繁に呼び出された場合に速度制限の対象となります。周波数は 1 秒あたり 10 回の呼び出しを超えてはなりません。速度制限の主題となった場合は、後でリトライしてください。
今すぐお試しください
この 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:ApplyFileUploadLease | none | *全部资源
| なし | なし |
リクエスト構文
POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| CategoryId | string | 必須 | ナレッジベース構築用のファイルをアップロードする場合:
新しいデータテーブルを作成してデータをアップロードするには、Alibaba Cloud Model Studio コンソールを使用してください。API ではサポートされていません。
| cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| WorkspaceId | string | 必須 | アップロードされたファイルが属するワークスペースの ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。 | llm-3z7uw7fwz0vexxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| FileName | string | 必須 | ナレッジベース構築用のファイルをアップロードする場合:
新しいデータテーブルを作成してデータをアップロードするには、Alibaba Cloud Model Studio コンソールを使用してください。API ではサポートされていません。 | XXXX产品清单.pdf |
| Md5 | string | 必須 | アップロードされたファイルの MD5 値。サーバーはこのフィールドを検証します（現在は有効化されていません）。正しい値を指定してください。 | 19657c391f6c70bcea63c154d8606bb3 |
| SizeInBytes | string | 必須 | アップロードされたファイルのサイズ（バイト単位）。サーバーはこのフィールドを検証します（現在は有効化されていません）。正しい値を指定してください。有効な値: 1 B〜100 MB。 | 1000 |
| CategoryType | string | 任意 | カテゴリタイプ。このパラメーターが指定されていない場合、デフォルト値は UNSTRUCTURED です。有効な値: UNSTRUCTURED: ナレッジベースシナリオ構築用のカテゴリ。 SESSION_FILE: エージェントアプリケーションの会話インタラクション用のファイルをアップロードします。 新しいデータテーブルを作成してデータをアップロードするには、Alibaba Cloud Model Studio コンソールを使用してください。API ではサポートされていません。 . | UNSTRUCTURED |
| UseInternalEndpoint | boolean | 任意 | Alibaba Cloud Model Studio セキュアストレージを有効にしており、同一リージョンの Alibaba Cloud 内部ネットワークからのみアクセス可能な非公開リース URL を生成する必要がある場合、セキュリティを向上させるためにこのパラメーターを true に設定してください。このパラメーターが指定されていない場合、デフォルト値は false にセットされ、パブリックにアクセス可能なリース URL が生成されます。 Alibaba Cloud Model Studio セキュアストレージを有効にしていない場合、または使用しているかどうか不明な場合は、このパラメーターを true に設定しないでください（アップロードが失敗します）。 . | false |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスのスキーマ。 | ||
| Code | string | エラーコード。 | DataCenter.FileTooLarge |
| Data | object | 返されたデータ。 | |
| FileUploadLeaseId | string | リースの一意の ID。AddFile API を呼び出す際にこのパラメーターを使用する必要があります。 | 1e6a159107384782be5e45ac4759b247.1719325231035 |
| Param | object | ファイルをアップロードするための HTTP リクエストパラメーター。 | |
| Headers | any | HTTP リクエストヘッダーに含めるキーと値のペア。キーと値はどちらも文字列です。 返される Content-Type は空の場合があります。アップロード時にはその空の値をそのまま使用してください。 | "X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf" |
| Method | string | HTTP メソッド。有効な値:
| PUT |
| Url | string | ファイルのアップロード URL。 この URL は署名付き URL です。FormData アップロードはサポートされていません。代わりにバイナリアップロードを使用してください。 | |
| Type | string | ファイルのアップロードメソッド。有効な値:
| HTTP |
| Message | string | エラーメッセージ。 | User not authorized to operate on the specified resource |
| RequestId | string | リクエスト ID。 | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status | string | 返された状態コード。 | 200 |
| Success | boolean | API 呼び出しが成功したかどうかを示します。有効な値:
| true |
例
成功レスポンス
JSONJSON
{
"Code": "DataCenter.FileTooLarge",
"Data": {
"FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
"Param": {
"Headers": "\"X-bailian-extra\":\"MTAwNTQyNjQ5NTE2OTE3OA==\",\n\"Content-Type\":\"application/pdf\"",
"Method": "PUT",
"Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=YOUR_ACCESS_KEY_ID&Signature=YOUR_SIGNATURE"
},
"Type": "HTTP"
},
"Message": "User not authorized to operate on the specified resource",
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"Status": "200",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。