PreviewDocument - 预览文档_大模型服务平台百炼(Model Studio)-阿里云帮助中心

预览文档，可获取文档的下载链接，文档类型、标题等信息，可用于文档预览。

接口说明

前提条件

已开通百炼服务和通义点金服务。

获取到 workspaceId：获取 workspace 标识。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dianjin:PreviewDocument	get	全部资源 ``	无	无

请求语法

GET /{workspaceId}/api/library/document/preview HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
workspaceId	string	是	路径参数，业务空间 id。	llm-xxxxx
documentId	string	是	文档 id	8326472354762354

返回参数

名称	类型	描述	示例值
	object	ResultCode
cost	long	耗时	null
data	object	返回数据
previewType	string	预览类型	pdf
title	string	文档标题	test
uploadTime	string	上传时间	2024-01-01 00:00:00
url	string	文档 url	https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png
dataType	string	数据类型	null
errCode	string	错误码	0
message	string	错误信息	ok
requestId	string	请求 ID	ff551395-1c8a-4f30-8ffd-ef7e87c70b4c
success	boolean	是否成功	true
time	string	时间	2024-04-24 11:54:34

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": {
    "previewType": "pdf",
    "title": "test",
    "uploadTime": "2024-01-01 00:00:00",
    "url": "https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png"
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "ff551395-1c8a-4f30-8ffd-ef7e87c70b4c",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

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