すべてのプロダクト
Search

このプロダクト

    :DescribeFile

    ドキュメントセンター

    :DescribeFile

    最終更新日:Aug 12, 2025

    ドキュメントに関する基本情報（名前、種類、ステータスなど）を取得します。

    操作説明

    速度制限: この操作への頻繁な呼び出しは速度制限の対象となります。 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

    ドキュメントが Alibaba Cloud Model Studio に追加されたときのタイムスタンプ。 フォーマットは yyyy-MM-dd HH:mm:ss です。 タイムゾーンは UTC + 08:00 です。

    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: ドキュメントは解析待ちです。

    • PARSING: ドキュメントは解析中です。

    • PARSE_SUCCESS: ドキュメントは解析されました。
      説明 ドキュメントをナレッジベースにインポートする前に、ステータスが PARSE_SUCCESS になるまで待ってください。

    • PARSE_FAILED: ドキュメントの解析に失敗しました。

    PARSE_SUCCESS
    Tags

    array

    ドキュメントに関連付けられているタグのリスト。 1 つのドキュメントに複数のタグを関連付けることができます。

    string

    ドキュメントのタグ。

    产品介绍
    Message

    string

    エラーメッセージ。

    Requests throttling triggered.
    RequestId

    string

    リクエスト ID。

    17204B98-xxxx-4F9A-8464-2446A84821CA
    Status

    string

    返された HTTP ステータスコード。

    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": [
      "产品介绍"
    ]
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

    エラーコード

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

    変更履歴

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