pgml 1.1.1

The official pgml Rust SDK
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use crate::model::Model;
use crate::splitter::Splitter;
use crate::types::Json;
use crate::Pipeline;

#[cfg(feature = "python")]
use crate::{model::ModelPython, splitter::SplitterPython, types::JsonPython};

#[allow(dead_code)]
fn build_pipeline(
    name: &str,
    model: Option<Model>,
    splitter: Option<Splitter>,
    parameters: Option<Json>,
) -> Pipeline {
    let parameters = parameters.unwrap_or_default();
    let schema = if let Some(model) = model {
        let mut schema = serde_json::json!({
            "text": {
                "semantic_search": {
                    "model": model.name,
                    "parameters": model.parameters,
                    "hnsw": parameters["hnsw"]
                }
            }
        });
        if let Some(splitter) = splitter {
            schema["text"]["splitter"] = serde_json::json!({
                "model": splitter.name,
                "parameters": splitter.parameters
            });
        }
        if parameters["full_text_search"]["active"]
            .as_bool()
            .unwrap_or_default()
        {
            schema["text"]["full_text_search"] = serde_json::json!({
                "configuration": parameters["full_text_search"]["configuration"].as_str().map(|v| v.to_string()).unwrap_or_else(|| "english".to_string())
            });
        }
        Some(schema.into())
    } else {
        None
    };
    Pipeline::new(name, schema).expect("Error converting pipeline into new multifield pipeline")
}

#[cfg(feature = "python")]
#[pyo3::prelude::pyfunction]
#[allow(non_snake_case)] // This doesn't seem to be working
pub fn SingleFieldPipeline(
    name: &str,
    model: Option<ModelPython>,
    splitter: Option<SplitterPython>,
    parameters: Option<JsonPython>,
) -> Pipeline {
    let model = model.map(|m| *m.wrapped);
    let splitter = splitter.map(|s| *s.wrapped);
    let parameters = parameters.map(|p| p.wrapped);
    build_pipeline(name, model, splitter, parameters)
}

#[cfg(feature = "javascript")]
#[allow(non_snake_case)]
pub fn SingleFieldPipeline<'a>(
    mut cx: neon::context::FunctionContext<'a>,
) -> neon::result::JsResult<'a, neon::types::JsValue> {
    use rust_bridge::javascript::{FromJsType, IntoJsResult};
    let name = cx.argument(0)?;
    let name = String::from_js_type(&mut cx, name)?;

    let model = cx.argument_opt(1);
    let model = <Option<crate::model::Model>>::from_option_js_type(&mut cx, model)?;

    let splitter = cx.argument_opt(2);
    let splitter = <Option<crate::splitter::Splitter>>::from_option_js_type(&mut cx, splitter)?;

    let parameters = cx.argument_opt(3);
    let parameters = <Option<crate::types::Json>>::from_option_js_type(&mut cx, parameters)?;

    let pipeline = build_pipeline(&name, model, splitter, parameters);
    let x = crate::pipeline::PipelineJavascript::from(pipeline);
    x.into_js_result(&mut cx)
}

mod tests {
    #[test]
    fn pipeline_to_pipeline() -> anyhow::Result<()> {
        use super::*;
        use serde_json::json;

        let model = Model::new(
            Some("test_model".to_string()),
            Some("pgml".to_string()),
            Some(
                json!({
                    "test_parameter": 10
                })
                .into(),
            ),
        );
        let splitter = Splitter::new(
            Some("test_splitter".to_string()),
            Some(
                json!({
                "test_parameter": 11
                })
                .into(),
            ),
        );
        let parameters = json!({
            "full_text_search": {
                "active": true,
                "configuration": "test_configuration"
            },
            "hnsw": {
                "m": 16,
                "ef_construction": 64
            }
        });
        let pipeline = build_pipeline(
            "test_name",
            Some(model),
            Some(splitter),
            Some(parameters.into()),
        );
        let schema = json!({
            "text": {
                "splitter": {
                    "model": "test_splitter",
                    "parameters": {
                        "test_parameter": 11
                    }
                },
                "semantic_search": {
                    "model": "test_model",
                    "parameters": {
                        "test_parameter": 10
                    },
                    "hnsw": {
                        "m": 16,
                        "ef_construction": 64
                    }
                },
                "full_text_search": {
                    "configuration": "test_configuration"
                }
            }
        });
        assert_eq!(schema, pipeline.schema.unwrap().0);
        Ok(())
    }
}