CreateKnowledgeBase 创建知识库-表格存储 Tablestore(Tablestore)-阿里云帮助中心

使用 CreateKnowledgeBase 接口在当前 AgentStorage 实例中创建一个新的知识库。创建后系统自动在实例中创建对应的 Document 表、Chunk 表和索引表，用于存储文档、切片和索引数据。

前提条件

已创建 AgentStorage 实例且状态为 normal，并获取实例访问地址（endpoint）和实例名。
已创建 API Key。

请求参数

参数	类型	说明
`knowledgeBaseName`	string	知识库名称（必填）。字母开头，仅允许字母、数字和下划线，长度 1--64 字符，不可重复
`description`	string	知识库描述，最大 4KB
`subspace`	boolean	是否开启子空间。默认 `false`，开启后所有文档操作和检索必须指定 `subspace` 字段。创建后不可修改
`tags`	list<string>	标签列表，总长度不超过 4KB
`metadata`	list<object>	元数据字段定义，详见下方说明
`embeddingConfiguration`	object	Embedding 配置，创建后不可修改。不传时默认使用百炼 `text-embedding-v4`（1024 维）
`retrievalConfiguration`	object	默认检索配置。`Retrieve` 不传配置时使用此处的设定，创建后可通过 `UpdateKnowledgeBase` 修改

metadata 字段定义

每个元素包含 name（字段名）和 type（字段类型）。metadata 字段定义在知识库创建后不可新增或删除；创建前应一次性规划需要用于过滤的字段。后续导入或更新文档的 metadata 值必须符合该定义。

定义项	说明
支持的类型	`string`、`long`、`double`、`boolean`、`date`、`string_list`、`long_list`、`double_list`、`boolean_list`、`date_list`
字段名	最大 128 UTF-8 字节，不能包含 `.`
字段数量	最多 200 个
保留字段	`_uid`、`_id`、`_type`、`_all`、`_parent`、`_routing`、`_index`、`_size`、`_timestamp`、`_ttl`、`_score`

embeddingConfiguration

参数	类型	说明
`provider`	string	模型提供方。默认 `bailian`（百炼内置），也支持 `custom`（自定义）
`model`	string	模型名称。默认 `text-embedding-v4`，百炼还支持 `text-embedding-v3`
`dimension`	int	向量维度。默认 1024
`apiKey`	string	仅 `custom` 模式需要
`url`	string	仅 `custom` 模式需要，需提前联系表格存储注册

retrievalConfiguration

参数	类型	说明
`searchType`	list<string>	检索类型。默认 `["DENSE_VECTOR", "FULL_TEXT"]`
`denseVectorSearchConfiguration.numberOfResults`	int	向量检索返回数量。默认 20
`fullTextSearchConfiguration.numberOfResults`	int	全文检索返回数量。默认 20
`rerankingConfiguration.type`	string	Rerank 类型：`RRF`、`WEIGHT` 或 `MODEL`。默认 `WEIGHT`
`rerankingConfiguration.numberOfResults`	int	Rerank 后返回的结果数。默认 20
`weightConfiguration.denseVectorSearchWeight`	double	向量检索加权比例。默认 0.7
`weightConfiguration.fullTextSearchWeight`	double	全文检索加权比例。默认 0.3
`rrfConfiguration.denseVectorSearchWeight`	double	RRF 模式下的向量检索权重。默认 1.0
`rrfConfiguration.fullTextSearchWeight`	double	RRF 模式下的全文检索权重。默认 1.0
`rrfConfiguration.k`	int	RRF 算法参数。默认 60，必须大于 0
`modelConfiguration.provider`	string	Rerank 模型提供方。默认 `bailian`，当前仅支持百炼
`modelConfiguration.model`	string	Rerank 模型名称。默认 `gte-rerank-v2`（新加坡地域默认 `qwen3-rerank`）

完整的检索配置说明参见检索和排序。

请求示例

使用 API Key 认证时，通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。

curl -X POST https://<endpoint>/CreateKnowledgeBase \
  -H "x-ots-instancename: <instance-name>" \
  -H "x-ots-apikey: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "knowledgeBaseName": "product_docs_kb",
    "description": "产品文档知识库",
    "subspace": true,
    "tags": ["产品", "文档"],
    "metadata": [
      {"name": "author", "type": "string"},
      {"name": "date", "type": "date"},
      {"name": "score", "type": "double"}
    ],
    "embeddingConfiguration": {
      "provider": "bailian",
      "model": "text-embedding-v4",
      "dimension": 1024
    },
    "retrievalConfiguration": {
      "searchType": ["DENSE_VECTOR", "FULL_TEXT"],
      "denseVectorSearchConfiguration": {"numberOfResults": 10},
      "fullTextSearchConfiguration": {"numberOfResults": 10},
      "rerankingConfiguration": {
        "type": "RRF",
        "numberOfResults": 5,
        "rrfConfiguration": {"denseVectorSearchWeight": 0.6, "fullTextSearchWeight": 0.4, "k": 60}
      }
    }
  }'

响应

{"code": "SUCCESS", "data": {}, "message": "succeed"}