Skip to content

Latest commit

 

History

History
1439 lines (1198 loc) · 71.4 KB

API.md

File metadata and controls

1439 lines (1198 loc) · 71.4 KB
Raw

QAnything 接口文档

全局参数

我们提供用户区分的功能，每个接口中有 user_id 的参数，如果需要请传入 user_id 的值。

user_id 需要满足： 以字母开头，只允许包含字母，数字或下划线。

如果不需要区分不同用户，传入 user_id="zzp"即可

注意当且仅当user_id="zzp"时通过API传入的信息与前端页面互通

新建知识库（POST）

URL：http://{your_host}:8777/api/local_doc_qa/new_knowledge_base

新建知识库请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id （如需使用前端填 zzp 不要更换）
kb_name "kb_test" 是 String 知识库名称 （可以随意指定）
kb_id "KB698428590b1e45108b63b943fac16559_240430_FAQ" 否 String 指定知识库id，通常用于生成FAQ知识库
quick False 否 Bool 是否是快速开始模式创建的知识库，默认为False

新建知识库请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/new_knowledge_base"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "kb_name": "kb_test"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

新建知识库响应示例

{
  "code": 200, //状态码
  "msg": "success create knowledge base KBd728811ed16b46f9a2946e28dd5c9939", //提示信息
  "data": {
    "kb_id": "KB4c50de98d6b548af9aa0bc5e10b2e3a7", //知识库id
    "kb_name": "kb_test", //知识库名称
    "timestamp": "202401251057" // 创建时间戳
  }
}

上传文件（POST）

URL：http://{your_host}:8777/api/local_doc_qa/upload_files

Content-Type: multipart/form-data

上传文件请求参数（Body）

参数名 参数值 是否必填 参数类型 描述说明
files 文件二进制 是 File 需要上传的文件，可多选，目前仅支持[md,txt,pdf,jpg,png,jpeg,docx,xlsx,pptx,eml,csv]
user_id zzp 是 String 用户 id
kb_id KBb1dd58e8485443ce81166d24f6febda7 是 String 知识库 id
mode soft 否 String 上传模式，soft：知识库内存在同名文件时当前文件不再上传，strong：文件名重复的文件强制上传，默认值为 soft
chunk_size 800 否 Int 文件切片大小，默认为800tokens

上传文件同步请求示例

import os
import requests

url = "http://{your_host}:8777/api/local_doc_qa/upload_files"
folder_path = "./docx_data"  # 文件所在文件夹，注意是文件夹！！
data = {
    "user_id": "zzp",
    "kb_id": "KB6dae785cdd5d47a997e890521acbe1c9",
    "mode": "soft"
}

files = []
for root, dirs, file_names in os.walk(folder_path):
    for file_name in file_names:
        if file_name.endswith(".md"):  # 这里只上传后缀是md的文件，请按需修改，支持类型：
            file_path = os.path.join(root, file_name)
            files.append(("files", open(file_path, "rb")))

response = requests.post(url, files=files, data=data)
print(response.text)

上传文件异步请求示例

import argparse
import os
import sys
import json
import aiohttp
import asyncio
import time
import random
import string

files = []
for root, dirs, file_names in os.walk("./docx_data"):  # 文件夹
    for file_name in file_names:
        if file_name.endswith(".docx"):  # 只上传docx文件
            file_path = os.path.join(root, file_name)
            files.append(file_path)
print(len(files))
response_times = []

async def send_request(round_, files):
    print(len(files))
    url = 'http://{your_host}:8777/api/local_doc_qa/upload_files'
    data = aiohttp.FormData()
    data.add_field('user_id', 'zzp')
    data.add_field('kb_id', 'KBf1dafefdb08742f89530acb7e9ed66dd')
    data.add_field('mode', 'soft')

    total_size = 0
    for file_path in files:
        file_size = os.path.getsize(file_path)
        total_size += file_size
        data.add_field('files', open(file_path, 'rb'))
    print('size:', total_size / (1024 * 1024))
    try:
        start_time = time.time()
        async with aiohttp.ClientSession() as session:
            async with session.post(url, data=data) as response:
                end_time = time.time()
                response_times.append(end_time - start_time)
                print(f"round_:{round_}, 响应状态码: {response.status}, 响应时间: {end_time - start_time}秒")
    except Exception as e:
        print(f"请求发送失败: {e}")

async def main():
    start_time = time.time()
    num = int(sys.argv[1])  // 一次上传数量，http协议限制一次请求data不能大于100M，请自行控制数量
    round_ = 0
    r_files = files[:num]
    tasks = []
    task = asyncio.create_task(send_request(round_, r_files))
    tasks.append(task)
    await asyncio.gather(*tasks)

    print(f"请求完成")
    end_time = time.time()
    total_requests = len(response_times)
    total_time = end_time - start_time
    qps = total_requests / total_time
    print(f"total_time:{total_time}")

if __name__ == '__main__':
    asyncio.run(main())

上传文件响应示例

