该接口将已经文档解析之后的数据按照设置的索引创建流程添加到百炼系统中，形成索引信息，后续可以提供查询索引的能力。
接口说明
- 使用此接口前，用户需要确保调用"添加文档(AddFile)"接口，文件已成功上传至百炼数据中心，并已成功获得相关的 FileId。
- 创建索引接口只负责初始化索引构建流程，需要继续调用"提交索引执行任务（SubmitIndexJob)"接口，完成索引任务的执行。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /{WorkspaceId}/index/create
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 业务空间 id，请登录百炼后，在左上角业务空间详情中获取。 | ws_3Nt27MYcoK191ISp |
| Name | string | 是 | 索引名称 | 示例：企业帮助文档库 |
| StructureType | string | 是 | 数据源结构类型 枚举值：
| unstructured |
| EmbeddingModelName | string | 否 | 向量模型名称 枚举值：
| text-embedding-v2 |
| RerankModelName | string | 否 | 排序模型名称 枚举值：
| gte-rerank-hybrid |
| RerankMinScore | double | 否 | 相似度阈值：设定最低分数标准，只有超过这个阈值的检索结果才会被考虑用于后续的生成过程 | 0.20 |
| ChunkSize | integer | 否 | 分段预估长度：取值范围[1-2048] | 128 |
| OverlapSize | integer | 否 | 分段重叠长度:当前分片与上一个分片重叠的文本长度;取值范围[0-1024] | 16 |
| Separator | string | 否 | 分句标识符 | , |
| SourceType | string | 是 | 数据中心数据类型 枚举值：
| DATA_CENTER_FILE |
| DocumentIds | array | 否 | 文档 id 列表 | |
| string | 否 | 添加文档接口返回的 FileId | file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX | |
| CategoryIds | array | 否 | 类目 ID 列表 | |
| string | 否 | 数据中心的类目 Id | ca_hiu2383nf934j | |
| SinkType | string | 是 | 索引存储类型 枚举值：
| DEFAULT |
| SinkInstanceId | string | 否 | 索引实例 ID（仅在索引存储类型是 ADB 时传入） | gp-bp321093j84 |
| SinkRegion | string | 否 | 索引实例地域（仅在索引存储类型是 ADB 时传入） | cn-hangzhou |
| Columns | array<object> | 否 | 结构化索引设置信息（依赖数据中心结构化，暂不开放） | |
| object | 否 | 结构化索引设置 | ||
| Column | string | 否 | 数据中心英文列名 | clomn_1 |
| Name | string | 否 | 数据中心实际列名 | 学校 |
| Type | string | 否 | 索引类型 枚举值：
| string |
| IsSearch | boolean | 否 | 是否参与检索:开启后表示在此列数据中进行搜索 | true |
| IsRecall | boolean | 否 | 是否参与模型回复:开启后表示被搜索到的数据行对应的本列数据提取出来给到大模型进行生成 | true |
| Description | string | 否 | 索引描述 | 这是索引的描述信息。 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "17204B98-7734-4F9A-8464-2446A84821CA",
"Data": {
"Id": "jkurxhju6b"
},
"Status": "200",
"Success": true,
"Message": "Invalid input, variable name is missing",
"Code": "Index.Forbidden"
}错误码
访问错误中心查看更多错误码。