查看文件列表

列出一个连接器可访问的文件。先从响应中取得文件 uri,再预览该文件。

GET https://moi.matrixorigin.cn/newmoi/connectors/files/list

调用前准备

准备有目标工作区访问权限的个人访问令牌目标工作区 ID 和连接器 ID。只有支持文件列举的连接器可以调用此接口。

查询参数

$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,而不是 /ordersfile_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"

参数

类型

是否必填

说明

connector_id

string

要读取文件的连接器 ID。

limit

integer

本页返回数量;省略时为 20。

参数

类型

是否必填

说明

connector_id

string

要读取文件的连接器 ID。

cursor

string

仅在上一页的 data.has_moretrue 时填写;填入上一页返回的 data.cursor,示例中为 $NEXT_CURSOR

limit

integer

本页返回数量。

参数

类型

是否必填

说明

connector_id

string

要读取文件的连接器 ID。

dir

string

相对于连接器配置根目录的目录。填写相对路径,不要以 / 开头。

file_types

array of integer

要筛选的普通文件类型代码。

limit

integer

本页返回数量。

文件类型代码

基础与文档

0
未识别
1
TXT
2
PDF
4
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
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.files

array of object

当前页文件。

data.files.uri

string

文件 URI。

data.files.filename

string

文件名。

data.files.size

integer

文件大小,单位为字节。

data.files.type

integer

文件类型代码。

data.files.path

string

连接器内的文件路径。

data.files.create_time

integer

文件创建时间的 Unix 时间戳。

data.files.update_time

integer

文件更新时间的 Unix 时间戳。

data.cursor

string

下一页游标。

data.has_more

boolean

是否仍有下一页。

错误响应

{
  "code": "ErrServer",
  "msg": "server error",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中为 null

后续操作

保存目标文件的 uri 与连接器 ID。需要确认文件内容时,使用这两个值预览文件

最后更新于