search

本节将说明如何基于一个已创建的知识库做在线检索。

/api/knowledge/collection/search 接口用于对知识库进行检索，当前会默认对原始文本加工后的知识内容进行检索。

• 知识库创建完成。
• 文档导入且处理完成。
• 完成“对接指南“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现知识库的检索查询等功能。

状态码说明

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  http://api-knowledgebase.ml_platform.cn-beijing.volces.com/api/knowledge/collection/search \
  -d '{
    "name": "test_name",
    "query": "introduce a new document level structure",
    "limit": 2,
    "query_param": {
        "filter": {
          "op": "must",    
          "field": "doc_id", 
          "conds": ["tos_doc_id_123", "tos_doc_id_456"]
        },
    }, 
    "rerank_switch": false
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{
    "code":0,
    "data": {
          "collection_name": "test_name",
          "count": 2
          "result_list": [
            {
                "id": "tos_doc_id_123",
                "chunk_title": "Conclusion"，
                "content": "In this paper, we discussed the task of document level structure parsing. This task is more intricate compared to the traditional page level scenario. This complexity arises because we need to consider connecting paragraphs across pages and linking paragraphs into sections. To address these challenges, we introduced a transition-based parser as a solution. Alongside this, we introduced a new dataset called DocTree to support this task.",
                "score"：0.7119365930557251,
                "point_id": "tos_doc_id_2_1-217-6834848478902922598",
                "process_time": 1709097567,
                "doc_info": {        
                    "doc_id": "tos_doc_id_123",
                    "doc_name": "DLSP: A Document Level Structure Parser for Multi-Page Digital Documents.pdf",
                    "create_time": 1677561567,
                    "doc_type": "pdf",
                    "doc_meta": "[{"field_name": "author", "field_type": "string", "field_value": "Mike"}, {"field_name": "category", "field_type": "string", "field_value": "Mike"}]",
                    "source": "tos"，
                    "title"："DLSP: A Document Level Structure Parser for Multi-Page Digital Documents"
               }
            }，
            {
                "id": "tos_doc_id_456",
                "chunk_title": "Conclusion"，
                "content": "We also introduce a new document level structure parsing dataset called DocTree. It comprises 1,298 manually annotated documents with document level structural information. In contrast to previous datasets focusing on single page, the maximum page number in DocTree reaches 85 while the average is 7.2.",
                "score"：0.711473822593689
                "point_id": "tos_doc_id_2_1-37-3242137170643999406",
                "process_time": 1709097567,
                "rerank_score": 
                "doc_info": {        
                    "doc_id": "tos_doc_id_123",
                    "doc_name": "DLSP: A Document Level Structure Parser for Multi-Page Digital Documents.pdf",
                    "create_time": 1677561593,
                    "doc_type": "pdf",
                    "doc_meta": "[{"field_name": "author", "field_type": "string", "field_value": "Mike"}, {"field_name": "category", "field_type": "string", "field_value": "Mike"}]",
                    "source": "tos"，
                    "title"："DLSP: A Document Level Structure Parser for Multi-Page Digital Documents"
               }
            }
        ]
    },
    "message": "success",
    "request_id": "02170910041086600000000000000000000ffff0a00609d26d25e"
}

执行失败返回：

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}