Skip to main content
TorchV文档中心

问答库

问答库接口提供问答对的增删改查及批量操作能力，支持标准问题、相似问题和答案的管理。

请求域名：

https://api.torchv.com

注意：如果您在试用系统环境中，请将api.torchv.com替换成ais.prod.torchv.com

[TOC]

1.请求Header​

所有的接口都必须带上该Header参数，否则鉴权失败

参数名称类型必填描述
Authorizationstring是请求鉴权的应用AccessToken，创建应用后获取。Bearer 开头，例如：Bearer ak_xxxx

2.接口列表​

2.1 问答库列表​

接口地址：/kl/api/saas/qa/list

请求方法：GET

权限要求：knowledge_file READ

接口描述：分页查询问答库列表

请求参数：

参数名类型必填说明
pageNoInteger是当前页码，默认1
pageSizeInteger是页码大小，默认10
questionString否问题（模糊查询）
tagString否标签

响应示例：

{
  "records": [
    {
      "id": 1,
      "question": "如何使用产品？",
      "similarQuestion": "怎么使用产品,产品使用方法",
      "tag": "使用指南",
      "answer": "产品使用方法如下...",
      "mediaSource": null,
      "neverExpire": 1,
      "startTime": null,
      "endTime": null,
      "creator": "admin",
      "createTime": "2024-01-01 10:00:00",
      "modifier": "admin",
      "modifierTime": "2024-01-01 10:00:00",
      "sort": 1
    }
  ],
  "total": 1,
  "totalPage": 1,
  "pageNo": 1,
  "pageSize": 10
}

请求示例：

curl -X GET "${domain}/kl/api/saas/qa/list?pageNo=1&pageSize=10" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

2.2 新增问答​

接口地址：/openapi/paas/v1/knowledge/qa/add

请求方法：POST

权限要求：knowledge_file WRITE

接口描述：新增问答对

请求参数：

参数名类型必填说明
containerIdString是知识库ID
questionString是标准问题，最大255个字符
answerString否答案
similarList<String>否相似问题列表，最多100条，每条最大1000字符
parentCodeString否父级文件夹编码，默认为"0"
neverExpireInteger是是否永久有效，0否1是，默认1
startTimeString否开始时间，格式：yyyy-MM-dd HH:mm:ss
endTimeString否截止时间，格式：yyyy-MM-dd HH:mm:ss
originContentString否文本内容

RequestBody示例：

{
  "containerId": "kb_001",
  "question": "如何使用产品？",
  "similar": ["怎么使用产品", "产品使用方法"],
  "answer": "产品使用方法如下...",
  "parentCode": "0",
  "neverExpire": 1
}

响应示例：

{
  "code": 8200,
  "message": "新增成功",
  "data": "qa_001"
}

请求示例：

curl -X POST "${domain}/openapi/paas/v1/knowledge/qa/add" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "containerId": "kb_001",
    "question": "如何使用产品？",
    "similar": ["怎么使用产品", "产品使用方法"],
    "answer": "产品使用方法如下...",
    "parentCode": "0",
    "neverExpire": 1
  }'

2.3 修改问答​

接口地址：/openapi/paas/v1/knowledge/qa/update

请求方法：PUT

权限要求：knowledge_file WRITE

接口描述：修改问答对

请求参数：

参数名类型必填说明
idInteger是问答ID
containerIdString是知识库ID
questionString是标准问题，最大255个字符
answerString否答案
similarList<String>否相似问题列表，最多100条，每条最大1000字符
parentCodeString否父级文件夹编码，默认为"0"
neverExpireInteger是是否永久有效，0否1是，默认1
startTimeString否开始时间，格式：yyyy-MM-dd HH:mm:ss
endTimeString否截止时间，格式：yyyy-MM-dd HH:mm:ss
originContentString否文本内容

RequestBody示例：

{
  "id": 1,
  "containerId": "kb_001",
  "question": "如何使用产品？",
  "similar": ["怎么使用产品", "产品使用方法"],
  "answer": "产品使用方法如下...",
  "parentCode": "0",
  "neverExpire": 1
}

响应示例：

{
  "code": 8200,
  "message": "修改成功",
  "data": null
}

请求示例：

curl -X PUT "${domain}/openapi/paas/v1/knowledge/qa/update" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1,
    "containerId": "kb_001",
    "question": "如何使用产品？",
    "answer": "产品使用方法如下...",
    "neverExpire": 1
  }'

2.4 批量上传问答​

接口地址：/openapi/paas/v1/knowledge/qa/batchAdd

请求方法：POST

权限要求：knowledge_file WRITE

接口描述：批量上传QA问答对，仅支持Excel-xlsx格式，单次最大支持5000行数据或100MB数据

请求参数：

参数名类型必填说明
fileMultipartFile是Excel文件（xlsx格式）
containerIdString是知识库ID
parentCodeString否父级文件夹编码，默认为"0"

响应示例：

{
  "code": 8200,
  "message": "操作成功",
  "data": null
}

请求示例：

curl -X POST "${domain}/openapi/paas/v1/knowledge/qa/batchAdd" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -F "file=@qa_batch.xlsx" \
  -F "containerId=kb_001" \
  -F "parentCode=0"

2.5 导出问答模板​

接口地址：/openapi/paas/v1/knowledge/qa/downloadExcelTemplate

请求方法：GET

权限要求：knowledge_file READ

接口描述：下载批量上传QA的Excel模板

请求参数：无

响应示例：返回Excel文件

请求示例：

curl -X GET "${domain}/openapi/paas/v1/knowledge/qa/downloadExcelTemplate" \
  -H "Authorization: Bearer sk_xxxxxxxxxxxxx" \
  -o qa_template.xlsx
Previous
知识库文件
Next
知识库检索