Make add_document's opt argument be a Rust Option

examples/vector_store_surrealdb/src/main.rs

@@ -65,7 +65,7 @@ async fn main() {
     let doc4 = Document::new("Capital of France is Paris.");
 
     store
-        .add_documents(&vec![doc1, doc2, doc3, doc4], &VecStoreOptions::default())
+        .add_documents(&vec![doc1, doc2, doc3, doc4], None)
         .await
         .unwrap();
 

src/chain/conversational_retrieval_qa/conversational_retrieval_qa.rs

@@ -70,7 +70,12 @@ impl ConversationalRetrieverChain {
 impl Chain for ConversationalRetrieverChain {
     async fn call(&self, input_variables: PromptArgs) -> Result<GenerateResult, ChainError> {
         let output = self.execute(input_variables).await?;
-        let result: GenerateResult = serde_json::from_value(output[DEFAULT_RESULT_KEY].clone())?;
+        let mut result: GenerateResult = serde_json::from_value(output[DEFAULT_RESULT_KEY].clone())?;
+
+        if let Ok(sources) = serde_json::from_value(output[CONVERSATIONAL_RETRIEVAL_QA_DEFAULT_SOURCE_DOCUMENT_KEY].clone()) {
+            result.sources = Some(sources);
+        }
+
         Ok(result)
     }
 

src/chain/sql_datbase/chain.rs

@@ -180,6 +180,7 @@ impl Chain for SQLDatabaseChain {
         Ok(GenerateResult {
             generation: output.to_string(),
             tokens: token_usage,
+            sources: None,
         })
     }
 

src/language_models/mod.rs

@@ -8,12 +8,15 @@ pub mod options;
 mod error;
 pub use error::*;
 
+use crate::schemas::Document;
+
 //TODO: check if its this should have a data:serde::Value to save all other things, like OpenAI
 //function responses
 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 pub struct GenerateResult {
     pub tokens: Option<TokenUsage>,
     pub generation: String,
+    pub sources: Option<Vec<Document>>,
 }
 
 impl GenerateResult {

src/llm/claude/client.rs

@@ -117,7 +117,7 @@ impl Claude {
             total_tokens: res.usage.input_tokens + res.usage.output_tokens,
         });
 
-        Ok(GenerateResult { tokens, generation })
+        Ok(GenerateResult { tokens, generation, sources: None })
     }
 
     fn build_payload(&self, messages: &[Message], stream: bool) -> Payload {

src/llm/ollama/client.rs

@@ -115,7 +115,7 @@ impl LLM for Ollama {
             }
         });
 
-        Ok(GenerateResult { tokens, generation })
+        Ok(GenerateResult { tokens, generation, sources: None })
     }
 
     async fn stream(

src/vectorstore/opensearch/opensearch.rs

@@ -104,10 +104,15 @@ impl VectorStore for Store {
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &Self::Options,
+        opt: Option<&Self::Options>,
     ) -> Result<Vec<String>, Box<dyn Error>> {
+        let embedder = if let Some(options) = opt {
+            options.embedder.as_ref().unwrap_or(&self.embedder)
+        } else {
+            &self.embedder
+        };
+
         let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
-        let embedder = opt.embedder.as_ref().unwrap_or(&self.embedder);
         let vectors = embedder.embed_documents(&texts).await?;
 
         if vectors.len() != docs.len() {

src/vectorstore/pgvector/pgvector.rs

@@ -183,17 +183,24 @@ impl VectorStore for Store {
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &PgOptions,
+        opt: Option<&PgOptions>,
     ) -> Result<Vec<String>, Box<dyn Error>> {
-        if opt.score_threshold.is_some() || opt.filters.is_some() || opt.name_space.is_some() {
-            return Err(Box::new(std::io::Error::new(
-                std::io::ErrorKind::Other,
-                "score_threshold, filters, and name_space are not supported in pgvector",
-            )));
+        if let Some(option) = opt {
+            if option.score_threshold.is_some() || option.filters.is_some() || option.name_space.is_some() {
+                return Err(Box::new(std::io::Error::new(
+                    std::io::ErrorKind::Other,
+                    "score_threshold, filters, and name_space are not supported in pgvector",
+                )));
+            }
         }
-        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
 
-        let embedder = opt.embedder.as_ref().unwrap_or(&self.embedder);
+        let embedder = if let Some(options) = opt {
+            options.embedder.as_ref().unwrap_or(&self.embedder)
+        } else {
+            &self.embedder
+        };
+
+        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
 
         let vectors = embedder.embed_documents(&texts).await?;
 

src/vectorstore/qdrant/qdrant.rs

@@ -38,9 +38,14 @@ impl VectorStore for Store {
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &QdrantOptions,
+        opt: Option<&QdrantOptions>,
     ) -> Result<Vec<String>, Box<dyn Error>> {
-        let embedder = opt.embedder.as_ref().unwrap_or(&self.embedder);
+        let embedder = if let Some(options) = opt {
+            options.embedder.as_ref().unwrap_or(&self.embedder)
+        } else {
+            &self.embedder
+        };
+
         let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
 
         let ids = docs.iter().map(|_| Uuid::new_v4().to_string());

src/vectorstore/sqlite_vec/sqlite_vec.rs

@@ -92,11 +92,15 @@ impl VectorStore for Store {
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &Self::Options,
+        opt: Option<&Self::Options>,
     ) -> Result<Vec<String>, Box<dyn Error>> {
-        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
+        let embedder = if let Some(options) = opt {
+            options.embedder.as_ref().unwrap_or(&self.embedder)
+        } else {
+            &self.embedder
+        };
 
-        let embedder = opt.embedder.as_ref().unwrap_or(&self.embedder);
+        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
 
         let vectors = embedder.embed_documents(&texts).await?;
         if vectors.len() != docs.len() {

src/vectorstore/sqlite_vss/sqlite_vss.rs

@@ -80,11 +80,15 @@ impl VectorStore for Store {
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &Self::Options,
+        opt: Option<&Self::Options>,
     ) -> Result<Vec<String>, Box<dyn Error>> {
-        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
+         let embedder = if let Some(options) = opt {
+            options.embedder.as_ref().unwrap_or(&self.embedder)
+        } else {
+            &self.embedder
+        };
 
-        let embedder = opt.embedder.as_ref().unwrap_or(&self.embedder);
+        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
 
         let vectors = embedder.embed_documents(&texts).await?;
         if vectors.len() != docs.len() {

src/vectorstore/surrealdb/surrealdb.rs

@@ -93,14 +93,20 @@ impl<C: Connection> Store<C> {
 impl<C: Connection> VectorStore for Store<C> {
     type Options = VecStoreOptions<Value>;
 
+    /// Only uses `embedder` from passed options.
+    /// (Defaults to the connected `VectorStore`'s previously configured embedder.)
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &Self::Options,
+        opt: Option<&Self::Options>,
     ) -> Result<Vec<String>, Box<dyn Error>> {
-        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
+        let embedder = if let Some(options) = opt {
+            options.embedder.as_ref().unwrap_or(&self.embedder)
+        } else {
+            &self.embedder
+        };
 
-        let embedder = opt.embedder.as_ref().unwrap_or(&self.embedder);
+        let texts: Vec<String> = docs.iter().map(|d| d.page_content.clone()).collect();
 
         let vectors = embedder.embed_documents(&texts).await?;
         if vectors.len() != docs.len() {

src/vectorstore/vectorstore.rs

@@ -15,7 +15,7 @@ pub trait VectorStore: Send + Sync {
     async fn add_documents(
         &self,
         docs: &[Document],
-        opt: &Self::Options,
+        opt: Option<&Self::Options>,
     ) -> Result<Vec<String>, Box<dyn Error>>;
 
     async fn similarity_search(