{
  "code": 200, //状态码
  "msg": "success，后台正在飞速上传文件，请耐心等待", //提示信息
  "data": [
    {
      "file_id": "1b6c0781fb9245b2973504cb031cc2f3", //文件id
      "file_name": "网易有道智云平台产品介绍2023.6.ppt", //文件名
      "status": "gray", //文件状态（red：入库失败-切分失败，green，成功入库，yellow：入库失败-milvus失败，gray：正在入库）
      "bytes": 17925, //文件大小（字节数）
      "timestamp": "202401251056" // 上传时间
    },
    {
      "file_id": "aeaec708c7a34952b7de484fb3374f5d",
      "file_name": "有道知识库问答产品介绍.pptx",
      "status": "gray",
      "bytes": 12928, //文件大小（字节数）
      "timestamp": "202401251056" // 上传时间
    }
  ] //文件列表
}

上传网页文件（POST）

URL：http://{your_host}:8777/api/local_doc_qa/upload_weblink

上传网页文件请求参数（Body）

参数名 参数值 是否必填 参数类型 描述说明
url "https://ai.youdao.com/DOCSIRMA/html/trans/api/wbfy/index.html" 否 String html 网址，只支持无需登录且没有反爬虫的网站，不支持递归解析多级页面，解析单个url时使用此参数，解析多个url时可使用urls+titles
user_id zzp 是 String 用户 id
kb_id KBb1dd58e8485443ce81166d24f6febda7 是 String 知识库 id
mode soft 否 String 上传模式，soft：知识库内存在同名文件时当前文件不再上传，strong：文件名重复的文件强制上传，默认值为 soft
urls ["https://xxx", "https://xxx2"] 否 List[str] 与titles配合使用，同时上传多个url
titles ["页面1"，"页面2"] 否 List[str] 与urls配合使用，同时上传多个url，可为[]
chunk_size 800 否 Int 文件切片大小，默认为800tokens

上传网页文件请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/upload_weblink"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "kb_id": "KBb1dd58e8485443ce81166d24f6febda7",
    "url": "https://ai.youdao.com/DOCSIRMA/html/trans/api/wbfy/index.html"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

上传网页文件响应示例

{
  "code": 200,
  "msg": "success，后台正在飞速上传文件，请耐心等待",
  "data": [
    {
      "file_id": "9a49392e633d4c6f87e0af51e8c80a86",
      "file_name": "index.html.web",
      "file_url": "https://ai.youdao.com/DOCSIRMA/html/trans/api/wbfy/index.html",
      "status": "gray",
      "bytes": 0, // 网页文件无法显示大小
      "timestamp": "202401261809"
    }
  ]
}

查看知识库（POST）

URL：http://{your_host}:8777/api/local_doc_qa/list_knowledge_base

查看知识库请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id

查看知识库请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/list_knowledge_base"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

查看知识库响应示例

{
  "code": 200, //状态码
  "data": [
    {
      "kb_id": "KB973d4aea07f14c60ae1974404a636ad4", //知识库id
      "kb_name": "dataset_s_1" //知识库名称
    }
  ] //知识库列表
}

获取文件列表（POST）

URL: http://{your_host}:8777/api/local_doc_qa/list_files

获取文件列表请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
kb_id "KBb1dd58e8485443ce81166d24f6febda7" 是 String 知识库 id
file_id "m1xd58e8485443ce81166d24f6few33d" 否 String 文件id，指定文件id则只返回单个文件的状态
page_offset 1 否 Int 默认值为1，结果太多时可指定分页id（从1开始），与page_limit配合使用
page_limit 10 否 Int 默认值为10，结果太多时可指定分页id（从1开始），与page_offset配合使用

获取文件列表请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/list_files"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",  //用户id
    "kb_id": "KBb1dd58e8485443ce81166d24f6febda7" //知识库id
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

获取文件列表响应示例

{
    "code": 200, //状态码
    "msg": "success", //提示信息
    "data": {
        "status_count": {  // 知识库所有文件状态
            "green": 100,
            "red": 1,
            "gray": 1,
            "yellow": 1,
        },
        "details": {  // 每个文件的具体状态
            {
                "file_id": "21a9f13832594b0f936b62a54254543b", //文件id
                "file_name": "有道知识库问答产品介绍.pptx", //文件名
                "status": "green", //文件状态（red：入库失败-切分失败，green，成功入库，yellow：入库失败-milvus失败，gray：正在入库）
                "bytes": 177925,
                "chunks_number": 16,
                "content_length": 3059,  // 文件解析后字符长度，用len()计算
                "file_location": "/workspace/QAnything/QANY_DB/content/zzp__1234/KBf593b232db0e454db43457a6d1c3632c_240625/63700516e25f4c81b9fd9f68b4a6410b/GeoAutoTrackHorizon.pdf"
                "timestamp": "202401261708",
                "msg": "上传成功"
            },
            {
                "file_id": "333e69374a8d4b9bac54f274291f313e", //文件id
                "file_name": "网易有道智云平台产品介绍2023.6.ppt", //文件名
                "status": "green", //文件状态（red：入库失败-切分失败，green，成功入库，yellow：入库失败-milvus失败，gray：正在入库）
                "bytes": 12379,
                "chunks_number": 20,
                "content_length": 3239,  // 文件解析后字符长度，用len()计算
                "file_location": "/workspace/QAnything/QANY_DB/content/zzp__1234/KBf593b232db0e454db43457a6d1c3632c_240625/63700516e25f4c81b9fd9f68b4a6410b/GeoAutoTrackHorizon.pdf"
                "timestamp": "202401261708",
                "msg": "上传成功"
            }
        },
        "page_id": 1,
        "total": 53,
        "total_page": 1,  
        // ...
    }
}

