文件上传/删除

文件上传分三个类型：

1. 普通文档上传，上传的文档会被聚言理解并记住。
2. URL类型文档上传，填入URL后聚言会爬取此URL的内容后理解并记住。
3. 通用文件上传，这些文件上传后不会被大模型理解，而是用作其它用途。

1.文件类型文档上传接口

接口说明

• 一次只能上传一个文档；
• 此接口只允许上传 pdf / docx / text 格式的文件类型文档；
• 单个文档大小不能超过 20MB

请求方式

• 请求方法: POST
• 请求 URL: /v1/ctai/upload_ctai_doc
• Content-Type: multipart/form-data

请求参数

参数	类型	必需	参数说明
ctai_doc	jsonString	是	文档信息对象 json 串，结构如下
check_only	string	否	是否只进行校验参数合法性而不真实上传文档，默认是 0。 0：否 , 1：是
content	file	是	以标准 form-data 文件上传方式传递的文档原始内容流，只支持扩展名是 txt / docx / pdf 格式的文档。当 check_only 为 1 的时候可以不传递此参数。

ctai_doc的结构如下：

{
    "doc_name": "test_name", // 必传，文件名称，重名会自动重命名，最长 200 个字
    "enable_autoqa": "0", // 可选，是否自动生成 qa。默认是否。0：否 | 1：是
    "enable_extract": "0", // 可选，是否进行内容抽取。默认是否。0：否 | 1：是
}

应答业务参数

{
    "ctdoc_id": "test_id",
    "file_url": "https://test_url"
}

参数	类型	参数说明
ctdoc_id	string	文档 id
file_url	string	文档 URL

2 URL 类型文档添加接口

接口说明

• 此接口仅用于添加 URL 类型的文档；
• 通过 URL 解析出来的文档内容大小不能超过 20MB；
• 只允许添加 http:// 或 https:// 形式的 URL；

请求方式

• 请求方法: POST
• 请求 URL: /v1/ctai/add_ctai_doc_batch
• Content-Type: application/json

请求参数

{
    "ctai_doc_list": [
        {
            "doc_type": "url",
            "doc_url": "https://test.com/test.html"
        },
        // 其他文档信息对象
    ]
}

参数	类型	必需	参数说明
ctai_doc_list	array	是	文档信息对象数组，数组中的每个对象都是一个文档信息对象。
doc_type	string	是	文档类型，请传递 url，请注意不是文档的 url 地址，而是 url 这 3 个字节的字符串。 url：URL 类型的文档。
doc_url	string	是	文档的 URL 地址。只允许添加 http:// 或 https:// 形式的 URL。

应答业务参数

{
    "ctai_doc_result_list": [
        {
            "ret": "0",
            "msg": "",
            "ctai_doc": {
                "doc_type": "url",
                "doc_url": "https://test.com/test.html",
                "ctdoc_id": "test_id"
            }
        }
    ]
}

参数	类型	参数说明
ctai_doc_result_list	array	文档添加结果列表，与传入的 ctai_doc_list 列表中的文档信息对象是对应的。
ret	string	此文档添加的错误代码，0 是成功 | 非 0 是失败，详见附录的错误代码说明。
msg	string	此文档添加的错误信息，如果是成功则为空串。
ctai_doc	object	文档信息对象。
doc_type	string	与传入的 doc_type 一致。
doc_url	string	与传入的 doc_url 一致。
ctdoc_id	string	文档 id，仅添加成功之后才会包含此参数。

3 通用文件上传

接口说明

• 这个接口上传的文件，用于其它API的参数。例如定义头像、qa问答等。

请求方式

• 请求方法: POST
• 请求 URL: /v1/ctai/file_upload
• Content-Type: multipart/form-data

请求参数

参数	类型	必需	参数说明
action	string	是	文件分类，支持如下几种分类 ctai_head：头像，只支持扩展名是 jpg / jpeg / png 格式的图片 ctai_qa_image：问答干预图片，只支持扩展名是 jpg / jpeg / png / gif 格式的图片 ctai_qa_video：问答干预视频，只支持扩展名是 mp4 格式的视频
content	file	是	文档类型，多个用英文逗号分隔。可选类型： doc：文件类型的文档 url：URL 类型的文档

应答业务参数

{    
    "file_url": "https://test_url", // 文件 URL
    "file_id": "test_outid_1" // 文件 id
}

参数	类型	参数说明
file_url	string	文件的URL。
file_id	string	文件ID

4 删除文档接口

接口说明

• 此接口用于删除已上传的文档。

请求方式

• 请求方法: POST
• 请求 URL: /v1/ctai/delete_ctai_doc
• Content-Type: application/json

请求参数

{
    "ctdoc_id": "test_id",
}

参数	类型	必需	参数说明
ctdoc_id	string	是	要删除的文档 id，一次只能传递一个文档 id。

应答业务参数

无业务应答参数，关注公共应答参数中，ret是否为0