知识库列表

curl -X POST 'https://HOST:PORT/api/v1/third_interface/knowledge/retrieval'

鉴权

出于安全考虑,必须将 TOKEN 存储于服务端并通过后端接口调用,避免在前端代码中直接暴露,以防止凭证泄露造成损失

请在 HTTP 请求的 Authorization 请求头中包含您的 TOKEN,格式如下:

Authorization: Bearer {YOUR_TOKEN}

TOKEN获取可通过 个人令牌 和 OAuth 应用获取,具体见 个人令牌授权OAuth 授权码授权

应用秘钥private_key 的获取具体见 生成应用密钥

Request body

  • keyword (str): 检索内容
  • knowledge_id (int): 知识库ID
  • search_type (int): 检索方式 1混合检索 2全文检索 3.语义检索
  • score (float): 最小相关度 0-1
  • top_k (int): 最相关的 k 个文档
参数名 示例值 参数类型 是否必填 参数描述
keyword 考勤 string 检索内容
knowledge_id 740 number 知识库ID
search_type 1 number 检索方式 1混合检索 2全文检索 3.语义检索
score 0.6 number 最小相关度 0-1
top_k 5 number 最相关的 k 个文档

Response

  • status_code (int): 状态码,200表示成功
  • status_message (string): 状态信息
  • data (dict): 返回的数据
    • text (str): 检索内容
    • score (float): 相关度
    • filename: (string): 文件名
    • metadata: (dict): 元数据
      • filename: (int): 文件名
      • file_url: (str): 文件下载地址(需要携带token)
      • chunk_id: (str): 片段id
      • type: (str): 文件类型

响应示例

{
  "status_code": 200,
  "status_message": "SUCCESS",
  "data": [
    {
      "text": "来自“半云科技假勤管理制度.pdf”文件里面的片段\n\n第九条公司采用钉钉考勤,标准工作日员工每人每日必须两次打卡登记,\n上、下班各一次;外出或出差的,需要在外出地或出差地正常打卡,未打卡\n的,或在非外出地或出差地打卡的,均视为旷工。\n第十条参加公司组织的会议、培训、学习、考试或其他团队活动,如有事\n请假的,必须提前向组织者及领导请假。在规定时间内未到或早退的,按上\n班制的迟到、早退处理。未经批准不参加的,视为旷工。\n第四章考勤种类设置及奖惩办法\n第十一条公司假勤种类分为迟到、早退、旷工、打卡异常、公出、出差、\n请假及法定节假日。\n第十二条日常考勤及惩处办法\n一、打卡异常、补单要求及惩处办法\n1、打卡异常:上班或下班没有打卡记录,计1次打卡异常;全天没有打\n卡记录,计2次打卡异常;打卡异常需提供相应办公证明,否则视为旷工。\n月度累计打卡异常不超过6次的,需提交相应办公证明并做出书面说明,\n经部门负责人核定审批后方可消除;未及时申报审批或审批不通过的,按旷\n工核定,每次打卡异常计旷工0.5天。\n月度打卡异常累计超过6次的,超出次数直接按旷工核定,每次打卡异\n常计旷工0.5天。\n旷工时段不予核算工资,并加罚同等时长工资。\n特殊情况如遇停电、考勤故障等非员工个人原因而产生的打卡异常现\n象,由人力资源部统一备案消除。\n2、补单要求:公出(外勤)补单、假勤异常提报时间为5个自然日,超\n过5个自然日原则上不得申请公出或假勤异常。\n3、假勤审批原则:部门负责人或项目经理在审批员工外出或出差时长\n时,需有明确的项目目标、任务清单及预期成果,严格评估任务所需时长,\n3",
      "score": 0.7958984375,
      "filename": "半云科技假勤管理制度.pdf",
      "metadata": {
        "filename": "半云科技假勤管理制度.pdf",
        "file_url": "http//:112.5.142.51:14620/api/v1/third_interface/knowledge/download_file/1_740/42eaa740-26db-44a3-ae34-5a4b90699fdd.pdf?bucket_name=tmp-dir",
        "chunk_id": "5fb57167-5896-40e2-a48b-868b6d0f",
        "type": "file"
      }
    },
    {
      "text": "来自“半云科技假勤管理制度.pdf”文件里面的片段\n\n根据此审批外出时长及出差天数;时长若有调整的,需按实际时长返程,杜\n绝完成任务后逗留,一经发现按旷工处理。\n处罚办法:自觉遵守假勤制度,是员工基本职业操守。各级管理者须以\n身作则切实履行管理职责,假勤审批应以事实为依据、实事求是。人力资源\n部将对假勤异常、公出等情形进行抽查(抽查形式包括但不限于视频监控、\n工作记录等),一旦发现弄虚作假、包庇纵容、随意审批外出或出差时长等\n情形,将对假勤提报人和假勤审批人进行处罚:\n(1)假勤提报人:按旷工惩处标准执行;违背公司核心价值观,公司有\n权解除劳动合同。\n(2)假勤审批人:\n第一次:书面警告\n第二次:通报批评\n第三次:降职降级\n以上处罚记录将列入员工绩效考评档案中,作为员工职务任免、职级调\n整的重要参考依据。\n二、迟到、早退、旷工及惩处办法\n1、迟到、早退时间规定\n实际上班考勤时间晚于规定考勤时间30分钟以内的,视为迟到;实际上\n班考勤时间晚于规定考勤时间30分钟以上2小时以内的,该时段(0.25天)\n不予核算工资;实际上班考勤时间晚于规定考勤时间2小时以上3.5小时以内\n的,该时段(0.5天)不予核算工资。\n实际下班考勤时间早于规定考勤时间30分钟以内的,视为早退;实际下\n班考勤时间早于规定考勤时间30分钟以上的,该时段(0.5天)不予核算工\n资。\n2、迟到、早退次数及惩处办法\n迟到/早退次数(月)惩处办法\n4",
      "score": 0.73974609375,
      "filename": "半云科技假勤管理制度.pdf",
      "metadata": {
        "filename": "半云科技假勤管理制度.pdf",
        "file_url": "http//:112.5.142.51:14620/api/v1/third_interface/knowledge/download_file/1_740/42eaa740-26db-44a3-ae34-5a4b90699fdd.pdf?bucket_name=tmp-dir",
        "chunk_id": "944d1d94-4ed4-43d8-ba23-dbc4b6d4",
        "type": "file"
      }
    }
  ]
}