从 OSS 批量导入 - Agent Studio

POST

/api/v1/connector/dash/addFilesFromAuthorizedOss

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/addFilesFromAuthorizedOss" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryId": "cate_abc123",
    "categoryType": "UNSTRUCTURED",
    "ossBucket": "my-docs-bucket",
    "ossRegionId": "cn-beijing",
    "fileDetails": [
      {"fileName": "product-guide.pdf", "ossKey": "docs/product-guide.pdf"},
      {"fileName": "faq.docx", "ossKey": "docs/faq.docx"}
    ]
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {},
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

使用前需要通过**服务关联角色（SLR）**授权百炼平台访问你的 OSS Bucket。请在阿里云 RAM 控制台确认已创建 AliyunServiceRoleForBailian 服务关联角色，否则调用将返回权限错误。

关键参数

参数	说明
`categoryId`	类目 ID（此处字段名为 `categoryId`，与 addFile 的 `category` 不同）
`categoryType`	`UNSTRUCTURED`（默认）或 `SESSION_FILE`
`ossBucket`	OSS Bucket 名称
`ossRegionId`	OSS 地域，如 `cn-beijing`
`fileDetails`	文件详情列表，最多 10 个
`overWriteFileByOssKey`	`ossKey` 重复时是否覆盖，默认 `false`
`tags`	文件标签列表，最多 10 个

单次最多 10 个文件，超过请分批调用。
fileDetails 中每个文件可单独指定 parser，默认 AUTO_SELECT。
此接口为异步提交，返回成功仅表示任务已受理，文件解析状态需通过查询文件列表跟踪。

导入完成后，通过查询文件列表拿 categoryId 查看解析状态。

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面（https://agent.console.aliyun.com/settings/apikey）获取。

Body

application/json

string

required

类目 ID，通过 listCategory 获取。

enum<string>

default"UNSTRUCTURED"

required

类目类型。

Available options:UNSTRUCTURED,SESSION_FILE

string

required

OSS Bucket 名称。

string

required

OSS 所在地域，如 cn-beijing。

Example:cn-beijing

object[]

required

要导入的文件详情列表。

Required range:items: 1–10

Show child attributes

string

required

导入后的文件名称。

Required range:length: 1–500

string

required

OSS 对象 Key（文件在 Bucket 中的路径）。

Required range:length: 1–256

enum<string>

default"AUTO_SELECT"

解析器类型。AUTO_SELECT 自动选择解析器；DOCMIND 智能文档解析；DOCMIND_DIGITAL 电子文档解析；DOCMIND_LLM_VERSION 大模型文档解析；DASH_QWEN_VL_PARSER Qwen VL 解析（需同时传 parserConfig）；DOCMIND_LLM_VERSION_MEDIA 音视频解析。categoryType 为 UNSTRUCTURED 时按类目数据解析设置解析文件；为 SESSION_FILE 时系统使用默认方式解析（不支持更改）。

Available options:AUTO_SELECT,DOCMIND,DOCMIND_DIGITAL,DOCMIND_LLM_VERSION,DASH_QWEN_VL_PARSER,DOCMIND_LLM_VERSION_MEDIA

object

解析配置，仅 parser 为 DASH_QWEN_VL_PARSER 时必填，其他解析方式无需传入。

Show child attributes

enum<string>

视觉解析模型。

Available options:qwen-vl-max,qwen-vl-plus

string

解析提示词，长度 1~1500 字符。

Required range:length: 1–1500

string[]

文件关联的标签列表，最多 10 个。

Required range:items <= 10

boolean

defaultfalse

当 ossKey 对应的文件已存在时是否覆盖，默认 false。

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

请求唯一标识，排查问题时请提供此 ID。

object

导入结果。

Show child attributes

string[]

导入成功的文件 ID 列表。

​关键参数

Authorizations

Body

Response

关键参数