接口定义
GetImageUrl() 接口用于在使用 AI 套件上传 PDF 类型的文件后，获取图片 URL 地址列表。
说明：
当在数据库的 Collection 中上传 PDF 文件时，系统会提取 PDF 中的图片信息，并将这些信息以 Key 列表的形式存储。在检索出的原始文本块中，图片的位置会以 {key} 的形式进行占位。通过调用接口 GetImageUrl()，可以获取到与这些 Key 一一对应的图片 URL 地址列表。利用这种映射关系，可以将原始 PDF 文档的内容恢复并以 HTML 格式进行展示。
public GetImageUrlRes GetImageUrl(String database, String collection, GetImageUrlParam param)
使用示例
GetImageUrlRes getImageUrlRes = client.GetImageUrl("db-test", "coll-file-test",GetImageUrlParam.newBuilder().setFileName("tcvdb.pdf")// 指定具体的文件 ID.setDocumentIds(Arrays.asList("1340988975862403135")).build());System.out.println("get image url res:");System.out.println(JsonUtils.toJsonString(getImageUrlRes.getImages()));
入参描述
参数名 | 子参数 | 是否必选 | 参数含义 | |
database | - | 是 | 指定查询的数据库名。 | Database 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
collection | - | 是 | 指定查询的集合名 | Collection 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
GetImageUrlParam | setDocumentIds | 是 | 表示要查询的文档的所有 ID。 | 每个 ID 长度限制为[1,128]。支持批量查询，数组元素范围[1,20]。 文件上传成功之后，可使用 query 查询文件的 ID 信息。 |
| setFileName | 是 | 指定文件名称。 | - |
输出信息
[[{"documentId": "1340988975862403135","imageName": "ea97227d-1b12-4d35-8b67-************.png","imageUrl": "https://vecterdb************.cos.ap-guangzhou.myqcloud.com/embedding_file/vdb-********/db-test/coll-file-test-6/******************************************"},{"documentId": "1340988975862403135","imageName": "a5daca6f-a27e-4b35-89f5-************.png","imageUrl": "https://vecterdb************.cos.ap-guangzhou.myqcloud.com/embedding_file/vdb-********/db-test/coll-file-test-6/******************************************"}]]
参数名 | 参数含义 |
documentId | Document 的 ID 信息。 |
imageName | 图片名。 |
imageUrl | 图片 URL。 |
