文档首页/ 应用平台 AppStage/ API参考/ API/ 知识中心/ 检索知识库数据
更新时间：2024-07-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

检索知识库数据

功能介绍

检索知识库数据，根据用户提供的检索信息，返回命中的信息数据。

URI

POST /v1/knowledge-bases/{knowledge_base_id}/embed-datas

表1 路径参数

参数

是否必选

参数类型

描述

knowledge_base_id

是

String

知识库id。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

keyword

否

String

搜索关键字。

similarity_min

否

Float

相似度最小值。

limit

是

Integer

显示的条目数量。

最小值：1

最大值：100

filter

否

SearchSqlFilter object

过滤条件。

order_by

否

SqlOrder object

排序规则。
表3 SearchSqlFilter

参数

是否必选

参数类型

描述

group_type

否

Object

枚举值：

  • AND

  • OR

expressions

否

Array of Expression objects

过滤条件。
表4 Expression

参数

是否必选

参数类型

描述

field

否

String

过滤字段。

field_type

否

Object

字段类型。

枚举值：

  • INT

  • FLOAT

  • BOOLEAN

  • STRING

operator

否

Object

操作符。

枚举值：

  • EQUAL

  • NOT_EQUAL

  • GREAT_THAN

  • GREAT_EQUAL

  • LESS_THAN

  • LESS_EQUAL

  • IN

  • NOTIN

values

否

Array of strings

过滤值。
表5 SqlOrder

参数

是否必选

参数类型

描述

order_items

否

Array of OrderItem objects

排序规则。
表6 OrderItem

参数

是否必选

参数类型

描述

field

否

String

排序字段。

field_type

否

Object

字段类型。

枚举值：

  • INT

  • FLOAT

  • BOOLEAN

  • STRING

order_type

否

Object

排序类型。

枚举值：

  • ASC

  • DESC

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

data

Array of data objects

检索知识库数据具体内容。
表8 data

参数

参数类型

描述

id

String

分片id。

document

String

分片数据。

similarity

Float

相似度范围, 从0到1数值越大相似度越高。

metadata

metadata object

元数据。

download_address

String

临时下载地址，当知识库数据类型为图片、图片-摘要、视频-摘要时有临时下载地址。
表9 metadata

参数

参数类型

描述

order

Integer

序号。

path

String

文件路径。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误信息

请求示例

{
  "keyword" : "户外",
  "similarity_min" : "0.78",
  "limit" : 10,
  "filter" : null,
  "order_by" : null
}

响应示例

状态码： 200

OK

{
  "data" : [ {
    "id" : "812857ef-e298-4b8e-8bd1-24ba9fd5e95c",
    "document" : "户外运动热度大大带动各相关产业发展",
    "similarity" : 0.79593855,
    "metadata" : {
      "order" : 0,
      "file_name" : "户外运动热度大大带动各相关产业发展.docx",
      "file_id" : "户外运动热度大大带动各相关产业发展",
      "path" : "户外运动热度大大带动各相关产业发展.docx"
    },
    "download_address" : null
  } ]
}

状态码： 500

服务器内部错误或三方服务器内部错误

{
  "error_code" : "AIAE.00001500",
  "error_msg" : "系统内部错误。"
}

状态码

状态码

描述

200

OK

500

服务器内部错误或三方服务器内部错误

错误码

请参见错误码。

父主题： 知识中心

相关文档