问答（POST）

URL：http://{your_host}:8777/api/local_doc_qa/local_doc_chat

问答请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
kb_ids ["KBb1dd58e8485443ce81166d24f6febda7", "KB633c69d07a2446b39b3a38e3628b8ada"] 否 Array 知识库 id 的列表，支持多个知识库联合问答，仅在使用bot_id的情况下不需要填
question "保险单号是多少？" 是 String 知识库 id 的列表，支持多个知识库联合问答
history [["question1","answer1"],["question2","answer2"]] 否 Array[Array] 历史对话
rerank True 否 Bool 是否开启 rerank，默认为 True
streaming False 否 Bool 是否开启流式输出，默认为 False
networking False 否 Bool 是否开启联网搜索，默认为 False
custom_prompt "你是一个耐心、友好、专业的编程机器人，能够准确的回答用户的各种编程问题。" 否 String 使用自定义prompt
only_need_search_results False 否 Bool 是否仅返回检索结果跳过大模型回答步骤，默认为False
source paas 否 String 可用于区分请求来源，目前共有paas，saas_bot，saas_qa，分别代表api调用，前端bot问答，前端知识库问答
bot_id 1234 否 String 问答若使用bot_id则相关bot设置自动生效，不需要传kb_ids和custom_prompt了
hybrid_search False 否 String 是否开启混合检索，默认为False
max_token 512 是 int LLM输出的最大token数，一般最大设置为上下文长度的1/4，比如4K上下文设置范围应该是[0-1024]，默认值为512
api_base "https://api.openai-proxy.org/v1" 是 String
api_key "sk-xxx" 是 String
api_context_length 16000 是 String 上下文总长度
model "gpt-3.5-turbo" 是 String
top_p 0.99 否 Float
temperature 0.5 否 Float
web_chunk_size 800 否 Int 开启联网检索后生效，web搜索到的内容文本分块大小

问答非流式请求示例

import sys
import requests
import time

def send_request():
    url = 'http://{your_host}:8777/api/local_doc_qa/local_doc_chat'
    headers = {
        'content-type': 'application/json'
    }
    data = {
        "user_id":"zzp",
        "kb_ids":["KBb85274e102df4de6aa22bf15a47d1c06_240625"],
        "history":[],
        "question":"蔡徐坤是谁？",
        "streaming":true,
        "networking":false,
        "product_source":"saas",
        "rerank":false,
        "only_need_search_results":false,
        "hybrid_search":false,
        "max_token":512,
        "api_base":"https://api.openai-proxy.org/v1",
        "api_key":"sk-xxx",
        "model":"gpt-3.5-turbo",
        "api_context_length":16384,
        "chunk_size":800,
        "top_p":1,
        "temperature":0.5
    }
    try:
        start_time = time.time()
        response = requests.post(url=url, headers=headers, json=data, timeout=60)
        end_time = time.time()
        res = response.json()
        print(res['response'])
        print(f"响应状态码: {response.status_code}, 响应时间: {end_time - start_time}秒")
    except Exception as e:
        print(f"请求发送失败: {e}")


if __name__ == '__main__':
    send_request()

问答非流式响应示例

