tcvectordb 0.1.9

Rust SDK for Tencent Cloud VectorDB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum FieldType {
    #[serde(rename = "uint64")]
    Uint64,
    #[serde(rename = "string")]
    String,
    #[serde(rename = "array")]
    Array,
    #[serde(rename = "json")]
    Json,
    #[serde(rename = "vector")]
    Vector,
    #[serde(rename = "float16_vector")]
    Float16Vector,
    #[serde(rename = "bfloat16_vector")]
    BFloat16Vector,
    #[serde(rename = "binary_vector")]
    BinaryVector,
    #[serde(rename = "sparseVector")]
    SparseVector,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum MetricType {
    #[serde(rename = "L2")]
    L2,
    #[serde(rename = "IP")]
    IP,
    #[serde(rename = "COSINE")]
    COSINE,
    #[serde(rename = "Hamming")]
    HAMMING,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum IndexType {
    // Vector index types
    #[serde(rename = "FLAT")]
    FLAT,
    #[serde(rename = "HNSW")]
    HNSW,
    #[serde(rename = "IVF_FLAT")]
    IVF_FLAT,
    #[serde(rename = "IVF_PQ")]
    IVF_PQ,
    #[serde(rename = "IVF_SQ4")]
    IVF_SQ4,
    #[serde(rename = "IVF_SQ8")]
    IVF_SQ8,
    #[serde(rename = "IVF_SQ16")]
    IVF_SQ16,
    #[serde(rename = "BIN_FLAT")]
    BIN_FLAT,
    #[serde(rename = "BIN_HNSW")]
    BIN_HNSW,
    
    // Scalar index types
    #[serde(rename = "primaryKey")]
    PRIMARY_KEY,
    #[serde(rename = "filter")]
    FILTER,
    #[serde(rename = "inverted")]
    SPARSE_INVERTED,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum ReadConsistency {
    #[serde(rename = "strongConsistency")]
    StrongConsistency,
    #[serde(rename = "eventualConsistency")]
    EventualConsistency,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum EmbeddingModel {
    #[serde(rename = "bge-base-zh")]
    BgeBaseZh,
    #[serde(rename = "m3e-base")]
    M3eBase,
    #[serde(rename = "text2vec-large-chinese")]
    Text2VecLargeChinese,
    #[serde(rename = "e5-large-v2")]
    E5LargeV2,
    #[serde(rename = "multilingual-e5-base")]
    MultilingualE5Base,
}

impl EmbeddingModel {
    pub fn dimensions(&self) -> usize {
        match self {
            EmbeddingModel::BgeBaseZh => 768,
            EmbeddingModel::M3eBase => 768,
            EmbeddingModel::Text2VecLargeChinese => 1024,
            EmbeddingModel::E5LargeV2 => 1024,
            EmbeddingModel::MultilingualE5Base => 768,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Embedding {
    #[serde(rename = "vectorField")]
    pub vector_field: String,
    #[serde(rename = "field")]
    pub field: String,
    #[serde(rename = "model", skip_serializing_if = "Option::is_none")]
    pub model: Option<EmbeddingModel>,
    #[serde(rename = "modelName", skip_serializing_if = "Option::is_none")]
    pub model_name: Option<String>,
}

impl Embedding {
    pub fn new(vector_field: impl Into<String>, field: impl Into<String>) -> Self {
        Self {
            vector_field: vector_field.into(),
            field: field.into(),
            model: None,
            model_name: None,
        }
    }

    pub fn with_model(mut self, model: EmbeddingModel) -> Self {
        self.model = Some(model);
        self
    }

    pub fn with_model_name(mut self, model_name: impl Into<String>) -> Self {
        self.model_name = Some(model_name.into());
        self
    }
}