knowledge

列出知识库图片资产

Changed on

浏览某知识库内的全部图片资产，支持关键字搜索（caption/OCR 文本）、按图片属性筛选（attr_filters / attr_rules）与排序分页。

get/knowledge-bases/{id}/images

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/knowledge-bases/{id}/images
  • Auth
    • API key in header Authorization
    • or API key in header X-API-Key

Path parameters

idstring required

知识库 ID

Query parameters

pageinteger

页码，默认 1

page_sizeinteger

每页数量，默认 20，最大 1000

keywordstring

关键字，对 search_in 指定字段做不区分大小写的子串匹配

search_instring

参与搜索的属性 ID（逗号分隔）；须为 in_searchfield=true

sort_bystring

排序属性 ID；须为 in_sortfield=true，默认 created_at

sort_orderstring

排序方向：asc / desc，默认 desc

is_enabledboolean

仅包含启用状态的图片

knowledge_idsstring

来源文档 ID 列表（逗号分隔，最多 50 个），仅返回这些文档的图片

attr_filtersstring

属性筛选 JSON，同一属性多值 OR、属性间 AND

attr_rulesstring

属性逐值裁决 JSON（off 隐藏 / on 强制显示，on 优先）

Response

图片资产分页列表

pageinteger
page_sizeinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes