知识库 OpenAPI-V0.1

知识库接口说明

一、接口基本信息

接口地址：https://open-api.biji.com/getnote/openapi

鉴权方式：基于OAuth 2.0 认证机制的 Bearer Token Authentication（Bearer 令牌认证）

示例

curl --location --request POST 'https://open-api.biji.com/getnote/openapi' \
--header 'Content-Type: application/json' \
--header 'Connection: keep-alive' \
--header 'Authorization: Bearer {api-key}' \
--header 'X-OAuth-Version: 1' \
--data-raw '{}

二、接口明细说明

知识库搜索接口

经过AI处理之后的结果信息

❕

接口地址：/knowledge/search [/stream]

请求方法：POST

参数说明

字段	类型	说明	是否必须	示例	备注
question	string	问题	是
topic_ids	[]string	知识库ID列表	是		当前只支持1个
deep_seek	bool	深度思考	是	true
refs	bool	是否需要引用	否	false	默认false
history	[]struct{"content":"能进一步说明吗","role": "USER"}	搜索记录	否	[ { "content": "IP是什么", "role": "user" }, { "content": "IP就是网络地址", "role": "assistant" } ]	用于追问

请求示例

curl --location --request POST 'https://open-api.biji.com/getnote/openapi/knowledge/search' \
--header 'Content-Type: application/json' \
--header 'Connection: keep-alive' \
--header 'Authorization: Bearer {api-key}' \
--header 'X-OAuth-Version: 1' \
--data-raw '{
    "question": "再具体一点呢",
    "topic_ids": [
        "WPexDor795JvYzva03w16pkmMZVyN4"
    ],
    "history": [
        {
            "content": "黑洞是什么产品",
            "role": "user"
        },
        {
            "content": "全球首款黑洞概念设计，它以黑洞为媒介，将宇宙的神秘感凝结于方寸之间，既是科学精神的致敬，也是工业美学的创新实践。",
            "role": "assistant"
        }
    ],
    "deep_seek": true,
    "stream": true
}'

响应示例

stream

retry: 10000

msg_type：6 处理流程
data: {"code":200,"data":{"msg":"[{\"msg\":\"收到问题\",\"processName\":\"recive_question\",\"processStatus\":\"end\"}]"},"msg_type":6,"retry":30000}
data: {"code":200,"data":{"msg":"[{\"msg\":\"收到问题\",\"processName\":\"recive_question\",\"processStatus\":\"end\"},{\"msg\":\"分析问题\",\"processName\":\"intent\",\"processStatus\":\"start\"}]"},"msg_type":6,"retry":30000}

msg_type：21 深度思考过程
data: {"code":200,"data":{"msg":"嗯"},"msg_type":21,"retry":30000}
data: {"code":200,"data":{"msg":"，"},"msg_type":21,"retry":30000}
data: {"code":200,"data":{"msg":"用"},"msg_type":21,"retry":30000}
data: {"code":200,"data":{"msg":"户"},"msg_type":21,"retry":30000}
data: {"code":200,"data":{"msg":"问"},"msg_type":21,"retry":30000}
data: {"code":200,"data":{"msg":"的"},"msg_type":21,"retry":30000}
data: {"code":200,"data":{"msg":"是"},"msg_type":21,"retry":30000}

msg_type：22 思考时长
data: {"code":200,"data":{"msg":"22081"},"msg_type":22,"retry":30000}

msg_type：1 回答内容
data: {"code":200,"data":{"msg":"\n"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"\n"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"I"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"P"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"（"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"I"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"n"},"msg_type":1,"retry":30000}
data: {"code":200,"data":{"msg":"t"},"msg_type":1,"retry":30000}

msg_type：3 结束
data: {"code":200,"data":{"msg":"[END]"},"msg_type":3,"retry":30000}

msg_type：8 风控
data: {"code":200,"data":{"msg":"风控提醒"},"msg_type":8,"retry":30000}

msg_type：0 错误
data: {"code":200,"data":{"msg":"错误信息"},"msg_type":0,"retry":30000}

Json

