implement conversions for inference objects (#226)

* implement conversions for inference objects

* fmt

* Update src/builders/document_builder.rs

Co-authored-by: Tim Visée <tim@visee.me>

* Update src/builders/image_builder.rs

Co-authored-by: Tim Visée <tim@visee.me>

---------

Co-authored-by: Tim Visée <tim@visee.me>

Author: generall

src/builders/document_builder.rs

@@ -0,0 +1,52 @@
+use std::collections::HashMap;
+
+use crate::qdrant::{Document, Value};
+
+impl Document {
+    pub fn new(text: impl Into<String>, model: impl Into<String>) -> Self {
+        Self {
+            text: text.into(),
+            model: model.into(),
+            options: HashMap::new(),
+        }
+    }
+}
+
+pub struct DocumentBuilder {
+    text: String,
+    model: String,
+    options: HashMap<String, Value>,
+}
+
+impl DocumentBuilder {
+    pub fn new(text: impl Into<String>, model: impl Into<String>) -> Self {
+        Self {
+            text: text.into(),
+            model: model.into(),
+            options: HashMap::new(),
+        }
+    }
+
+    pub fn text(mut self, text: impl Into<String>) -> Self {
+        self.text = text.into();
+        self
+    }
+
+    pub fn model(mut self, model: impl Into<String>) -> Self {
+        self.model = model.into();
+        self
+    }
+
+    pub fn options(mut self, options: HashMap<String, Value>) -> Self {
+        self.options = options;
+        self
+    }
+
+    pub fn build(self) -> Document {
+        Document {
+            text: self.text,
+            model: self.model,
+            options: self.options,
+        }
+    }
+}

src/builders/image_builder.rs

@@ -0,0 +1,76 @@
+use std::collections::HashMap;
+
+use crate::qdrant::{value, Image, Value};
+
+impl Image {
+    pub fn new_from_url(url: impl Into<String>, model: impl Into<String>) -> Self {
+        Self {
+            image: Some(Value {
+                kind: Some(value::Kind::StringValue(url.into())),
+            }),
+            model: model.into(),
+            options: HashMap::new(),
+        }
+    }
+
+    pub fn new_from_base64(base64: impl Into<String>, model: impl Into<String>) -> Self {
+        Self {
+            image: Some(Value {
+                kind: Some(value::Kind::StringValue(base64.into())),
+            }),
+            model: model.into(),
+            options: HashMap::new(),
+        }
+    }
+}
+
+pub struct ImageBuilder {
+    image: Option<Value>,
+    model: String,
+    options: HashMap<String, Value>,
+}
+
+impl ImageBuilder {
+    pub fn new_from_url(url: impl Into<String>, model: impl Into<String>) -> Self {
+        Self {
+            image: Some(Value {
+                kind: Some(value::Kind::StringValue(url.into())),
+            }),
+            model: model.into(),
+            options: HashMap::new(),
+        }
+    }
+
+    pub fn new_from_base64(base64: impl Into<String>, model: impl Into<String>) -> Self {
+        Self {
+            image: Some(Value {
+                kind: Some(value::Kind::StringValue(base64.into())),
+            }),
+            model: model.into(),
+            options: HashMap::new(),
+        }
+    }
+
+    pub fn image(mut self, image: Value) -> Self {
+        self.image = Some(image);
+        self
+    }
+
+    pub fn model(mut self, model: impl Into<String>) -> Self {
+        self.model = model.into();
+        self
+    }
+
+    pub fn options(mut self, options: HashMap<String, Value>) -> Self {
+        self.options = options;
+        self
+    }
+
+    pub fn build(self) -> Image {
+        Image {
+            image: self.image,
+            model: self.model,
+            options: self.options,
+        }
+    }
+}

src/builders/mod.rs

@@ -237,3 +237,9 @@ pub use sparse_vector_builder::SparseVectorBuilder;
 
 pub mod multi_dense_vector_builder;
 pub use multi_dense_vector_builder::MultiDenseVectorBuilder;
+
+pub mod document_builder;
+pub use document_builder::DocumentBuilder;
+
+pub mod image_builder;
+pub use image_builder::ImageBuilder;

src/qdrant_client/conversions/vector_input.rs

@@ -1,4 +1,4 @@
-use crate::qdrant::{PointId, VectorInput};
+use crate::qdrant::{vector_input, Document, Image, InferenceObject, PointId, VectorInput};
 
 impl<T: Into<PointId>> From<T> for VectorInput {
     fn from(value: T) -> Self {
@@ -24,3 +24,27 @@ impl From<Vec<Vec<f32>>> for VectorInput {
         Self::new_multi(value)
     }
 }
+
+impl From<Document> for VectorInput {
+    fn from(value: Document) -> Self {
+        VectorInput {
+            variant: Some(vector_input::Variant::Document(value)),
+        }
+    }
+}
+
+impl From<Image> for VectorInput {
+    fn from(value: Image) -> Self {
+        VectorInput {
+            variant: Some(vector_input::Variant::Image(value)),
+        }
+    }
+}
+
+impl From<InferenceObject> for VectorInput {
+    fn from(value: InferenceObject) -> Self {
+        VectorInput {
+            variant: Some(vector_input::Variant::Object(value)),
+        }
+    }
+}

src/qdrant_client/conversions/vectors.rs

@@ -1,7 +1,7 @@
 use std::collections::HashMap;
 
 use crate::qdrant::vectors::VectorsOptions;
-use crate::qdrant::{NamedVectors, Vector, Vectors};
+use crate::qdrant::{vector, Document, Image, InferenceObject, NamedVectors, Vector, Vectors};
 
 impl From<Vec<f32>> for Vector {
     fn from(vector: Vec<f32>) -> Self {
@@ -139,3 +139,93 @@ impl From<NamedVectors> for VectorsOptions {
         Self::Vectors(value)
     }
 }
+
+impl From<Document> for Vector {
+    fn from(value: Document) -> Self {
+        Vector {
+            vector: Some(vector::Vector::Document(value)),
+            ..Default::default()
+        }
+    }
+}
+
+impl From<Document> for Vectors {
+    fn from(value: Document) -> Self {
+        Vectors {
+            vectors_options: Some(VectorsOptions::Vector(Vector::from(value))),
+        }
+    }
+}
+
+impl From<HashMap<String, Document>> for Vectors {
+    fn from(value: HashMap<String, Document>) -> Self {
+        Vectors {
+            vectors_options: Some(VectorsOptions::Vectors(NamedVectors {
+                vectors: value
+                    .into_iter()
+                    .map(|(k, v)| (k, Vector::from(v)))
+                    .collect(),
+            })),
+        }
+    }
+}
+
+impl From<Image> for Vector {
+    fn from(value: Image) -> Self {
+        Vector {
+            vector: Some(vector::Vector::Image(value)),
+            ..Default::default()
+        }
+    }
+}
+
+impl From<Image> for Vectors {
+    fn from(value: Image) -> Self {
+        Vectors {
+            vectors_options: Some(VectorsOptions::Vector(Vector::from(value))),
+        }
+    }
+}
+
+impl From<HashMap<String, Image>> for Vectors {
+    fn from(value: HashMap<String, Image>) -> Self {
+        Vectors {
+            vectors_options: Some(VectorsOptions::Vectors(NamedVectors {
+                vectors: value
+                    .into_iter()
+                    .map(|(k, v)| (k, Vector::from(v)))
+                    .collect(),
+            })),
+        }
+    }
+}
+
+impl From<InferenceObject> for Vector {
+    fn from(value: InferenceObject) -> Self {
+        Vector {
+            vector: Some(vector::Vector::Object(value)),
+            ..Default::default()
+        }
+    }
+}
+
+impl From<InferenceObject> for Vectors {
+    fn from(value: InferenceObject) -> Self {
+        Vectors {
+            vectors_options: Some(VectorsOptions::Vector(Vector::from(value))),
+        }
+    }
+}
+
+impl From<HashMap<String, InferenceObject>> for Vectors {
+    fn from(value: HashMap<String, InferenceObject>) -> Self {
+        Vectors {
+            vectors_options: Some(VectorsOptions::Vectors(NamedVectors {
+                vectors: value
+                    .into_iter()
+                    .map(|(k, v)| (k, Vector::from(v)))
+                    .collect(),
+            })),
+        }
+    }
+}

tests/snippet_tests/mod.rs

@@ -26,6 +26,8 @@ mod test_get_points;
 mod test_list_full_snapshots;
 mod test_list_snapshots;
 mod test_overwrite_payload;
+mod test_query_document;
+mod test_query_image;
 mod test_query_points;
 mod test_query_points_groups;
 mod test_recommend_batch_points;
@@ -41,4 +43,6 @@ mod test_set_payload;
 mod test_update_aliases;
 mod test_update_collection;
 mod test_update_vectors;
+mod test_upsert_document;
+mod test_upsert_image;
 mod test_upsert_points;

tests/snippet_tests/test_query_document.rs

@@ -0,0 +1,26 @@
+
+#[tokio::test]
+async fn test_query_document() {
+    async fn query_document() -> Result<(), Box<dyn std::error::Error>> {
+      // WARNING: This is a generated test snippet.
+      // Please, modify the snippet in the `../snippets/query_document.rs` file
+        use qdrant_client::qdrant::{Document, Query, QueryPointsBuilder};
+        use qdrant_client::Qdrant;
+        
+        let client = Qdrant::from_url("http://localhost:6334").build()?;
+        
+        let query_document = Document::new(
+            "my query text",
+            "sentence-transformers/all-minilm-l6-v2"
+        );
+        
+        let query_request = QueryPointsBuilder::new("{collection_name}")
+            .query(Query::new_nearest(query_document));
+        
+        // ANN search with server-side inference
+        client.query(query_request).await?;
+        
+        Ok(())
+    }
+    let _ = query_document().await;
+}

tests/snippet_tests/test_query_image.rs

@@ -0,0 +1,26 @@
+
+#[tokio::test]
+async fn test_query_image() {
+    async fn query_image() -> Result<(), Box<dyn std::error::Error>> {
+      // WARNING: This is a generated test snippet.
+      // Please, modify the snippet in the `../snippets/query_image.rs` file
+        use qdrant_client::qdrant::{Image, Query, QueryPointsBuilder};
+        use qdrant_client::Qdrant;
+        
+        let client = Qdrant::from_url("http://localhost:6334").build()?;
+        
+        let query_image = Image::new_from_url(
+            "https://picsum.photos/200/300.jpg",
+            "Qdrant/clip-ViT-B-32-vision"
+        );
+        
+        let query_request = QueryPointsBuilder::new("{collection_name}")
+            .query(Query::new_nearest(query_image));
+        
+        // ANN search with server-side inference
+        client.query(query_request).await?;
+        
+        Ok(())
+    }
+    let _ = query_image().await;
+}

tests/snippet_tests/test_upsert_document.rs

@@ -0,0 +1,36 @@
+
+#[tokio::test]
+async fn test_upsert_document() {
+    async fn upsert_document() -> Result<(), Box<dyn std::error::Error>> {
+      // WARNING: This is a generated test snippet.
+      // Please, modify the snippet in the `../snippets/upsert_document.rs` file
+        use qdrant_client::qdrant::{PointStruct, UpsertPointsBuilder, Document};
+        use qdrant_client::{Qdrant, Payload};
+        use serde_json::json;
+        
+        let client = Qdrant::from_url("http://localhost:6334").build()?;
+        
+        let document = Document::new("my document", "sentence-transformers/all-minilm-l6-v2");
+        
+        client
+            .upsert_points(
+                UpsertPointsBuilder::new(
+                    "{collection_name}",
+                    vec![
+                        PointStruct::new(
+                            1,
+                            document,
+                            Payload::try_from(json!(
+                                {"color": "red"}
+                            ))
+                            .unwrap(),
+                        )
+                    ],
+                )
+                .wait(true),
+            )
+            .await?;
+        Ok(())
+    }
+    let _ = upsert_document().await;
+}