文档

CreateDocumentCollection - 创建文档库

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

创建文档库。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
ManagerAccountstring

具有 rds_superuser 权限的管理账号名称。

说明 您可以通过控制台->账号管理来创建账号,或者通过 CreateAccount 接口创建。
testaccount
ManagerAccountPasswordstring

管理账号密码。

testpassword
Namespacestring

命名空间,默认为 public。

说明 您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
mynamespace
Collectionstring

要创建的文档库名称。

说明 名称需符合 PostgreSQL 对象名限制。
document
RegionIdstring

实例所在地域 ID。

cn-hangzhou
EmbeddingModelstring

向量化算法。

说明 支持的算法:
  • text-embedding-v1: 1536 维
  • text-embedding-v2: 1536 维
  • text2vec: 1024 维
  • m3e-base: 768 维
  • m3e-small: 512 维
  • multimodal-embedding-one-peace-v1: 1536 维, 图片向量化算法
  • 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
    FullTextRetrievalFieldsstring

    用于全文检索的字段,多个字段用英文逗号(,)分隔,且字段必须属于 Metadata 里定义的 key。

    title,page
    Metadatastring

    向量数据的元信息,为 MAP 格式的 JSON 字符串。其中 key 代表字段名,value 代表数据类型。

    警告 id、vector、doc_name、content、loader_metadata、source、to_tsvector 字段为保留字段,禁止使用。

    {"title":"text","page":"int"}
    Parserstring

    用于全文检索的分词器,默认为 zh_cn。

    zh_cn
    Metricsstring

    向量构建索引时的方法

    取值说明:

    • l2:欧氏距离。
    • ip:点积(内积)距离。
    • cosine(默认):余弦相似度。
    cosine
    HnswMinteger

    HNSW 算法中的最大邻居数,范围为 1~1000。接口会根据向量维度自动设置此值,一般不需要手动设置。

    说明 建议根据向量维度来设置:
  • 小于等于 384:16
  • 大于 384 小于等于 768:32
  • 大于 768 小于等于 1024:64
  • 大于 1024:128
  • 64
    PqEnableinteger

    索引是否开启 PQ(Product quantization)算法加速,数据量大于 50w 时建议开启。取值说明:

    • 0:关闭。
    • 1:开启(默认)。
    1
    ExternalStorageinteger

    是否使用 mmap 构建 HNSW 索引,默认为 0。如果数据不需要删除,且对上传数据的速度性能有要求时,建议设置为 1。

    说明
  • 为 0 时,默认会采用段页式存储构建索引,这种模式可以使用 PostgreSQL 中的 shared_buffer 做缓存,支持删除和更新等操作。
  • 为 1 时,该索引会采用 mmap 构建索引,该模式不支持删除更新等操作。
  • 0

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Messagestring

    返回信息。

    Successful
    Statusstring

    API 执行状态,取值如下:

    • success:执行成功。
    • fail:执行失败。
    successs

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-01-09OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ExternalStorage
    • 本页导读 (1)