创建并上传文件
接口描述(Description)
文件管理模块方便各个模块调用,通过创建并上传文件(二进制上传),实现文件的复用
请求地址(Request URL)
[POST] https://file.sensenova.cn/v1/files
请求头(Request Header)
无特殊Header,请参考接口鉴权
请求体(Request Body)
名称 | 类型 | 必须 | 默认值 | 可选值 | 描述 |
---|---|---|---|---|---|
description | string | 否 | - | - | 文件描述 长度不超过256字符 |
scheme | string | 是 | - | 枚举值,类型如下: 用于语音快速复刻的音频文件格式: AUDIO_TTS_1 多模态使用图片文件格式: MULTIMODAL_1 多模态使用视频文件格式: MULTIMODAL_2 知识库Json文件: KNOWLEDGE_BASE_1 知识库其余格式文件: KNOWLEDGE_BASE_2 Assistants模块文件: ASSISTANT_1 | 文件格式 |
file | file | 是 | - | - | 文件的二进制数据 |
AUDIO_TTS_1
当前版本(Beta)格式限制:
- 单声道,采样率 16000Hz,采样位数 pcm_s16le(小端模式16位有符号整数 采样)
- 文件大小不能超过1M,音频时长不能超过30秒
- 必须包含人声
- 文件格式支持:
.wav
在上传文件成功且通过格式校验后,您可使用此图片的file_id来调用语音快速复刻接口,实现语音合成功能。
MULTIMODAL_1
当前版本(Beta)格式限制:
- 图片分辨率不超过13000 px * 13000 px
- 文件大小不能超过10M
- 文件格式支持:
.jpg
.png
在上传文件成功且通过格式校验后,您可使用此图片的file_id来调用图文对话生成接口,实现图片识别、视觉对话等功能。
MULTIMODAL_2
当前版本(Beta)格式限制:
- 视频分辨率不能超过720p (1280 px * 800 px),可支持720p、480p、360p、240p等
- fps不能超过 30帧/s
- 文件大小不能超过20M,视频时长不能超过30s
- 视频编码支持:
h264
h265
- 文件格式支持:
.mp4
在上传文件成功且通过格式校验后,您可使用此视频文件的file_id来调用图文对话生成接口,实现视频理解、目标监控等功能。
KNOWLEDGE_BASE_1
当前版本(Beta)格式限制:
- 文件大小不能超过20M
- 文件格式为
.json
- 编码格式为
UTF-8
- 内容需遵循以下格式
{
"qa_lst": [ //问答对知识
{
"std_q": "xxx", //问题描述
"simi_qs": ["xxx", "xxx"], //相似问题描述
"answer": "xxx" //答案描述
},
{
"std_q": "xxx", //问题描述
"simi_qs": ["xxx", "xxx"], //相似问题描述
"answer": "xxx" //答案描述
}
],
"text_lst": [ //文本知识,纯文本数据(当前版本(Beta),建议每条数据尽量是一个独立的语义主题,便于提升检索效率和效果)
"xxx",
"xxx"
]
}
KNOWLEDGE_BASE_2
当前版本(Beta)格式限制:
- 文件格式支持:
.pdf
.docx
.xlsx
.csv
(编码格式为UTF-8
)
- PDF文件页数不能超过50页,大小不能超过20M
- WORD文件大小不能超过20M
- EXCEL文件不能超过3000行,大小不能超过20M
在上传文件成功且通过格式校验后,您可使用此文件创建知识库。 在创建知识库时,系统会自动识别转换文件内容。目前支持文本、表格内容的识别转换。
请求示例(Request Example)
curl --request POST "https://file.sensenova.cn/v1/files" \
-H "Authorization: Bearer $API_TOKEN" \
-F 'description="string"' \
-F 'scheme="FINE_TUNE_1"' \
-F 'file=@"/D:/nova/dataset1.json"'
响应(Response)
名称 | 类型 | 描述 |
---|---|---|
id | string | 文件ID |
description | string | 文件描述 |
scheme | string | 文件格式 |
created_at | string | 文件创建时间,ISO 8601标准时间格式,精确到纳秒 |
updated_at | string | 文件更新时间,ISO 8601标准时间格式,精确到纳秒 |
status | string | 文件状态,枚举值 未上传/上传中: NOTUPLOADED 已上传(等待格式校验): UPLOADED 文件无效(格式校验不通过): INVALID 文件有效(格式校验通过): VALID |
file_name | string | 文件名称 |
响应示例(Response Example)
{
"id": "string",
"description": "string",
"scheme": "string",
"created_at": "2023-06-28T17:23:01.243566533Z",
"updated_at": "2023-06-28T17:23:01.243566533Z",
"status": "string",
"file_name": "string"
}
错误信息
参考错误码