You need to enable JavaScript to run this app.
导航

create_collection

最近更新时间2024.01.22 19:38:14

首次发布时间2023.11.09 18:59:54

概述

create_collection 用于创建一个新的数据集 Collection。创建成功后,可以写入数据。

说明

  • 每一个 Collection 必须指定主键字段。
  • 当定义字段 fields 添加了一个向量类型 vector 的字段后,再添加新的字段时,字段类型不可选择 vector 类型。因为目前只支持单向量,不可添加多个向量字段。
  • 当定义字段 fields 添加了带 pipeline_name 的 text 字段,则不允许添加 vector 字段,且只能有一个带 pipeline_name 的 text 字段;当定义字段 fields 添加了不带 pipeline_name 的 text 字段,则允许添加 vector 字段,且允许添加多个不带 pipeline_name 的 text 字段,text 字段最多200个。

请求参数

参数

子参数

类型

是否必选

默认值

参数说明

collection_name

string

指定创建的 Collection 名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • Collection 名称不能重复。

description

string

""

自定义 Collection 的描述。

  • 长度要求:[0, 65535]。

fields

说明

Field 实例的列表,一个 Collection 里的 Field 实例数量上限是 200。

field_name

string

指定自定义字段的名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • 字段名称不能重复。

field_type

string

指定自定义字段类型,如 FieldType.String,可选值详见 field_type 可选值说明。

default_val

和field_type一致

指定自定义字段默认值,默认值详见 field_type 可选值说明。

  • 当 field_name 作为主键时,default_val 不生效,同时也不会被校验。

dim

int

field_type 为vector 时必选

指定自定义字段向量维度。

  • 取值范围:[4, 2048],且必须是 4 的倍数。
  • 向量维度是指向量中包含的元素的数量。

is_primary_key

bool

False

指定该字段是否为主键,用户可以从 fields 定义的字段列表中选出某一个 int64 类型 / string 类型的字段作为主键字段。每个 Collection 有且仅有一个主键,其它字段 is_primary_key 默认为 False。

  • 枚举值:True/False。

pipeline_name

string

field_type 为 text 时可选

文本。纯文本预处理能力 pipeline 是指向量数据库将文本切片、文本向量化、入库、存储自动化的预处理流程。支持以string形式写入原始数据。
pipeline_name 枚举值如下:

  • text_split_bge_large_zh:向量数据库使用切分器将长文本切分成短文本,调用 embedding 模型将短文本向量化。
  • text_bge_large_zh:向量数据库不切分文本,直接调用 embedding 模型将文本向量化。

field_type 可选值

字段类型

可用索引类型

default_val默认值

数据写入时
取值范围

default_val
取值范围

可为主键

说明

int64

枚举

0

int64 范围

int64 范围

整数

float32

范围

0.0

float32 范围

float32 范围

浮点数

string

枚举

"default"

长度<=128

字符串

bool

枚举

false

true/false

true/false

布尔类型

list<string>

枚举

["default"]

List 长度<=32

List 长度<=32

字符串数组

list<int64>

枚举

[0]

List 长度<=32

List 长度<=32

整数数组

vector

向量

维度 4-2048

稠密向量。

  • field_type 设置为 vector 时必选参数 dim。

text

文本,注意事项:

  • field_type 设置为 text 时可选参数 pipeline_name。
  • 当定义字段 fields 添加了带 pipeline_name 的 text 字段,则不允许添加 vector 字段,且只能有一个带 pipeline_name 的 text 字段;当定义字段 fields 添加了不带 pipeline_name 的 text 字段,则允许添加 vector 字段,且允许添加多个不带 pipeline_name 的 text 字段,text 字段最多200个。

示例

请求参数

fields = [
    Field(
        field_name="doc_id",
        field_type=FieldType.String,
        is_primary_key=True//每个 Collection 有且仅有一个主键,其它字段 is_primary_key 默认为 False 且无需体现。
    ),
    Field(
        field_name="text_vector",
        field_type=FieldType.Vector,
        dim=12
    ),
    Field(
        field_name="like",
        field_type=FieldType.Int64,
        default_val=0
    ),
    Field(
        field_name="price",
        field_type=FieldType.Float32,
        default_val=0
    ),
    Field(
        field_name="author",
        field_type=FieldType.List_String,
        default_val=[]
    ),
    Field(
        field_name="aim",
        field_type=FieldType.Bool,
        default_val=True
    ),
]
res = vikingdb_service.create_collection("example", fields, "This is an example")

返回值

Python 调用执行上面的任务,返回 Collection 实例。Collection 实例包含的属性如下表所示。

属性

类型

说明

collection_name

string

Collection 名称。

description

string

Collection 的描述。

fields

List

字段列表。

indexes

List

索引列表。

stat

map

统计/状态信息。

  • data_number:数据量条数。
  • data_storage:数据占用的存储大小,单位是字节。

create_time

string

数据集创建时间。

update_time

string

数据集更新时间。

update_person

string

数据集更新人。