{
  "code": 200, //状态码
  "msg": "success", //提示信息
  "question": "一嗨案件中保险单号是多少？", //用户问题
  "response": "保险单号是601J312512022000536。", //模型回答
  "history": [["一嗨案件中保险单号是多少？", "保险单号是601J312512022000536。"]], //历史对话：List[str]，至少会显示当前轮对话
  "source_documents": [
    {
      "file_id": "f9b794233c304dd5b5a010f2ead67f51", //文本内容对应的文件id
      "file_name": "一嗨案件支付三者车损、人伤保险赔款及权益转让授权书.docx", //文本内容对应的文件名
      "content": "未支付第三者车损、人伤赔款及同意直赔第三者确认书 华泰财产保险有限公司  北京   分公司： 本人租用一嗨在贵司承保车辆（车牌号：京KML920）商业险保单号： 601J312512022000536、交强险保单号:  601J310022022000570， 对 2023 年 03 月 25日所发生的保险事故（事故号：  9010020230325004124）中所涉及的交强险和商业险的保险赔款总金额 (依：三者京AFT5538定损金额)， 同意支付给本次事故中第三者方。 在此本人确认：本人从未支付给第三者方任何赔偿，且承诺不就本次事故再向贵司及一嗨进行索赔。 同时本人保证如上述内容不属实、违反承诺，造成保险人损失的，由本人承担赔偿责任。 确认人（驾驶员）签字:              第三者方签字: 联系电话：                        联系电话： 确认日期：    年    月    日", //文本内容
      "retrieval_query": "一嗨案件中保险单号是多少？", //文本内容对应的问题
      "score": "3.5585756", //相关性得分，分数越高越相关
      "embed_version": "local_v0.0.1_20230525_6d4019f1559aef84abc2ab8257e1ad4c" //embedding模型版本号
    },
    {
      "file_id": "4867d3fcf395414083c896993fae291e",
      "file_name": "有道领世辅导日常问题处理手册.pdf",
      "content": "html? t  高二数学体系规划学习卡·上（2期）  ype=busy&onlyForm=true  高二语文  高二数学  高二英语  高二物理  半年卡王伟  ￥4700. 00  12:05  李秋颖  高二语文全体系规划学习卡·上（2期）  哈咯盛哥！   为保障你的合法权益与服务质量，本会话内容将可能被对  半年卡李秋颖  ￥4700. 00  支付失败  语文李秋颖  方所在的企业存档，若不同意可拒绝存档。 查看服务须知  怎么办?   应付款￥9400. 00  报名链接：  https://aike-sale. ydshengxue. com/p  有未支付的订单  查看详情  迷续支付  roductList/34  请在“我的订单“中继续支付  取消  查看订单  我  是  哈哈  向  没事  哈哈！   β  123  空格  发送  合计￥0. 00  去结算  选购单  02023/4/20 17:25  有道领世辅导⽇常问题处理⼿册  https://shimo. youdao. com/docs/ky6NGnVY6zMOIXKJ  4/30  8、ios ⽤户反馈领世 app ⾥充值问题  ios的领世app最新版⽀持微信和⽀付宝⽀付， 引导⽤户通过续报H5链接或者最新版领世app⾥  使⽤微信或⽀付宝⽀付即可。   9、⽤户需要使⽤花呗⽀付，但是提示不可⽤是怎么回事  ⽀付宝有单独的⻛控策略，⽤户在使⽤花呗时需要遵守⽀付宝的相关规定和限制，否则  花呗⽀付可能会被关闭或者受限。 如果⽤户在使⽤花呗⽀付时出现问题，建议⽤户拨打  ⽀付宝客服热线 95188 进⾏咨询和核实个⼈花呗状态，以便更好地解决问题。   10、我的微信提示交易有⻛险该怎么办呢？   如果微信提示交易有⻛险，可能是因为您的账户存在异常或者安全⻛险。",
      "retrieval_query": "一嗨案件中保险单号是多少？",
      "score": "-4.617383",
      "embed_version": "local_v0.0.1_20230525_6d4019f1559aef84abc2ab8257e1ad4c"
    },
    {
      "file_id": "4867d3fcf395414083c896993fae291e",
      "file_name": "有道领世辅导日常问题处理手册.pdf",
      "content": "立即订阅  我已阅读并同意有道领世《服务条款》  《",
      "retrieval_query": "一嗨案件中保险单号是多少？",
      "score": "-8.9622345",
      "embed_version": "local_v0.0.1_20230525_6d4019f1559aef84abc2ab8257e1ad4c"
    }
  ]， //retrieval_documents经过一系列后处理最终给到LLM的文本内容，可能是多个chunks组合而成
  "retrieval_documents": [...], // 检索到的文本chunks
  "time_record": {
    "time_usage": {
        "preprocess": 0.01,
        "retriever_search_by_milvus": 0.2,
        "retriever_search": 0.2,
        "rerank": 0.13,
        "reprocess": 0.02,
        "llm_first_return": 2.64
    },
    "token_usage": {
        "prompt_tokens": 1847,
        "completion_tokens": 50,
        "total_tokens": 1897
    }
  }
}

问答流式请求示例

import os
import json
import requests
import time
import random
import string
import argparse

def stream_requests(data_raw):
    url = 'http://{your_host}:8777/api/local_doc_qa/local_doc_chat'
    response = requests.post(
        url,
        json=data_raw,
        timeout=60,
        stream=True
    )
    for line in response.iter_lines(decode_unicode=False, delimiter=b"\n\n"):
        if line:
            yield line

def test():
    data_raw = {
      "kb_ids": ["KB633c69d07a2446b39b3a38e3628b8ada"],
      "question": "你好",
      "user_id": "zzp",
      "streaming": True,
      "history": []
    }
    for i, chunk in enumerate(stream_requests(data_raw)):
        if chunk:
            chunkstr = chunk.decode("utf-8")[6:]
            chunkjs = json.loads(chunkstr)
            print(chunkjs)

if __name__ == '__main__':
    test()

问答流式响应示例

{'code': 200, 'msg': 'success', 'question': '', 'response': '', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '你', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '好', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '！', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '我', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '是', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '有', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '道', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '开', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '发', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '的', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '大', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '模', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '型', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '。', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '有', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '什', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '么', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '问题', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '我', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '可以', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '帮', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '助', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '你', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '解', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '答', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '吗', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '？', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '', 'response': '', 'history': [], 'source_documents': []}
{'code': 200, 'msg': 'success', 'question': '你好', 'response': '你好！我是有道开发的大模型。有什么问题我可以帮助你解答吗？', 'history': [['你好', '你好！我是有道开发的大模型。有什么问题我可以帮助你解答吗？']], 'source_documents':[]}

