查看文件列表¶
列出一个连接器可访问的文件。先从响应中取得文件 uri,再预览该文件。
GET https://moi.matrixorigin.cn/newmoi/connectors/files/list
调用前准备¶
查询参数¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $CONNECTOR_ID 替换为实际值。
curl "https://moi.matrixorigin.cn/newmoi/connectors/files/list?connector_id=$CONNECTOR_ID&limit=20" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
curl "https://moi.matrixorigin.cn/newmoi/connectors/files/list?connector_id=$CONNECTOR_ID&cursor=$NEXT_CURSOR&limit=20" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
dir 指定相对于连接器配置根目录的目录。填写相对路径,不要以 / 开头;例如填写 orders,而不是 /orders。file_types 可重复传入,仅筛选普通文件;目录始终返回。
curl "https://moi.matrixorigin.cn/newmoi/connectors/files/list?connector_id=$CONNECTOR_ID&dir=orders&file_types=7&file_types=8&limit=20" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要读取文件的连接器 ID。 |
|
integer |
否 |
本页返回数量;省略时为 20。 |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要读取文件的连接器 ID。 |
|
string |
是 |
仅在上一页的 |
|
integer |
否 |
本页返回数量。 |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
要读取文件的连接器 ID。 |
|
string |
否 |
相对于连接器配置根目录的目录。填写相对路径,不要以 |
|
array of integer |
否 |
要筛选的普通文件类型代码。 |
|
integer |
否 |
本页返回数量。 |
文件类型代码¶
基础与文档
0- 未识别
1- TXT
24- PPT
5- Word
6- Markdown
9- SQL
10- 目录
11- DOCX
12- PPTX
35- DOC
结构化数据
7- CSV
8- Parquet
24- XLS
25- XLSX
图像
3- 通用图像
20- PNG
21- JPG
22- JPEG
23- BMP
音频与视频
13- WAV
14- MP3
15- AAC
16- FLAC
17- MP4
18- MOV
19- MKV
网页与邮件
27- HTM
28- HTML
29- EML
30- MSG
31- P7S
CAD 与压缩包
32- DWG
33- DXF
34- FAS
101- ZIP
102- RAR
103- 7Z
104- TAR
105- TAR.GZ
106- TAR.BZ2
107- GZ
108- BZ2
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"files": [
{
"uri": "/orders.csv",
"filename": "orders.csv",
"size": 1024,
"type": 1,
"path": "/",
"create_time": 0,
"update_time": 0
}
],
"cursor": "next_cursor",
"has_more": true
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
array of object |
当前页文件。 |
|
string |
文件 URI。 |
|
string |
文件名。 |
|
integer |
文件大小,单位为字节。 |
|
integer |
文件类型代码。 |
|
string |
连接器内的文件路径。 |
|
integer |
文件创建时间的 Unix 时间戳。 |
|
integer |
文件更新时间的 Unix 时间戳。 |
|
string |
下一页游标。 |
|
boolean |
是否仍有下一页。 |
错误响应¶
{
"code": "ErrServer",
"msg": "server error",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中为 |
后续操作¶
保存目标文件的 uri 与连接器 ID。需要确认文件内容时,使用这两个值预览文件。