DescribeFile - 查询文档状态

获取文档基本信息,包括文档名称、类型、状态等。

接口说明

调用该接口前请确保您的文档已经成功上传到百炼数据管理中:

  • 如果您是通过 API 进行文档上传操作,请确保您已经调用 AddFile 接口成功获取到FileId

  • 您在百炼数据管理中上传的非结构化文档,也可以通过此接口进行查询。

  • 本接口具有幂等性。

限流说明: 请确保两次查询间隔至少 15 秒,否则可能触发系统限流。如遇限流,请稍后重试。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:DescribeFilenone
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
WorkspaceIdstring

文档所属的业务空间 ID。在百炼的控制台首页,单击页面左上角业务空间详情图标获取。

llm-3shx2gu255oqxxxx
FileIdstring

文档 ID,即 AddFile 接口返回的FileId。您也可以在数据管理页面,单击文件名称旁的 ID 图标获取。

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

错误状态码。

Success
Dataobject

接口业务数据字段。

CategoryIdstring

文档所属类目 ID。

cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CreateTimestring

文档实际添加到百炼中的时间戳,格式: yyyy-MM-dd HH:mm:ss,时区:UTC + 8。

2024-09-09 12:45:43
FileIdstring

文档 ID。

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
FileNamestring

文档名称。

XXX产品介绍.pdf
FileTypestring

文档类型,扩展名。可能值为: pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、png、jpg、jpeg、bmp、gif。

pdf
Parserstring

解析该文档使用的解析器类型。可能值为:

  • DASHSCOPE_DOCMIND:默认文档解析器。
DASHSCOPE_DOCMIND
SizeInByteslong

文档大小,单位字节 Byte。

1234
Statusstring

文档状态,可能值为:

  • INIT: 待解析。
  • PARSING: 解析中。
  • PARSE_SUCCESS:解析完成。
  • PARSE_FAILED:解析失败。
PARSE_SUCCESS
Tagsarray

文档关联的标签列表,一个文档支持关联多个标签。

Tagsstring

文档的标签。

产品介绍
Messagestring

错误信息。

Requests throttling triggered.
RequestIdstring

请求 ID。

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

接口返回的状态码。

200
Successboolean

接口调用是否成功,可能值为:

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。