检索与同步

创建知识库并导入

一步完成创建知识库和导入文件

POST

/api/v1/indices/rag/index/create_v2

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/create_v2" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-knowledge-base",
    "structureType": "unstructured",
    "sinkType": "DEFAULT",
    "sourceType": "DATA_CENTER_FILE",
    "embeddingModelName": "text-embedding-v4",
    "chunkSize": 600,
    "docIds": ["file_abc123", "file_def456"],
    "dataSources": [{"sourceType": "DATA_CENTER_FILE"}]
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "pipelineId": "your_kb_id",
    "ingestionId": "ing_abc123",
    "status": "PENDING"
  },
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

文件 ID 参数名为 docIds，不是 file_ids 或 fileIds。数据源参数 dataSources 为必填。

Authorizations

string

header

required

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

Body

application/json

string

required

知识库名称，1-20 字符。

Required range:length: 1–20

enum<string>

required

结构类型：unstructured（非结构化）或 structured（结构化）。

Available options:unstructured,structured

string

default"DEFAULT"

required

存储类型，默认 DEFAULT。

string

required

数据源类型，如 DATA_CENTER_FILE。

object[]

required

数据源配置列表。

Show child attributes

string

数据源类型，如 DATA_CENTER_FILE。

string

向量嵌入模型名称，如 text-embedding-v4。

integer

文档切片大小（字符数）。建议值 300-800。

Required range:x >= 1

string[]

创建知识库时可同步导入文件。传入文件 ID 列表，建议导入不超过 10000 个。注意参数名为 docIds，不是 file_ids 或 fileIds。

string[]

创建知识库时可同步导入文件。通过指定类目 ID，可导入对应类目下的所有文件，建议导入不超过 10000 个。

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

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

object

Show child attributes

string

知识库 ID。

string

导入任务 ID。

string

任务状态，创建后为 PENDING。

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/create_v2" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-knowledge-base",
    "structureType": "unstructured",
    "sinkType": "DEFAULT",
    "sourceType": "DATA_CENTER_FILE",
    "embeddingModelName": "text-embedding-v4",
    "chunkSize": 600,
    "docIds": ["file_abc123", "file_def456"],
    "dataSources": [{"sourceType": "DATA_CENTER_FILE"}]
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "pipelineId": "your_kb_id",
    "ingestionId": "ing_abc123",
    "status": "PENDING"
  },
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}