weaviate-community 0.2.2

Community client for handling Weaviate vector database transactions written in Rust, for Rust.
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

/// All modules (contextionary) associated type components
use serde::{Deserialize, Serialize};

/// The expected response format when received from /v1/modules/text2vec-contextionary/concepts/{}
/// successfully.
///
/// This shouldn't be something you create yourself, as it is returned by the appropriate
/// endpoint when deserialized.
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct ContextionaryConcept {
    pub individual_words: Vec<IndividualWords>,
}

/// Forms part of the expected response format when received from 
/// /v1/modules/text2vec-contextionary/concepts/{} successfully.
///
/// This shouldn't be something you create yourself, as it is returned by the appropriate
/// endpoint when deserialized.
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct IndividualWords {
    pub info: Option<ContextionaryConceptInfo>,
    pub present: Option<bool>,
    pub word: String,
    pub concatenated_word: Option<ConcatenatedWord>,
}

/// Forms part of the expected response format when received from 
/// /v1/modules/text2vec-contextionary/concepts/{} successfully.
///
/// This shouldn't be something you create yourself, as it is returned by the appropriate
/// endpoint when deserialized.
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct ContextionaryConceptInfo {
    pub nearest_neighbors: Vec<IndividualWord>,
    pub vector: Vec<f64>,
}

/// Forms part of the expected response format when received from 
/// /v1/modules/text2vec-contextionary/concepts/{} successfully.
///
/// This shouldn't be something you create yourself, as it is returned by the appropriate
/// endpoint when deserialized.
#[derive(Serialize, Deserialize, Debug)]
pub struct IndividualWord {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub distance: Option<f64>,
    pub word: String,
}

/// Forms part of the expected response format when received from 
/// /v1/modules/text2vec-contextionary/concepts/{} successfully.
///
/// This shouldn't be something you create yourself, as it is returned by the appropriate
/// endpoint when deserialized.
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct ConcatenatedWords {
    concatenated_word: ConcatenatedWord,
}

/// Forms part of the expected response format when received from 
/// /v1/modules/text2vec-contextionary/concepts/{} successfully.
///
/// This shouldn't be something you create yourself, as it is returned by the appropriate
/// endpoint when deserialized.
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct ConcatenatedWord {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    single_words: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    concatenated_vector: Option<Vec<f64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    concatenated_nearest_neighbors: Option<Vec<IndividualWord>>,
}

/// ContextionaryExtension object for extending contextionary
#[derive(Serialize, Deserialize, Debug)]
pub struct ContextionaryExtension {
    pub concept: String,
    pub definition: String,
    pub weight: f64,
}

impl ContextionaryExtension {
    /// Create a new ContextionaryExtension object
    ///
    /// # Example
    /// ```no_run
    /// use weaviate_community::collections::modules::ContextionaryExtension;
    ///
    /// let ext = ContextionaryExtension::new("concept", "description", 1.0);
    /// ```
    pub fn new(concept: &str, definition: &str, weight: f64) -> ContextionaryExtension {
        ContextionaryExtension { concept: concept.into(), definition: definition.into(), weight }
    }
}