删除文件（POST）

URL：http://{your_host}:8777/api/local_doc_qa/delete_files

删除文件请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
kb_id "KB1271e71c36ec4028a6542586946a3906" 是 String 知识库 id
file_ids ["73ff7cf76ff34c8aa3a5a0b4ba3cf534"] 是 Array 要删除文件的 id，支持批量删除

删除文件请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/delete_files"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp", //用户id
    "kb_id": "KB1271e71c36ec4028a6542586946a3906", //知识库id
    "file_ids": [
        "73ff7cf76ff34c8aa3a5a0b4ba3cf534"
    ] //文件id列表
}
response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

删除文件响应示例

{
  "code": 200, //状态码
  "msg": "documents ['73ff7cf76ff34c8aa3a5a0b4ba3cf534'] delete success" //提示信息
}

删除知识库（POST）

URL：http://{your_host}:8777/api/local_doc_qa/delete_knowledge_base

删除知识库请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
kb_ids ["KB1cd81f2bc515437294bda1934a20b235"] 是 Array 要删除的知识库 id，支持批量删除

删除知识库请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/delete_knowledge_base"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp", //用户id
    "kb_ids": [
        "KB1cd81f2bc515437294bda1934a20b235"
    ] //知识库id列表
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

删除知识库响应示例

{
  "code": 200, //状态码
  "msg": "Knowledge Base [('KB1cd81f2bc515437294bda1934a20b235',)] delete success" //提示信息
}

获取所有知识库状态（POST）

URL：http://{your_host}:8777/api/local_doc_qa/get_total_status

获取所有知识库状态请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id

获取所有知识库状态请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/get_total_status"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

获取所有知识库状态响应示例

{
  "code": 200,
  "status": {
    "zzp": {
      "默认知识库KB0015df77a8eb46f6951de513392dc250": {
        // kb_name + kb_id
        "green": 10,
        "yellow": 0,
        "red": 0,
        "gray": 0
      },
      "知识问答KB6a4534f753b54c4198b62770e26b1a92": {
        "green": 16,
        "yellow": 0,
        "red": 0,
        "gray": 0
      }
    }
  }
}

清理知识库（POST）

URL：http://{your_host}:8777/api/local_doc_qa/clean_files_by_status

清理知识库请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
status "gray" 是 String 用清理何种状态的文件，red：入库失败-切分失败，green，成功入库，yellow：入库失败-milvus 失败，gray：正在入库
kd_ids ["KB0015df77a8eb46f6951de513392dc250", "KB6a4534f753b54c4198b62770e26b1a92"] 否 String 需要清理的知识库 id 列表，默认为[]，此时默认清理 user_id 下全部的知识库

清理知识库请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/clean_files_by_status"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "status": "gray"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

清理知识库响应示例

{
  "code": 200,
  "msg": "delete gray files success",
  "data": [
    "升学百科benchmark_20231120.xlsx_20231121235103.txt",
    "网页翻译-API文档.md",
    "api_inter_virtualPerson_execution_3451_executionrersult_4699_10_stats.csv",
    "中文成语-如火如荼.png",
    "有道知识库问答产品介绍.pptx",
    "韦小宝身份证.jpg",
    "fake-email.eml",
    "有道领世辅导日常问题处理手册.pdf",
    "xx案件支付三者车损人伤保险赔款及权益转让授权书.docx"
  ]
}

重命名知识库（POST）

URL：http://{your_host}:8777/api/local_doc_qa/rename_knowledge_base

重命名知识库请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
kb_id "KB0015df77a8eb46f6951de513392dc250" 是 String 需要重命名的知识库 id
new_kb_name "新知识库" 是 String 重命名后的知识库名字

重命名知识库请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/rename_knowledge_base"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "kb_id": "KB0015df77a8eb46f6951de513392dc250",
    "new_kb_name": "新知识库"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

重命名知识库响应示例

{
  "code": 200,
  "msg": "Knowledge Base 'KB0015df77a8eb46f6951de513392dc250' rename success"
}

创建Bot（POST）

URL：http://{your_host}:8777/api/local_doc_qa/new_bot

创建Bot请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
bot_name "测试" 是 String Bot名字
description "这是一个测试Bot" 否 String Bot简介
head_image "zhiyun/xxx" 否 String 头像nos地址
prompt_setting "你是一个耐心、友好、专业的机器人，能够回答用户的各种问题。" 否 String Bot角色设定
welcome_message "您好，我是您的专属机器人，请问有什么可以帮您呢？" 否 String Bot欢迎语
model "MiniChat-2-3B" 否 String 模型选择，默认为MiniChat-2-3B
kb_ids ["KB_xxx, KB_xxx, KB_xxx"] 否 List[String] Bot关联的知识库id列表

创建Bot请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/new_bot"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "bot_name": "测试机器人"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

创建Bot响应示例

