DescribeFile API によるファイルステータスとタイプの取得 - Model Studio - Alibaba Cloud - Alibaba Cloud Model Studio

アプリケーションデータ内のファイルの基本情報（ファイル名、タイプ、ステータスなど）を照会します。

操作説明

Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Model Studio (AliyunBailianDataFullAccess または AliyunBailianDataReadOnlyAccess、いずれも sfm:DescribeFile 権限を含む) の API 権限を取得し、ワークスペースに参加する必要があります。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:DescribeFile

none

*All Resource

*

なし

リクエスト構文

GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkspaceId	string	必須	ファイルが属するワークスペースの ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。	llm-3shx2gu255oqxxxx
FileId	string	必須	ファイル ID。AddFile 操作によって返される `FileId` です。アプリケーションデータ - ファイルタブでファイル名の横にある ID アイコンをクリックしてファイル ID を取得することもできます。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
Code	string	エラー状態コード。	Success
Data	object	操作によって返されるデータフィールド。
CategoryId	string	ファイルが属するカテゴリの ID。	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CreateTime	string	ファイルが Model Studio に追加された時間のタイムスタンプ。フォーマット: yyyy-MM-dd HH:mm:ss。タイムゾーン: 協定世界時 (UTC)+8。	2024-09-09 12:45:43
FileId	string	ファイル ID。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
FileName	string	ファイル名。	XXX产品介绍.pdf
FileType	string	ファイルタイプ（拡張子）。可能な値: pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。	pdf
Parser	string	ファイルの解析に使用されるパーサタイプ。可能な値: DASHSCOPE_DOCMIND: デフォルトのドキュメントパーサ。	DASHSCOPE_DOCMIND
SizeInBytes	integer	ファイルサイズ（バイト単位）。	1234
Status	string	非構造化ナレッジベース（タイプ: UNSTRUCTURED）で使用されるファイルの場合、可能な値: INIT: 解析待ち。 IN_PARSE_QUEUE: 解析キューに入っています。 PARSING: 解析中。 PARSE_SUCCESS: 解析完了。説明ステータスが PARSE_SUCCESS に変わった後にのみ、ドキュメントをナレッジベースにインポートできます。 PARSE_FAILED: 解析失敗。	PARSE_SUCCESS
Tags	array	ファイルに関連付けられたタグのリスト。ファイルは複数のタグに関連付けることができます。
	string	ファイルのタグ。	产品介绍
ParseResultDownloadUrl	string
ParseErrorMessage	string	解析失敗の理由。	Error Message
Message	string	エラーメッセージ。	Requests throttling triggered.
RequestId	string	リクエスト ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	操作によって返される状態コード。	200
Success	boolean	呼び出しが成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true

例

成功レスポンス

JSONJSON

{
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CreateTime": "2024-09-09 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "FileName": "XXX产品介绍.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "产品介绍"
    ],
    "ParseResultDownloadUrl": "",
    "ParseErrorMessage": "Error Message"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

エラーコード

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

変更履歴

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