本节将说明如何基于已创建好的一个知识服务进行检索或者问答

/api/knowledge/service/chat 接口支持基于一个已创建的知识服务进行检索/问答

使用 service/chat 接口有哪些优势？
1、无需串联拼接 search_knowledge 接口和 chat_completions 接口，在控制台前端调试在线参数并发布服务后，即可通过当前接口调用，获得与控制台前端完全一致的效果
2、无需生成复杂的 AKSK 签名，通过 API Key 即可调用

在您的知识库控制台界面发布知识服务，并关联相应的 API Key（用于权限校验）。

[
    {"role": "user", "content": "你好"},
    {"role": "assistant", "content": "你好！有什么我可以帮助你的？"}
    {"role": "user", "content": "当前轮次用户问题"}
]

[
    {
        "role": "system",
        "content": "你是一位在线客服，你的首要任务是通过巧妙的话术回复用户的问题，你需要根据「参考资料」来回答接下来的「用户问题」，这些信息在 <context></context> XML tags 之内，你需要根据参考资料给出准确，简洁的回答。参考资料中可能会包含图片信息，图片的引用说明在<img></img>XML tags 之内，参考资料内的图片顺序与用户上传的图片顺序一致。"
    },
    {
        "role": "user",
        "content": [
            {
                "type": "text",
                "text": "推荐一个适合 3岁小孩的玩具"
            },
            {
                "type": "image_url",
                "image_url": {
                    "url": "https://ark-project.tos-cn-beijing.volces.XXX.jpeg" #从知识库中召回的 top1 图片 url
                }
            }
        ]
    }
]

doc_filter = {
   "op": "must", // 查询算子 must/must_not/range/range_out
   "field": "doc_id",
   "conds": ["tos_doc_id_123", "tos_doc_id_456"]
}
query_param = {
    "doc_filter": doc_filter
}

doc_filter = {
  "op": "and",   // 逻辑算子 and/or
  "conds": [     // 条件列表，支持嵌套逻辑算子和查询算子
    {
      "op": "must",
      "field": "type",
      "conds": [1]
    },
    {
        ...         // 支持>=1的任意数量的条件进行组合
    }
  ]
}

query_param = {
    "doc_filter": doc_filter
}

目前知识服务主要分为两类，检索类型和问答类型。针对不同类型的知识服务，返回的消息格式也有所不同

检索类知识服务

如果您请求的是检索类型的知识服务，返回结果如下：

{
    "doc_id": "_sys_auto_gen_doc_id-134144883689", //文档 id
    "doc_name": "2404.08817v2.pdf", //文档名字
    "create_time": 1727333117, //文档的创建时间
    "doc_type": "pdf", //知识所属原始文档的类型
    "doc_meta": "[{\"field_name\":\"doc_id\",\"field_type\":\"string\",\"field_value\":\"_sys_auto_gen_doc_id-13411829101044883689\"}]", //文档相关元信息（此处是一个包含文档 id 信息的列表形式的字符串）
    "source": "url", //知识来源类型：tos lark tos_fe
    "title": "Revisiting Code Similarity Evaluation with Abstract Syntax Tree Edit Distance", //知识所属文档的标题
    "url": "***" //原始文档的公开下载链接或飞书文档链接
}

问答类知识服务-非流式

如果您请求的是问答类型的知识服务，并选择非流式回答，返回结果如下：

问答类知识服务-流式

如果您请求的是问答类型的知识服务，并选择流式回答，检索的结果将会放在首个流中返回，token_usage 会放在尾流中返回，中间流按照 SSE 格式返回生成的结果（可参考 chat_completions 接口）。

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer your_api_key' \
  http://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/service/chat \
  -d '{
    "service_resource_id": "your_service_resource_id",
    "stream": false,
    "messages": [
        {
            "role": "user",
            "content": "注册抖音的方式有哪些"
        }
    ]
}'

响应消息

执行成功返回：

