创建索引表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:CreateTable | create |
|
| 无 |
请求语法
POST /openapi/ha3/instances/{instanceId}/tables HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 id。 | ha-cn-pl32rf0**** |
| dryRun | boolean | 否 | 是否 dryRun 创建（仅校验数据源是否合法）。取值：-true 是 -false 否 | true |
| body | object | 否 | body | |
| name | string | 否 | 索引名 | api_index_1 |
| dataProcessorCount | integer | 否 | 数据更新资源数 | 1 |
| partitionCount | integer | 否 | 数据分片数 | 1 |
| dataSource | object | 否 | 数据源配置 | |
| type | string | 否 | 数据源类型: 仅支持 odps、swift、oss 三种类型 (odps, swift, saro, oss, unKnow) | odps |
| dataTimeSec | integer | 否 | 追增量时间戳 | 1715160176 |
| autoBuildIndex | boolean | 否 | 是否自动索引重建 | true |
| config | object | 否 | 数据源配置 | |
| endpoint | string | 否 | odps 相关 | http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api |
| accessKey | string | 否 | odps 数据源 ak | L***p |
| accessSecret | string | 否 | odps 数据源 ak secret | 5**9a6 |
| project | string | 否 | odps 数据源项目名称 | test_project |
| partition | string | 否 | 数据源为 odps 时必填 | ds=20220713 |
| table | string | 否 | saro、odps 相关 | test56 |
| ossPath | string | 否 | oss 数据源相关 | /opensearch/test.txt |
| bucket | string | 否 | oss bucket | test-bucket |
| rawSchema | string | 否 | 如果用户传了 rawSchema，则直接使用 rawSchema 作为 ha3 schema 结构，不用手动拼装 | {} |
| primaryKey | string | 否 | 主键字段 | id |
| fieldSchema | object | 否 | key: 字段名 | |
| string | 否 | map 结构 | { "id": "INT64", "source_image": "STRING", "namespace": "INT64", "source_image_vector": "MULTI_FLOAT" } | |
| vectorIndex | array<object> | 否 | 索引结构 | |
| vectorIndex | object | 否 | ||
| indexName | string | 否 | 索引结构名称 | test_index |
| vectorField | string | 否 | 向量字段 | source_image_vector |
| sparseIndexField | string | 否 | 稀疏向量下标字段 | sparse_indices |
| sparseValueField | string | 否 | 稀疏向量值字段 | sparse_values |
| dimension | string | 否 | 向量维度 | 128 |
| vectorIndexType | string | 否 | 向量索引算法 | Qc |
| distanceType | string | 否 | 距离类型 | SquaredEuclidean |
| namespace | string | 否 | 命名空间字段 | namespace |
| advanceParams | object | 否 | 索引结构配置 | |
| buildIndexParams | string | 否 | 索引构建参数 | {} |
| searchIndexParams | string | 否 | 索引检索参数 | {} |
| minScanDocCnt | string | 否 | 召回候选集的个数最小值 | 20000 |
| linearBuildThreshold | string | 否 | 线性构建的阈值 | 5000 |
| dataProcessConfig | array<object> | 否 | 字段处理配置 | |
| dataProcessConfig | object | 否 | 字段处理配置详细信息 | |
| operator | string | 否 | 字段处理方式 (copy: 将源字段拷贝至目标字段, vectorize: 使用模型对源字段进行向量化，向量存储在目标字段中) | vectorize |
| dstField | string | 否 | 目标字段 | source_image_vector |
| srcField | string | 否 | 源字段 | source_image |
| params | object | 否 | 配置模型信息 | |
| vectorModel | string | 否 | 向量化模型 | clip |
| vectorModal | string | 否 | 数据类型 | image |
| srcFieldConfig | object | 否 | 向量化信息来源 | |
| ossEndpoint | string | 否 | OSS 区域地址。 | oss-cn-hangzhou-internal.aliyuncs.com |
| ossBucket | string | 否 | OSSBucket | test-bucket |
| uid | string | 否 | 云账号 id | 1062017779051424 |
请求示例
POST /openapi/ha3/instances/{instanceId}/tables
{
"name": "api",
"partitionCount": 1,
"primaryKey": "id",
"fieldSchema": {
"id": "INT64",
"source_image": "STRING",
"namespace": "STRING",
"source_image_vector": "MULTI_FLOAT"
},
"vectorIndex": [
{
"indexName": "test_index_1",
"vectorField": "source_image_vector",
"vectorIndexType": "HNSW",
"dimension": "512",
"distanceType": "InnerProduct"
}
]
}
详情可参考响应结构
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
"result": {}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-18 | API 内部配置变更，不影响调用 | 查看变更详情 |