{
    "code": 200,
    "msg": "success create qanything bot BOTc87cc749a9844325a2e26f09bf8f6918",
    "data": {
        "bot_id": "BOTc87cc749a9844325a2e26f09bf8f6918",
        "bot_name": "测试机器人",
        "create_time": "2024-04-10 10:19:56"
    }
}

获取Bot信息（POST）

URL：http://{your_host}:8777/api/local_doc_qa/get_bot_info

获取Bot信息请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
bot_id "BOTc87cc749a9844325a2e26f09bf8f6918" 否 String Bot id，不填则返回当前用户所有Bot

获取Bot信息请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/get_bot_info"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "bot_id": "BOTc87cc749a9844325a2e26f09bf8f6918"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

获取Bot信息响应示例

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "bot_id": "BOTc87cc749a9844325a2e26f09bf8f6918",
            "user_id": "zzp",
            "bot_name": "测试机器人",
            "description": "一个简单的问答机器人",
            "head_image": "",
            "prompt_setting": "\n- 你是一个耐心、友好、专业的机器人，能够回答用户的各种问题。\n- 根据知识库内的检索结果，以清晰简洁的表达方式回答问题。\n- 不要编造答案，如果答案不在经核实的资料中或无法从经核实的资料中得出，请回答“我无法回答您的问题。”（或者您可以修改为：如果给定的检索结果无法回答问题，可以利用你的知识尽可能回答用户的问题。)\n",
            "welcome_message": "您好，我是您的专属机器人，请问有什么可以帮您呢？",
            "model": "MiniChat-2-3B",
            "kb_ids": "",
            "update_time": "2024-04-10 10:19:56"
        }
    ]
}

修改Bot信息（POST）

URL：http://{your_host}:8777/api/local_doc_qa/update_bot

修改Bot信息请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
bot_id "BOTc87cc749a9844325a2e26f09bf8f6918" 是 String 用户 id
bot_name "测试" 否 String Bot名字
description "这是一个测试Bot" 否 String Bot简介
head_image "zhiyun/xxx" 否 String 头像nos地址
prompt_setting "你是一个耐心、友好、专业的机器人，能够回答用户的各种问题。" 否 String Bot角色设定
welcome_message "您好，我是您的专属机器人，请问有什么可以帮您呢？" 否 String Bot欢迎语
model "MiniChat-2-3B" 否 String 模型选择，默认为MiniChat-2-3B
kb_ids "KB_xxx, KB_xxx, KB_xxx" 否 String Bot关联的知识库id列表

修改ot信息请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/update_bot"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "bot_id": "BOTc87cc749a9844325a2e26f09bf8f6918",
    "bot_name": "测试Bot2",
    "description": "测试3",
    "head_image": "xx",
    "prompt_setting": "测试4",
    "welcome_message": "测试5",
    "model": "gpt",
    "kb_ids": ["KB1", "KB2"]
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

修改Bot信息响应示例

{
    "code": 200,
    "msg": "Bot BOTc87cc749a9844325a2e26f09bf8f6918 update success"
}

删除Bot（POST）

URL：http://{your_host}:8777/api/local_doc_qa/delete_bot

删除Bot请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
bot_id "BOTc87cc749a9844325a2e26f09bf8f6918" 否 String Bot id，不填则返回当前用户所有Bot

删除Bot请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/delete_bot"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "bot_id": "BOTc87cc749a9844325a2e26f09bf8f6918"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

删除Bot响应示例

{
    "code": 200,
    "msg": "Bot BOTc87cc749a9844325a2e26f09bf8f6918 delete success"
}

上传FAQ（POST）

URL：http://{your_host}:8777/api/local_doc_qa/upload_faqs

Content-Type: multipart/form-data

上传FAQ请求参数（Body）

参数名 参数值 是否必填 参数类型 描述说明
user_id zzp 是 String 用户 id
kb_id KBb1dd58e8485443ce81166d24f6febda7_FAQ 是 String 知识库 id
faqs [{"question": "你是谁？", "answer": "我是QAnything！"}] 否 List[Dict] json格式的FAQ集合
chunk_size 800 否 Int 文件切片大小（tokens）

上传FAQ请求示例

import os
import requests

url = "http://{your_host}:8777/api/local_doc_qa/upload_faqs"
data = {
    "user_id": "zzp",
    "kb_id": "KB6dae785cdd5d47a997e890521acbe1c9_FAQ",
    "faqs": [{"question": "北京3月13日天气"， "answer": "15-29度，小雨转晴"}]
}

response = requests.post(url, data=data)
print(response.text)

上传FAQ响应示例

