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

操作説明

RAM ユーザーはこの操作を呼び出す前に、Alibaba Cloud Model Studio に必要なデータベース権限を取得し、ワークスペースに参加する必要があります。 sfm:AddFile 権限を含む AliyunBailianDataFullAccess 権限が必要です。 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:AddFile

create

*All Resource

*

なし

リクエスト構文

PUT /{WorkspaceId}/datacenter/file HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
LeaseId	string	必須	アップロードリースの ID。ApplyFileUploadLease 操作によって返される `FileUploadLeaseId` です。	68abd1dea7b6404d8f7d7b9f7fbd332d.17166xxxxxxxx
Parser	string	必須	パーサータイプ。有効な値: DASHSCOPE_DOCMIND: Alibaba Cloud Document Mind 解析。この値は変更できません。説明パーサーは、現在のカテゴリのデータ解析設定を使用して、アップロードされたドキュメントを処理します。	DASHSCOPE_DOCMIND
CategoryId	string	必須	アップロードされたドキュメントのカテゴリの ID を指定します。これは AddCategory 操作によって返される CategoryId です。アプリケーションデータページの非構造化データタブに移動し、カテゴリ名の横にある ID アイコンをクリックして ID を取得することもできます。システムで作成されたデフォルトのカテゴリを使用するには、このパラメータを「default」に設定します。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
WorkspaceId	string	必須	ドキュメントのアップロード先のワークスペースの ID。詳細については、「ワークスペースの使用」をご参照ください。	llm-3shx2gu255oqxxxx
Tags	array	任意	ドキュメントに関連付けるタグ。デフォルト値は空です。つまり、タグは関連付けられていません。最大 10 個のタグを追加します。
	string	任意	ドキュメントのタグ。各タグの長さは最大 32 文字です。文字 (英語と中国語を含む)、数字、アンダースコア (_)、ハイフン (-) を含めることができます。	产品介绍
CategoryType	string	任意	カテゴリタイプ。このパラメータはオプションです。デフォルト値は UNSTRUCTURED です。有効な値: UNSTRUCTURED: 非構造化データ。このタイプは、ナレッジベースを構築するために使用されます。	UNSTRUCTURED
OriginalFileUrl	string	任意	このパラメータを使用して、ドキュメントに URL を追加します。非構造化ナレッジベースを構築するときに、システムはこの URL を記録します。 Alibaba Cloud Model Studio コンソールでエージェントアプリケーションと対話すると、この URL は `docUrl` フィールドのドキュメント検索結果とともに返されます。説明エージェントアプリケーションでは、ナレッジベースと回答ソースを表示の機能が有効になっている必要があります。そうでない場合、このパラメータは無効です。	www.test.com/111.docx

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンススキーマ。
Code	string	エラーコード。	DataCenter.FileTooLarge
Data	object	返されたデータ。
FileId	string	ドキュメントの ID。この ID を保存します。このドキュメントに関連する後続の API 操作に必要です。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
Parser	string	ドキュメントに使用されるパーサー。有効な値: DASHSCOPE_DOCMIND: Alibaba Cloud Document Mind 解析。	DASHSCOPE_DOCMIND
Message	string	エラーメッセージ。	User not authorized to operate on the specified resource.
RequestId	string	リクエスト ID。	778C0B3B-xxxx-5FC1-A947-36EDD13606AB
Status	string	状態コード。	200
Success	string	リクエストが成功したかどうかを示します。有効な値: true: リクエストは成功しました。 false: リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "Code": "DataCenter.FileTooLarge",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "Parser": "DASHSCOPE_DOCMIND"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": "true"
}

エラーコード

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

変更履歴

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