承認済みの OSS バケットから Alibaba Cloud Model Studio アプリケーションデータにファイルをインポートします。
操作説明
-
OSS バケットが Model Studio と同じ Alibaba Cloud アカウントに属していること、および OSS からのデータインポート構成手順 に記載されている通り権限付与が完了していることを確認してください。
サポートされるバケットのストレージタイプには、アーカイブ、コールドアーカイブストレージ、ディープコールドアーカイブは含まれません。コンテンツ暗号化が有効なバケットはサポートされています。パブリック読み書き、パブリック読み取り、または非公開アクセスのバケットがサポートされています。
Referer ベースのホットリンク保護 が有効なバケットを使用するには、信頼できる Web サイトからのみアクセスを許可する の説明に従って、ドメイン名
*.console.aliyun.comを Referer ホワイトリストに追加してください。
-
Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、Model Studio の API 権限（sfm:AddFilesFromAuthorizedOss 権限を含む
AliyunBailianDataFullAccess権限が必須）を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出すことができます。最新の Model Studio SDK を使用してこの操作を呼び出してください。 -
この操作にはべき等性がありません。
レート制限: この操作は、頻繁に呼び出されるとスロットリングされます。毎秒 5 回を超える呼び出しを行わないでください。スロットリングされた場合は、後でリトライしてください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sfm:AddFilesFromAuthorizedOss |
create |
*All Resource
|
なし | なし |
リクエスト構文
POST /{WorkspaceId}/datacenter/file/fromoss HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
必須 |
ワークスペースの ID。ファイルはこのワークスペースにインポートされます。ワークスペース ID の取得方法の詳細については、「ワークスペースの使用方法」をご参照ください。 |
llm-3z7uw7fwz0vxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| CategoryId |
string |
必須 |
ファイルのインポート先カテゴリの ID。これは AddCategory 操作によって返される |
cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| CategoryType |
string |
必須 |
カテゴリタイプ。任意です。デフォルト値: UNSTRUCTURED。有効な値:
列挙値:
|
UNSTRUCTURED |
| OssRegionId |
string |
必須 |
OSS バケットのリージョン ID。詳細については、「OSS のリージョンとエンドポイント」をご参照ください。 |
cn-beijing |
| OssBucketName |
string |
必須 |
OSS バケットの名前。詳細については、「バケット」をご参照ください。 |
bucketNamexxxxx |
| FileDetails |
array<object> |
必須 |
インポートするファイルのリスト。一度に最大 10 個のファイルをアップロードできます。 説明
一度に最大 10 個のファイルをアップロードできます。 |
|
|
array<object> |
必須 |
ファイルオブジェクト。 |
||
| FileName |
string |
必須 |
インポートするファイルの名前。ファイル名にはファイル形式の拡張子を含める必要があります。
重要 インポートするファイルの名前がナレッジベース内の既存のファイルと同じ場合でも、操作は Status として SUCCESS を返しますが、ファイルは実際にはインポートされません。同じ名前の既存のファイルは変更されません。インポートする各ファイル名が一意であることを確認してください。説明
データテーブルを作成してデータをアップロードするには、Model Studio コンソールを使用してください。API を通じたこれはサポートされていません。 |
this_is_temp_xxxx.pdf |
| OssKey |
string |
必須 |
OSS バケット内のファイルのキー。詳細については、「オブジェクトの命名規則」をご参照ください。 |
root/path/this_is_temp_xxxx.pdf |
| Parser |
string |
任意 |
パーサタイプ。有効な値:
説明 アップロードされたファイルは、指定されたパーサを使用して解析されます。このパラメーターを AUTO_SELECT に設定した場合、カテゴリに設定されているパーサが使用されます。 |
AUTO_SELECT |
| ParserConfig |
object |
任意 |
パーサ構成。このパラメーターは、パーサタイプが Qwen VL 解析に設定されている場合にのみ必須です。 |
|
| ModelName |
string |
任意 |
モデルの名前。 |
qwen-vl-max |
| ModelPrompt |
string |
任意 |
Qwen VL 解析の呼び出し時に使用されるプロンプト。 |
#角色 你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片，详细描述图片中的内容。 |
| Tags |
array |
任意 |
ファイルに関連付けられたタグのリスト。デフォルト値: 空。これはファイルがどのタグにも関連付けられていないことを意味します。最大 10 個のタグを指定できます。 |
|
|
string |
任意 |
ファイルのタグ。各タグの長さは最大 12 文字で、Unicode 文字カテゴリの文字（英字、漢字、数字を含む）、アンダースコア (_)、ハイフン (-) がサポートされています。 |
产品介绍 |
|
| OverWriteFileByOssKey |
boolean |
任意 |
カテゴリ内で同じ OssKey を持つファイルを上書きするかどうかを指定します。デフォルト値: false。これはファイルが上書きされないことを意味します。 |
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| Code |
string |
エラーコード。 |
success |
| Data |
object |
操作によって返されるデータフィールド。 |
|
| AddFileResultList |
array<object> |
ファイルインポート結果のリスト。 |
|
|
object |
ファイルインポート結果のリスト。 |
||
| FileId |
string |
The file ID. Please keep this value safe, as it will be used for all subsequent API operations related to this file. |
file_809f469a59ac449586ec692576xxxxx_102248XXX |
| OssKey |
string |
The key name (Key) of the imported file in the OSS Bucket. |
root/path/this_is_temp_xxxx.pdf |
| Status |
string |
File import status. Possible values:
説明
Only files with the SUCCESS status can be used to create or update knowledge bases. |
SUCCESS |
| Msg |
string |
Error information returned when file import fails. |
size too large |
| Message |
string |
エラーメッセージ。 |
Cant find out category for category_id param. |
| RequestId |
string |
リクエストの ID。 |
17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status |
string |
操作によって返される状態コード。 |
200 |
| Success |
string |
呼び出しが成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"Code": "success",
"Data": {
"AddFileResultList": [
{
"FileId": "file_809f469a59ac449586ec692576xxxxx_102248XXX",
"OssKey": "root/path/this_is_temp_xxxx.pdf",
"Status": "SUCCESS",
"Msg": "size too large"
}
]
},
"Message": "Cant find out category for category_id param.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": "true"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。