{
    "code": 200,
    "msg": "success，后台正在飞速上传文件，请耐心等待",
    "file_status": {
        "QAnything_QA_模板.xlsx": "success"
    },
    "data": [
        {
            "file_id": "de9c63dfd2fe477394041612bdfbdec3",
            "file_name": "FAQ_你今天吃了什么.faq",
            "status": "gray",
            "length": 11,
            "timestamp": "202404121141"
        },
        {
            "file_id": "b3f9ac467ce14b0280e991c098298155",
            "file_name": "FAQ_天气晴朗吗.faq",
            "status": "gray",
            "length": 9,
            "timestamp": "202404121141"
        },
        {
            "file_id": "5a5ac165324940a8a62062a5335f5f92",
            "file_name": "FAQ_你是谁.faq",
            "status": "gray",
            "length": 14,
            "timestamp": "202404121141"
        },
        {
            "file_id": "562e9a2d1b994d619d4e1ebc85857c92",
            "file_name": "FAQ_你好呀.faq",
            "status": "gray",
            "length": 7,
            "timestamp": "202404121141"
        }
    ]
}

检索qa日志（POST）

URL：http://{your_host}:8777/api/local_doc_qa/get_qa_info

检索qa日志请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 否 String 用户 id，与any_kb_id二选一必填
bot_id "BOTc87cc749a9844325a2e26f09bf8f6918" 否 String 非空则增加bot_id的筛选条件
any_kb_id "KBc87cc749a9844325a2e26f09bf8f6918" 否 String 非空则增加kb_id的筛选条件
query "你的名字" 否 String 非空则增加query的筛选条件
time_start "2024-10-05" 否 String 非空则增加time_start的筛选条件，需和time_end配合使用
time_end "2024-10-05" 否 String 非空则增加time_end的筛选条件，需和time_start配合使用
page_id 0 否 Int 非空则增加page_id的筛选条件，结果超过100条时默认返回第0页（前100条），可用page_id换页
need_info ["query", "result", "timestamp"] 否 List[String] 非空则增加need_info的筛选条件, 返回日志的key，空则返回全部的key
save_to_excel True 否 Bool 默认为False，为True时返回excel文件，可直接下载

检索qa日志请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/get_qa_info"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "kb_ids": [
        "KBe3f7b698208645218e787d2eee2eae41"
    ],
    "time_start": "2024-04-01",
    "time_end": "2024-04-29",
    "query": "韦小宝住址",
    "need_info": ["user_id"]
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

检索qa日志响应示例

{
    "code": 200,
    "msg": "检索到的Log数为1，一次返回所有数据",
    "page_id": 0,
    "qa_infos": [
        {
            "user_id": "zzp"
        }
    ]
}

获取文档完整解析内容（POST）

URL：http://{your_host}:8777/api/local_doc_qa/get_doc_completed

获取文档完整解析内容请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
kb_id "KB698428590b1e45108b63b943fac16559_240430" 是 String 知识库id
file_id "68d7e503cb79497f8416152bb6b773cd" 是 String 文件id
page_offset 1 否 Int 默认值为1，结果太多时可指定分页id（从1开始），与page_limit配合使用
page_limit 10 否 Int 默认值为10，结果太多时可指定分页id（从1开始），与page_offset配合使用

获取文档完整解析内容请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/get_doc_completed"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "kb_id": "KBe3f7b698208645218e787d2eee2eae41",
    "file_id": "68d7e503cb79497f8416152bb6b773cd"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

获取文档完整解析内容响应示例

