create
功能描述
创建一个OpenGaussDB对象。
函数原型
@classmethod def create(**kwargs)
输入参数说明

此方法所有入参均需要通过关键字参数传递
参数名 |
数据类型 |
可选/必选 |
说明 |
---|---|---|---|
engine |
Engine |
必选 |
kwargs中的参数,参考类功能的入参,必选参数必须传入,否则将抛出KeyError。 |
params |
dict |
可选 |
索引类型的额外参数,默认为{},对应add_index方法参数中的params,参考opengauss向量索引介绍。参数配置多一层类型"sparse"、"dense"用于指示对应是参数是给稠密或稀疏检索使用。配置示例如下: {"dense": {"lists": 200}, "sparse": {"m": 16, "ef_construction": 64} } |
dense_dim |
int |
可选 |
稠密向量维度。 |
sparse_dim |
int |
可选 |
稀疏向量维度,默认为100000。具体请根据稀疏向量模型词库规模进行设置,如bge-m3稀疏模型词库规模为250002。 |
index_type |
str |
可选 |
向量检索类型,当前支持IVFFLAT, HNSW,默认为HNSW,该字段稠密检索和混合检索模式时,针对稠密向量有效。稀疏向量检索类型固定为HNSW,不支持配置。 |
metric_type |
str |
可选 |
向量距离计算方式,支持IP,L2,COSINE,默认为IP。 |
collection_name |
str |
可选 |
集合名称。 |
search_mode |
SearchMode |
可选 |
检索模式,当前支持三种模式,包括稠密检索(DENSE),稀疏检索(SPARSE)和混合检索(HYBRID)。 类型介绍可参见SearchMode。 |
返回值说明
数据类型 |
说明 |
---|---|
OpenGaussDB |
OpenGaussDB对象。 |
父主题: OpenGaussDB类