{
    "h": {
        "c": 0,
        "e": "",
        "s": 1741247909,
        "t": 26688,
        "apm": "496245180013253"
    },
    "c": {
        "answers": "\n\n根据搜索结果中关于黑洞的定义和观测案例，这里提供一个著名实例：2019年视界望远镜（Event Horizon Telescope）团队发布的首张黑洞照片。该黑洞位于梅西耶87星系（M87*），距离地球约5500万光年，质量是太阳的65亿倍。这一突破性成果首次通过多台射电望远镜联合观测，捕捉到黑洞事件视界周围吸积盘发出的电磁辐射，验证了广义相对论对黑洞引力效应的预测。\n\n具体技术实现上，科学家利用甚长基线干涉测量技术（VLBI），将全球8台射电望远镜组成等效地球直径的观测阵列，通过同步记录并后期合成海量数据（相当于半吨硬盘的存储量），最终历时两年完成图像重建。这一案例不仅证明了黑洞的物理存在，更开创了通过协同观测研究极端天体的新范式。",
        "deep_seek": "嗯，用户让我举个具体的例子，但之前他问的是黑洞是什么，我根据知识库里的笔记[5]已经详细回答了。现在用户可能想进一步了解黑洞的例子，或者可能对之前的回答不够满意，需要更具体的实例。不过，我需要检查搜索结果中的相关笔记，看看有没有合适的例子。\n\n首先，搜索结果中有很多关于三维菁彩声技术的内容，比如到，但这些似乎和黑洞无关。然后笔记[5]是用户自己关于黑洞的笔记，里面提到了黑洞的定义、历史、研究进展和观测方法。用户可能希望我以某个著名的黑洞为例，比如M87*或银河系中心的Sgr A*，这些在笔记[5]里提到的首张黑洞照片相关的内容。\n\n另外，用户提供的其他笔记如[4]、[6]-[8]涉及心理学、企业家经验等，与当前问题无关。所以主要应引用笔记[5]中的内容。需要确保例子具体，比如M87黑洞的照片，或者事件视界望远镜的观测过程，这些都是具体的例子。同时要符合用户要求，在答案中正确引用的编号。可能还需要补充一些关于该例子的细节，比如拍摄时间、使用的技术等，以增强具体性。确保回答结构清晰，例子明确，并正确引用来源。\n"
    }
}

知识库召回

未经AI处理的召回结果

❕

接口地址：/knowledge/search/recall

请求方法：POST

参数说明

字段	类型	说明	是否必须	示例	备注
question	string	问题	是
topic_ids	[]string	知识库ID列表	是		当前只支持1个
intent_rewrite	bool	问题意图重写	是	true	默认：false
select_matrix	bool	对结果进行重选	否	true	默认：false
history	[]struct{"content":"能进一步说明吗","role": "USER"}	搜索记录	否	[ { "content": "IP是什么", "role": "user" }, { "content": "IP就是网络地址", "role": "assistant" } ]	用于追问

请求示例

curl --location --request POST 'https://open-api.biji.com/getnote/openapi/knowledge/search/recall' \
--header 'Content-Type: application/json' \
--header 'Connection: keep-alive' \
--header 'Authorization: Bearer {api-key}' \
--header 'X-OAuth-Version: 1' \
--data-raw '{
    "question": "举个具体的例子呢",
    "topic_ids": [
        "WPexDor795JvYzva03w16pkmMZVyN4"
    ],
    "history": [
        {
            "content": "黑洞是什么",
            "role": "user"
        },
        {
            "content": "是一款产品",
            "role": "assistant"
        }
    ],
    "intent_rewrite": false,
    "select_matrix": false
}'

响应示例

字段	类型	说明	备注
id	string	召回对应资源ID
title	string	召回对应资源标题	可能为空
content	string	召回内容	默认：false
score	float	得分
type	string	召回资源类型	FILE：文件 NOTE：笔记 BLOGGER：订阅博主或直播
recall_source	string	召回来源	embedding keyword

