知识库开放API

Access Token

您需要在【设置 / 开发者 / APIs】中获取工作台的 Access Token，后续调用以下 APIs 时都需要使用 Token。目前 Token 的有效期是永久，重复获取将导致上次获取的 Token 失效。

$ curl -s https://api.meiqia.com/v1/conversations/<conv_id> -H Authorization:Bearer <access_token>

获取知识库列表

请求方式：POST

接口地址：/unified-api/datagateway/v1/ai/knowledge/list

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
name	string	否		名称，模糊匹配

返回数据：

名称	类型	是否必须	默认值	备注	其他信息
id	string	是		知识库id
ent_id	integer	是		企业ID
name	string	是		知识库名称
created_at	integer	是		创建毫秒时间戳
updated_at	integer	是		更新毫秒时间戳

返回示例：

[
    {
        "id": "kb_123456789",
        "ent_id": 1001,
        "name": "客服知识库",
        "created_at": 1691234567890,
        "updated_at": 1691234567890
    }
]

获取知识库长⽂档列表

请求方式：POST

接口地址：/unified-api/datagateway/v1/ai/knowledge/doc/list

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
name	string	否		名称，模糊匹配
knowledge_id	string	是		知识库id

返回数据：

名称	类型	是否必须	默认值	备注	其他信息
id	string	是		长文档id
ent_id	integer	是		企业id
name	string	是		长文档名称
knowledge_id	string	是		所属知识库id
file_size	integer	是		文件大小(byte)
url	string	是		文件地址
name	string	是		名称
status	string	是		状态	Processing, Success, Failed
error_msg	string	是		失败原因
params	object	是		参数
table_index_column_nums	string	是		索引列数，用英文逗号分隔
created_at	integer	是		创建毫秒时间戳
updated_at	integer	是		更新毫秒时间戳

返回示例：

[
    {
        "id": "doc_123456789",
        "ent_id": 1001,
        "knowledge_id": "kb_987654321",
        "file_size": 2048576,
        "url": "https://example.com/files/document.pdf",
        "name": "⽤户⼿册.pdf",
        "status": "Processing", // Processing, Success, Failed 
        "error_msg": "",
        "params": {
            "table_index_column_nums": "1,2,3"
        },
        "created_at": 1691376000,
        "updated_at": 1691376300
    }
]

添加知识库长⽂档

请求方式：POST

接口地址：/unified-api/datagateway/v1/ai/knowledge/doc/add

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
knowledge_id	string	是		知识库id
doc_name	string	是		长文档名称
file_url	string	是		长文档地址	通过upload_file接口上传
table_index_column_nums	string	否		表格文件索引列数，用英文逗号分隔

返回数据：

名称	类型	是否必须	默认值	备注	其他信息
id	string	是		长文档id

更新知识库长⽂档

请求方式：POST

接口地址：/unified-api/datagateway/v1/ai/knowledge/doc/update

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
id	string	是		要更新的长文档id
doc_name	string	是		长文档名称
file_url	string	是		长文档地址	通过upload_file接口上传
table_index_column_nums	string	否		表格文件索引列数，用英文逗号分隔

返回数据：

名称	类型	是否必须	默认值	备注	其他信息
id	string	是		更新会生成一个新的id

删除知识库长⽂档

请求方式：POST

接口地址：/unified-api/datagateway/v1/ai/knowledge/doc/delete

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
ids	array	是		要删除的长文档id列表

导⼊知识库问答对

请求方式：POST

接口地址：/unified-api/datagateway/v1/ai/knowledge/faq/import

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
file_url	string	是		文件地址	通过upload_file接口上传
knowledge_id	string	是		知识库id
category_name	string	否		问答对分类名称
overwrite	bool	否		是否覆盖该分类的问题，如果是，会把导入文件中没有的问题从知识库删除	相当于删除后，再重建

上传知识库⽂件

请求方式：POST

接口地址：/upload/openapi/upload_file

Header参数：

参数名称	参数值	是否必须	备注
Content-Type	multipart/form-data	是
Authorization		是	Bearer 类型

Body参数：

名称	类型	是否必须	默认值	备注	其他信息
file	file	是		文件	最大为20M
type	string	是		文件类型	该场景为：ai_knowledge_import

返回数据：

名称	类型	是否必须	默认值	备注	其他信息
key	string	是		地址path部分
url	string	是