{
    "code": 0,
    "data": {
        "count": 2,
        "token_usage": {
            "embedding_token_usage": {
                "prompt_tokens": 23,
                "completion_tokens": 0,
                "total_tokens": 23
            },
            "rerank_token_usage": 62,
            "llm_token_usage": {
                "prompt_tokens": 510,
                "completion_tokens": 52,
                "total_tokens": 562,
                "prompt_tokens_details": {
                    "cached_tokens": 0
                },
                "completion_tokens_details": {
                    "reasoning_tokens": 0
                }
            }
        },
        "result_list": [
            {
                "id": "_sys_auto_gen_doc_id-8423876736290680802-0",
                "content": "问题:注册抖音的方式有哪些\n答案:有手机号、邮箱等方式",
                "score": 0.6423748731613159,
                "point_id": "_sys_auto_gen_doc_id-8423876736290680802-0",
                "chunk_id": 0,
                "process_time": 1745475503,
                "rerank_score": 0.929823701560032,
                "doc_info": {
                    "doc_id": "_sys_auto_gen_doc_id-8423876736290680802",
                    "doc_name": "未命名表格.xlsx",
                    "create_time": 1745475499,
                    "doc_type": "xlsx",
                    "doc_meta":"[{\"field_name\":\"所属行业\",\"field_type\":\"list\<string\>\",\"field_value\":[\"医疗\"]},{\"field_name\":\"优先级\",\"field_type\":\"float32\",\"field_value\":\"10\"}]",
                    "source": "tos_fe",
                    "url": ""
                },
                "recall_position": 1,
                "rerank_position": 1,
                "chunk_type": "structured",
                "chunk_source": "document",
                "update_time": 1745475503,
                "table_chunk_fields": [
                    {
                        "field_name": "问题",
                        "field_value": "注册抖音的方式有哪些"
                    },
                    {
                        "field_name": "答案",
                        "field_value": "有手机号、邮箱等方式"
                    }
                ],
                "FromRecallQueue": "master_recall"
            },
            {
                "id": "_sys_auto_gen_doc_id-8423876736290680802-1",
                "content": "问题:注册微信有另外的方式吗\n答案:另外可以通过QQ注册微信",
                "score": 0.5205988883972168,
                "point_id": "_sys_auto_gen_doc_id-8423876736290680802-1",
                "chunk_id": 1,
                "process_time": 1745475503,
                "rerank_score": 0.3796083432458134,
                "doc_info": {
                    "doc_id": "_sys_auto_gen_doc_id-8423876736290680802",
                    "doc_name": "未命名表格.xlsx",
                    "create_time": 1745475499,
                    "doc_type": "xlsx",
                    "doc_meta":"[{\"field_name\":\"所属行业\",\"field_type\":\"list\<string\>\",\"field_value\":[\"医疗\"]},{\"field_name\":\"优先级\",\"field_type\":\"float32\",\"field_value\":\"10\"}]",
                    "source": "tos_fe"
                },
                "recall_position": 2,
                "rerank_position": 2,
                "chunk_type": "structured",
                "chunk_source": "document",
                "update_time": 1745475503,
                "table_chunk_fields": [
                    {
                        "field_name": "问题",
                        "field_value": "注册微信有另外的方式吗"
                    },
                    {
                        "field_name": "答案",
                        "field_value": "另外可以通过QQ注册微信"
                    }
                ],
                "FromRecallQueue": "master_recall"
            }
        ],
        "generated_answer": "您好，注册抖音有手机号、邮箱等方式<reference data-ref=\"_sys_auto_gen_doc_id-8423876736290680802-0\" data-img-ref=\"false\"></reference>。",
    },
    "message": "success",
    "request_id": "02174581251018800000000000000000000ffff0a007412e51bff"
}

执行失败返回：

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{
    "code": 1000003,
    "message": "invalid request:messsages role nil",
    "request_id": "02174581256280800000000000000000000ffff0a007412632e7a"
}