{
    "h": {
        "c": 0,
        "e": "",
        "s": 1741253826,
        "t": 2099,
        "apm": "4962fec80013253"
    },
    "c": {
        "data": [
            {
                "id": "PAO/hakxI/mel6b+g+SuCA==",
                "title": "一口气了解关税 #关税 #掘金计划2025 #一口气看懂经济学 #经济学知识看世界",
                "content": "📈 关税的基本概念与运行机制。以“奶茶国”和“奶牛国”为例，奶茶国对进口奶粉加征20%关税，进口商为维持利润提高售价，这就是关税基本运行机制。👍 关税对本国的利弊。好处：政府创收：如美国对进口洗衣机征税，三年获约十亿美元收入。保护本国产业：幼稚产业保护理论，美、德曾保护纺织等产业，中国曾高关税扶持汽车产业，印度提高关税保护制造业。获得民意支持：经济下行时更明显，且美国摇摆州关键产业工会影响关税政策。作为谈判筹码：特朗普常用此手段，如退出北美自贸协定加征关税后重新谈判获更多保护条款。缩小贸易逆差：短期理论上可行，但实际影响复杂。政府创收：如美国对进口洗衣机征税，三年获约十亿美元收入。保护本国产业：幼稚产业保护理论，美、德曾保护纺织等产业，中国曾高关税扶持汽车产业，印度提高关税保护制造业。",
                "score": 0.09380767438923665,
                "type": "NOTE",
                "recall_source": "embedding"
            },
            {
                "id": "PAO/hakxI/mel6b+g+SuCA==",
                "title": "【完整纯享版】一口气了解通胀",
                "content": "📈 通胀现象与案例。1923年德国出现恶性通胀，纸币贬值严重，物价每两天翻一番，年化通胀率达1.5%×10的56次方。2008年津巴布韦印出100万亿津巴布韦元纸币，物价每24.7小时翻一倍，年化通胀率达7.3%×10的108次方。1946年匈牙利物价每15.6小时翻一倍，年化通胀率为7.5×10的170次方。2022年，美国、欧盟、英国通胀飙升，通胀再次成为全球经济主题。📊 通胀衡量指标与各国情况。衡量通胀常用指标是CPI（消费者物价指数），反映商品和服务物价走势。美国60年间物价涨了约10倍；国内通胀效应明显；澳大利亚物价翻了16倍，英国翻了25倍，印度翻了88倍，土耳其翻了970万倍。🧐 通胀形成原因与本质。",
                "score": 0.07456002020546793,
                "type": "BLOGGER",
                "recall_source": "embedding"
            },
            {
                "id": "PAO/hakxI/mel6b+g+SuCA==",
                "title": "三维菁彩声技术白皮书",
                "content": "在通过对象输出接口请求对象音频数据和元数据的输出的情况下，绕过漫反射处理提供元数据和音频 数据的输入。元数据以 objectsTypemetadata对象的输入形式进入渲染器；通过对元素元数据预处理模块的 处理，经过 objects_gains计算，获得基于对象内容的元数据和音频数据的输出， 当请求接口输出数据时， 这些元素将启用以进行播放。\n16\nAudio Vivid技术白皮书\n2.基于声道的渲染\n[基于声道 DirectSpeakers的渲染原理如下：\n图 9 基于声道的渲染]M+000 M+030 M-000 Ch1 GainCalculatorDirectSpeakers M+045 直接扬声器增益计算 Ch2 M-045 GY/T316 输入 Ch3 M+090 _layout 扬声器 M-090 布局 M+135 M-135 Chx UH+180 LFE1 LFE2",
                "score": 0.009718604104047488,
                "type": "FILE",
                "recall_source": "embedding"
            },
            {
                "id": "PAO/hakxI/mel6b+g+SuCA==",
                "title": "#一口气读懂经济学",
                "content": "导致企业家与打工人、大企业与小企业贫富差距拉大，很多美国人体感不明显。💱 货币政策与降息预期。美联储关注通胀和失业率，目前通胀稳定，焦点在失业率，11月为4.2%，低于4.5%大概率不影响降息节奏。此次降息不像之前加息那样引发全球资本巨浪，降息空间约100个基点。👑 特朗普2.0时代政策展望。提及接下来特朗普2.0时代可能的政策，但未具体阐述。",
                "score": 0.009242766772194181,
                "type": "BLOGGER",
                "recall_source": "embedding"
            }
        ]
    }
}