ApplyFileUploadLease - - Alibaba Cloud ドキュメントセンター

エージェントアプリケーションセッションインタラクションのために非構造化ドキュメントまたはファイルをアップロードするためのアップロードリースをリクエストします。この操作を使用して、構造化データテーブルを作成したり、構造化データテーブルにデータをアップロードしたりすることはできません。これらのタスクには、コンソールを使用してください。

操作説明

この操作を呼び出す前に、RAM ユーザーは Alibaba Cloud Model Studio のデータベース権限を取得し、ワークスペースに参加する必要があります。AliyunBailianDataFullAccess 権限が必要です。この権限には、sfm:ApplyFileUploadLease 権限ポイントが含まれています。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出すことができます。 Alibaba Cloud Model Studio ソフトウェア開発キット（SDK）の最新バージョンを使用して、この操作を呼び出してください。
この操作は冪等ではありません。

スロットリング この操作への頻繁な呼び出しはスロットルされます。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要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sfm:ApplyFileUploadLease

none

*All Resource

*

なし

リクエスト構文

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

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
CategoryId	string	必須	ナレッジベースを構築するために非構造化データをアップロードする場合：このパラメーターは、アップロードされたドキュメントが属するカテゴリの ID を指定します。これは、AddCategory 操作によって返される `CategoryId` です。アプリケーションデータページの [非構造化データ] タブで、カテゴリ名の横にある ID アイコンをクリックして ID を取得することもできます。システム作成の「デフォルトカテゴリ」を使用するには、このパラメーターを `default` に設定します。説明構造化データテーブルを作成してデータをアップロードするには、Alibaba Cloud Model Studio コンソールを使用します。API はこれらの操作をサポートしていません。単に `default` を渡します。システムは自動的にデフォルトカテゴリを作成または一致させます。動的ファイルカテゴリ API とコンソール管理ページは今後利用可能になります。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
FileName	string	必須	ナレッジベースを構築するために非構造化データをアップロードする場合：このパラメーターは、アップロードするドキュメントの名前を指定します。名前にファイル形式の拡張子を含めます。サポートされている形式：pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。ドキュメント名は 4 ～ 128 文字である必要があります。説明構造化データテーブルを作成してデータをアップロードするには、Alibaba Cloud Model Studio コンソールを使用します。API はこれらの操作をサポートしていません。	XXXX产品清单.pdf
Md5	string	必須	アップロードするドキュメントの MD5 ハッシュ。サーバーはこのフィールドを検証します（この機能はまだ有効になっていません）。正しい値を入力してください。	19657c391f6c70bcea63c154d8606bb3
SizeInBytes	string	必須	アップロードするドキュメントのサイズ（バイト単位）。サーバーはこのフィールドを検証します（この機能はまだ有効になっていません）。正しい値を入力してください。値は 1 B ～ 100 MB である必要があります。	1000
WorkspaceId	string	必須	ドキュメントが属するワークスペースの ID。ID の取得方法の詳細については、「ワークスペースの使用方法」をご参照ください。	llm-3z7uw7fwz0vexxxx
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 操作を呼び出すときに、このパラメーターが必要です。	1e6a159107384782be5e45ac4759b247.1719325231035
Param	object	ドキュメントをアップロードするための HTTP リクエストパラメーター。
Headers	any	ヘッダーに含めるキーと値のペア。キーと値はどちらも文字列です。説明返される Content-Type は空の場合があります。空の場合は、空の Content-Type でファイルをアップロードしてください。	"X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf"
Method	string	HTTP メソッド。有効な値： PUT POST	PUT
Url	string	ドキュメントをアップロードするための URL。説明これは署名付き URL です。FormData を使用したアップロードはサポートしていません。ファイルをバイナリ形式でアップロードする必要があります。コード例については、「API を使用してドキュメントをアップロードする」をご参照ください。	https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D
Type	string	ドキュメントをアップロードする方法。有効な値： OSS.PreSignedURL HTTP	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	呼び出しが成功したかどうかを示します。有効な値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。	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=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D"
    },
    "Type": "HTTP"
  },
  "Message": "User not authorized to operate on the specified resource",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": true
}

エラーコード

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

変更履歴

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