{
    "code": 200,
    "msg": "success",
    "completed_text": "\n6.全国两会会议精神.docx\n全国政协十四届二次会议开幕会会议精神\n\n6.全国两会会议精神.docx\n中国人民政治协商会议第十四届全国委员会第二次会议4日下午在人民大会堂开幕。2000多名全国政协委员将紧紧围绕中共中央决策部署，牢记政治责任，积极建言资政，广泛凝聚共识，共同谱写中国式现代化的壮美华章。\n\n6.全国两会会议精神.docx\n大会首先审议通过了政协第十四届全国委员会第二次会议议程。\n\n6.全国两会会议精神.docx\n王沪宁代表政协第十四届全国委员会常务委员会，向大会报告工作。\n\n6.全国两会会议精神.docx\n王沪宁表示，2023年是全面贯彻落实中共二十大精神的开局之年。以习近平同志为核心的中共中央团结带领全党全国各族人民，坚持稳中求进工作总基调，接续奋斗、砥砺前行，坚决克服内外困难，全面深化改革开放，新冠疫情防控平稳转段，高质量发展扎实推进，科技创新实现新突破，安全发展基础巩固夯实，民生保障有力有效，经济社会发展主要预期目标圆满完成，社会大局保持稳定，全面建设社会主义现代化国家迈出坚实步伐，极大增强了全国各族人民信心和底气。\n\n6.全国两会会议精神.docx\n王沪宁总结了过去一年来人民政协工作。他说，在以习近平同志为核心的中共中央坚强领导下，政协全国委员会及其常务委员会坚持以习近平新时代中国特色社会主义思想为指导，全面贯彻中共二十大和二十届二中全会精神，深刻领悟“两个确立”的决定性意义，增强“四个意识”、坚定“四个自信”、做到“两个维护”，坚持团结和民主两大主题，坚持人民政协性质定位，坚持在党和国家工作大局中谋划推进政协工作。坚持中国共产党对人民政协工作的全面领导、把牢履职正确政治方向，强化政治培训、提高政治能力和履职本领，完善工作制度体系、夯实履职制度基础，贯彻中共中央大兴调查研究要求、提高调研议政质量，围绕中共二十大重大部署协商议政、服务党和国家中心任务，践行以人民为中心的发展思想、助推保障和改善民生，守正创新、团结奋进，在历届全国政协打下的良好基础上，各项工作取得新成效，服务党和国家事业发展作出新贡献。\n\n6.全国两会会议精神.docx\n王沪宁表示，2024年是中华人民共和国成立75周年，是实现“十四五”规划目标任务的关键一年，也是人民政协成立75周年。人民政协要坚持以习近平新时代中国特色社会主义思想为指导，全面贯彻中共二十大和二十届二中全会精神，坚持党的领导、统一战线、协商民主有机结合，紧紧围绕推进中国式现代化履职尽责，推进思想政治引领，积极建言资政，广泛凝聚共识，加强自身建设，为实现全年经济社会发展目标任务汇聚智慧和力量。...\n",
    "chunks": [
        {
            "page_content": "6.全国两会会议精神.docx\n全国政协十四届二次会议开幕会会议精神",
            "metadata": {
                "user_id": "zzp",
                "kb_id": "KB70b80588e3614fb9ac21581d38176a05_240430",
                "file_id": "0a9f227fffd240aeb24d99e19b8e580e",
                "file_name": "6.全国两会会议精神.docx",
                "nos_key": "xxx/zzp/KB70b80588e3614fb9ac21581d38176a05_240430/0a9f227fffd240aeb24d99e19b8e580e/6.全国两会会议精神.docx",
                "file_url": null,
                "title_lst": [],
                "has_table": false,
                "images_number": 0,
                "faq_dict": {},
                "source_info": {
                    "page_id": 0,
                    "pdf_nos_key": "zhiyun/docqa/qanything/local_file/zhiyun_paas_userId_test__93/KB70b80588e3614fb9ac21581d38176a05_240430/0a9f227fffd240aeb24d99e19b8e580e/6.全国两会会议精神.docx",
                    "chunk_id": -1,
                    "doc_id": "0a9f227fffd240aeb24d99e19b8e580e",
                    "bbox": null
                }
            }
        },
        {
            "page_content": "6.全国两会会议精神.docx\n中国人民政治协商会议第十四届全国委员会第二次会议4日下午在人民大会堂开幕。2000多名全国政协委员将紧紧围绕中共中央决策部署，牢记政治责任，积极建言资政，广泛凝聚共识，共同谱写中国式现代化的壮美华章。",
            "metadata": {
                "user_id": "zzp",
                "kb_id": "KB70b80588e3614fb9ac21581d38176a05_240430",
                "file_id": "0a9f227fffd240aeb24d99e19b8e580e",
                "file_name": "6.全国两会会议精神.docx",
                "nos_key": "xxx/zzp/KB70b80588e3614fb9ac21581d38176a05_240430/0a9f227fffd240aeb24d99e19b8e580e/6.全国两会会议精神.docx",
                "file_url": null,
                "title_lst": [],
                "has_table": false,
                "images_number": 0,
                "faq_dict": {},
                "source_info": {
                    "page_id": 0,
                    "pdf_nos_key": "zhiyun/docqa/qanything/local_file/zhiyun_paas_userId_test__93/KB70b80588e3614fb9ac21581d38176a05_240430/0a9f227fffd240aeb24d99e19b8e580e/6.全国两会会议精神.docx",
                    "chunk_id": -1,
                    "doc_id": "0a9f227fffd240aeb24d99e19b8e580e",
                    "bbox": null
                }
            }
        },
        ...
    ],
    "page_id": 1,
    "total_count": 102,
}

更新chunks（POST）

URL：http://{your_host}:8777/api/local_doc_qa/update_chunks

更新chunks请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
user_id "zzp" 是 String 用户 id
doc_id "698428590b1e45108b63b943fac16559_0" 是 String 修改的chunk对应的doc_id
update_content "新的chunk内容" 是 String 更新后的chunk文本内容
chunk_size 800 否 Int 文本切片大小，默认8000tokens

更新chunks请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/update_chunks"
headers = {
    "Content-Type": "application/json"
}
data = {
    "user_id": "zzp",
    "doc_id": "698428590b1e45108b63b943fac16559_0",
    "update_content": "新的chunk内容"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

更新chunks响应示例

{
    "code": 200,
    "msg": "success update doc_id 698428590b1e45108b63b943fac16559_0",
}

获取文件base64（POST）

URL：http://{your_host}:8777/api/local_doc_qa/get_file_base64

获取文件base64请求参数（Body）

参数名 示例参数值 是否必填 参数类型 描述说明
file_id "698428590b1e45108b63b943fac16559" 是 String 文件 id

获取文件base64请求示例

import requests
import json

url = "http://{your_host}:8777/api/local_doc_qa/get_file_base64"
headers = {
    "Content-Type": "application/json"
}
data = {
    "file_id": "698428590b1e45108b63b943fac16559"
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.status_code)
print(response.text)

获取文件base64响应示例

{
    "code": 200,
    "msg": "success",
    "file_base64": "xxx"
}