ListMaterialDocuments - 获取素材列表_大模型服务平台百炼-阿里云帮助中心

获取素材列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AgentKey	string	是	业务空间唯一标识：AgentKey	33a2658aaabf4c24b45d50e575125311_p_beebot_public
Query	string	否	支持对 title、content、content 的综合查询	小猫
Id	long	否	素材主键 ID	69
Title	string	否	根据素材标题全文检索	新闻标题
DocType	string	否	文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)	jsonLine
DocTypeList	array	否	文档类型列表 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)
	string	否	文件类型对象。	html
Content	string	否	文档内容全文检索	新闻内容
ShareAttr	integer	否	共享属性：0：个人私有，1：业务空间范围内共享	1
Keywords	array	否	文档关键词
	string	否	关键词	关键词
CreateTimeStart	string	否	创建时间-开始范围，格式：yyyy-MM-dd HH:mm:ss	2023-02-19 07:28:11
CreateTimeEnd	string	否	创建时间-结束范围，格式：yyyy-MM-dd HH:mm:ss	2023-03-18 02:00:00
UpdateTimeStart	string	否	更新时间-开始范围，格式：yyyy-MM-dd HH:mm:ss	2023-03-18 02:00:00
UpdateTimeEnd	string	否	更新时间-结束范围，格式：yyyy-MM-dd HH:mm:ss	2023-03-18 03:00:00
GeneratePublicUrl	boolean	否	是否生成文件公共 URL	true
Current	integer	否	当前页码	1
Size	integer	否	每页条数：默认 10	10

返回参数

名称	类型	描述	示例值
	object	返回分页后的素材列表
Data	object []	列表对象
Id	long	主键	35
DocType	string	文档类型，pdf、word、url、image	pdf
Title	string	文档标题	文档标题
Summary	string	文档摘要	摘要
Author	string	作者	作者
PubTime	string	发布时间，格式：yyyy-MM-dd HH:mm:ss	2023-03-18 02:00:00
DocKeywords	array	文档标签用于分类等、不同 keyword 之间逗号分割
	string	关键词	关键词
Url	string	内部文档保存的 URL，支持多协议，http://,file://,ftp://:客户上传时保存到内部存储的 URL、长期保存、到期删除	https://www.example.com
PublicUrl	string	临时的对外公开的 URL	https://www.example.com
ExternalUrl	string	外部客户上传的 URL，仅用作记录保存	https://www.example.com
SrcFrom	string	文档来源，user_upload、search、viewpoint	user_upload
TextContent	string	解析后的文本内容，对于图片来说为空	文档内容
HtmlContent	string	网页内容	网页内容
ShareAttr	integer	公开属性，按位存储，第一位表示是否在业务空间内共享、第二位表示是否在租户内共享，第三位表示在系统范围内共享	1
CreateTime	string	创建时间	2023-03-18 02:00:00
UpdateTime	string	修改时间	2023-03-18 02:00:00
CreateUser	string	创建用户 ID	1
CreateUserName	string	创建用户姓名	创建用户名
UpdateUser	string	修改用户 ID	1
UpdateUserName	string	修改用户姓名	更新用户名
ThumbnailInBase64	string	图片文档类型的 Base64 缩略图	base64编码的图像二进制数据
Current	integer	当前页码	1
Size	integer	每页记录数	10
Total	integer	总记录数	100
RequestId	string	请求唯一标识	3f7045e099474ba28ceca1b4eb6d6e21
Success	boolean	是否成功：true 成功，false 失败	false
Code	string	状态码	DataNotExists
Message	string	错误说明	数据不存在
HttpStatusCode	integer	http 状态码	200

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "Id": 35,
      "DocType": "pdf",
      "Title": "文档标题\n\n",
      "Summary": "摘要",
      "Author": "作者\n\n",
      "PubTime": "2023-03-18 02:00:00\n",
      "DocKeywords": [
        "关键词"
      ],
      "Url": "https://www.example.com",
      "PublicUrl": "https://www.example.com\n",
      "ExternalUrl": "https://www.example.com\n",
      "SrcFrom": "user_upload",
      "TextContent": "文档内容",
      "HtmlContent": "网页内容",
      "ShareAttr": 1,
      "CreateTime": "2023-03-18 02:00:00\n",
      "UpdateTime": "2023-03-18 02:00:00\n",
      "CreateUser": "1",
      "CreateUserName": "创建用户名",
      "UpdateUser": "1",
      "UpdateUserName": "更新用户名",
      "ThumbnailInBase64": "base64编码的图像二进制数据"
    }
  ],
  "Current": 1,
  "Size": 10,
  "Total": 100,
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Success": false,
  "Code": "DataNotExists",
  "Message": "数据不存在",
  "HttpStatusCode": 200
}

错误码

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