更新时间:2024-08-27 GMT+08:00
分享

搜索知识库

功能介绍

根据query,在指定知识库中搜索得到topN相关的分片文档。

URI

POST /v1/koosearch/experience/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

最小长度:1

最大长度:1000000

表2 请求Body参数

参数

是否必选

参数类型

描述

repo_id

String

知识库ID

获取方式:

账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性

最小长度:1

最大长度:64

content

String

搜索内容

最小长度:1

最大长度:10000

page_num

Integer

页码,范围1~65535

最小值:1

最大值:65535

page_size

Integer

页面大小,范围1~65535

最小值:1

最大值:65535

filter_string

String

带语法的查询字符串,使用具有严格语法的解析器,根据提供的查询字符串返回文档。

例如:tags:(魔都 OR 首都) AND category:"城市(city)" 例如:需要依据文件ID过滤分片,则使用:"fileId": "f6a050ffef5512e80a6dea57e386f194"

注意事项: 1.支持布尔运算符 AND、OR 和 NOT(也写为 &&、|| 和 !),但请注意它们不遵守通常的优先级规则,因此只要一起使用多个运算符,就应使用括号。 2.保留字符查询时需要使用 \\ 转义:+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /,如\\! 3.详细语法参考query_string语法

最小长度:4

最大长度:1024

scope

String

搜索范围,定义搜索索引中的信息子集,默认文档库

doc:文档知识,使用query2doc模型 faq:FAQ,常见问答集,使用query2query模型 web:网络来源,来自于web搜索引擎

缺省值:doc

最小长度:1

最大长度:16

枚举值:

  • doc

  • faq

  • web

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

doc_list

Array of ChatReferenceInfo objects

文档列表

数组长度:1 - 65535

total

Integer

总数

最小值:1

最大值:65535

表4 ChatReferenceInfo

参数

参数类型

描述

file_id

String

文件id(或FAQ id)

最小长度:1

最大长度:64

title

String

标题

最小长度:1

最大长度:65535

content

String

文本内容

最小长度:1

最大长度:65535

big_content

String

内容上下文,比如未分片的原始表格。

注意: (1)搜索接口可能有值 (2)问答接口会将big_content替换到content,此字段清空

最小长度:0

最大长度:100000

update_date_time

String

更新时间

最小长度:1

最大长度:64

doc_type

String

文档类型(doc-文档,faq-问答)

最小长度:1

最大长度:64

file_path

String

文档归档路径

最小长度:1

最大长度:64

category

String

文档目录,单值,对应目录树中的叶子节点

最小长度:4

最大长度:255

tags

Array of strings

文档标签列表

最小长度:4

最大长度:255

数组长度:0 - 250

score

Float

ES打分

最小值:0

最大值:10000

subtitle

String

文档子标题

最小长度:1

最大长度:65535

repo_id

String

知识库标识

最小长度:1

最大长度:64

请求示例

/v1/123456/applications/123456/uni-search/experience/searchtext

{
  "repo_id" : "1234abdc",
  "content" : "写一个穿越到宋朝的故事。",
  "page_num" : 1,
  "page_size" : 10
}

响应示例

状态码: 200

搜索结果返回体

{
  "doc_list" : [ {
    "file_id" : "123abc",
    "title" : "人工智能.doc",
    "content" : "人工智能",
    "update_date_time" : "134554",
    "doc_type" : "doc",
    "file_path" : "uni-search/v1/人工智能.doc",
    "score" : 0.9999
  } ],
  "total" : 12
}

状态码

状态码

描述

200

搜索结果返回体

错误码

请参见错误码

相关文档