CreateDocumentCollection - 创建文档库 - 云原生数据仓库AnalyticDB

创建知识库。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:CreateDocumentCollection	create	*Collection `acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-xxxxxxxxx
ManagerAccount	string	是	具有 rds_superuser 权限的管理账号名称。说明您可以通过控制台->账号管理来创建账号，或者通过 CreateAccount 接口创建。	testaccount
ManagerAccountPassword	string	是	管理账号密码。	testpassword
Namespace	string	否	命名空间，默认为 public。说明您可以通过 CreateNamespace 接口创建，通过 ListNamespaces 接口查看列表。	mynamespace
Collection	string	是	要创建的文档库名称。说明名称需符合 PostgreSQL 对象名限制。	document
RegionId	string	是	实例所在地域 ID。	cn-hangzhou
EmbeddingModel	string	否	向量化算法。说明支持的算法： text-embedding-v1: 1536 维 text-embedding-v2: 1536 维 text2vec: 1024 维 m3e-base: 768 维 m3e-small: 512 维 clip-vit-b-32：CLIP ViT-B/32 模型, 512 维, 图片向量化算法 clip-vit-b-16：CLIP ViT-B/16 模型, 512 维, 图片向量化算法 clip-vit-l-14：CLIP ViT-L/14 模型, 768 维, 图片向量化算法 clip-vit-l-14-336px：CLIP ViT-L/14@336px 模型, 768 维, 图片向量化算法 clip-rn50：CLIP RN50 模型, 1024 维, 图片向量化算法 clip-rn101：CLIP RN101 模型, 512 维, 图片向量化算法 clip-rn50x4：CLIP RN50x4 模型, 640 维, 图片向量化算法 clip-rn50x16：CLIP RN50x16 模型, 768 维, 图片向量化算法 clip-rn50x64：CLIP RN50x64 模型, 1024 维, 图片向量化算法	text-embedding-v1
FullTextRetrievalFields	string	否	用于全文检索的字段，多个字段用英文逗号（,）分隔，且字段必须属于 Metadata 里定义的 key。	title,page
Metadata	string	否	向量数据的元信息，为 MAP 格式的 JSON 字符串。其中 key 代表字段名，value 代表数据类型。说明支持的数据类型数据类型列表详见：数据类型。其中 money 类型暂不支持。警告 id、vector、doc_name、content、loader_metadata、source、to_tsvector 字段为保留字段，禁止使用。	{"title":"text","page":"int"}
Parser	string	否	用于全文检索的分词器，默认为 zh_cn。	zh_cn
Metrics	string	否	向量构建索引时的方法取值说明： l2：欧氏距离。 ip：点积（内积）距离。 cosine（默认）：余弦相似度。	cosine
HnswM	integer	否	HNSW 算法中的最大邻居数，范围为 1～1000。接口会根据向量维度自动设置此值，一般不需要手动设置。说明建议根据向量维度来设置：小于等于 384：16 大于 384 小于等于 768：32 大于 768 小于等于 1024：64 大于 1024：128	64
PqEnable	integer	否	索引是否开启 PQ(Product quantization)算法加速，数据量大于 50w 时建议开启。取值说明： 0：关闭。 1：开启(默认)。	1
ExternalStorage	integer	否	是否使用 mmap 构建 HNSW 索引，默认为 0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为 1。说明为 0 时，默认会采用段页式存储构建索引，这种模式可以使用 PostgreSQL 中的 shared_buffer 做缓存，支持删除和更新等操作。为 1 时，该索引会采用 mmap 构建索引，该模式不支持删除更新等操作。	0
MetadataIndices	string	否	标量索引字段，多个字段用英文逗号（,）分隔，且字段必须属于 Metadata 里定义的 key。	title

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返回信息。	Successful
Status	string	API 执行状态，取值如下： success：执行成功。 fail：执行失败。	successs

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "successs"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-01-09	OpenAPI 入参发生变更	查看变更详情