上传文件文档

向指定知识库上传文件类型文档，支持多种切片方式和回调。点击 Try it 按钮可快速试用。

POST /llm-application/open/document/upload_document/{id}

上传文件文档

cURL

curl --request POST \
  --url https://open.bigmodel.cn/api/llm-application/open/document/upload_document/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form files='@example-file' \
  --form knowledge_type=123 \
  --form 'custom_separator=<string>' \
  --form sentence_size=123 \
  --form parse_image=true \
  --form 'callback_url=<string>' \
  --form 'callback_header={}' \
  --form 'word_num_limit=<string>' \
  --form 'req_id=<string>'

import requests

url = "https://open.bigmodel.cn/api/llm-application/open/document/upload_document/{id}"

files = { "files": ("example-file", open("example-file", "rb")) }
payload = {
    "knowledge_type": "123",
    "custom_separator": "<string>",
    "sentence_size": "123",
    "parse_image": "true",
    "callback_url": "<string>",
    "callback_header": "{}",
    "word_num_limit": "<string>",
    "req_id": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('files', '<string>');
form.append('knowledge_type', '123');
form.append('custom_separator', '<string>');
form.append('sentence_size', '123');
form.append('parse_image', 'true');
form.append('callback_url', '<string>');
form.append('callback_header', '{}');
form.append('word_num_limit', '<string>');
form.append('req_id', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://open.bigmodel.cn/api/llm-application/open/document/upload_document/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://open.bigmodel.cn/api/llm-application/open/document/upload_document/{id}")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"knowledge_type\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"custom_separator\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sentence_size\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parse_image\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_header\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"word_num_limit\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"req_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.bigmodel.cn/api/llm-application/open/document/upload_document/{id}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"knowledge_type\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"custom_separator\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sentence_size\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parse_image\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_header\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"word_num_limit\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"req_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.bigmodel.cn/api/llm-application/open/document/upload_document/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"knowledge_type\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"custom_separator\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sentence_size\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parse_image\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_header\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"word_num_limit\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"req_id\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "data": {
    "successInfos": [
      {
        "documentId": "<string>",
        "fileName": "<string>"
      }
    ],
    "failedInfos": [
      {
        "fileName": "<string>",
        "failReason": "<string>"
      }
    ]
  },
  "code": 123,
  "message": "<string>",
  "timestamp": 123
}

{
  "code": 123,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

标准的 HTTP Bearer 认证方式，在 API Keys 页面获取密钥。

Path Parameters

id · string · required

知识库id

Body

multipart/form-data

files · file · required

文件

knowledge_type · integer

文档类型，不传则动态解析。 1: 按标题段落切：支持txt,doc,pdf,url,docx,ppt,pptx,md 2: 按问答对切片：支持txt,doc,pdf,url,docx,ppt,pptx,md 3: 按行切片：支持xls,xlsx,csv 5: 自定义切片：支持txt,doc,pdf,url,docx,ppt,pptx,md 6: 按页切片：支持pdf,ppt,pptx 7: 按单个切片：支持xls,xlsx,csv

custom_separator · string[]

自定义切片规则，knowledge_type=5时传，默认

sentence_size · integer

自定义切片大小，knowledge_type=5时传，20-2000，默认300

parse_image · boolean

是否解析图片，默认不解析

callback_url · string

回调地址

callback_header · object

回调时header携带的k-v

word_num_limit · string

文档字数上限，必须为数字

req_id · string

请求唯一id

Response

200

application/json

业务处理成功

data · object

Show child attributes

code · integer

响应码，200为成功

message · string

响应信息

timestamp · integer

响应时间戳