获取知识库检索图片 - OpenQueryImage
功能介绍
通过图片ID获取知识库检索图片。
适用场景:
-
当知识库检索接口的返回内容中包含知识库图片标签{KI|image_id}时,可通过解析标签中的image_id调用本接口获取对应图片。
-
当知识库检索接口返回image_ids字段列表时,可使用其中任意一个image_id调用本接口,查询或下载对应的图片文件流。
-
当智能体应用、工作流应用返回内容中包含时,可通过标签中的image_id调用本接口获取对应图片。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/knowledge-bases/images/{image_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 当前租户项目ID。 获取方法请参考获取项目ID。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
|
image_id |
是 |
String |
参数解释: 图片ID。 获取方式:
约束限制: 有效期为7天。 取值范围: 由英文、数字、“-”、“_”组成,长度不超过100位字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
File |
图片文件流。 |
请求示例
-
获取知识库检索图片。
{ "method" : "GET", "url" : "https://api.example.com/v2/{project_id}/knowledge-bases/images/{image_id}", "headers" : { "X-Auth-Token" : "TEST-TOKEN******" } }
响应示例
状态码:200
图片文件流。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
图片文件流。 |
错误码
请参见错误码。