xz-rag 0.1.1

Multi-channel Retrieval-Augmented Generation engine
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

use crate::error::RagError;

/// HYDE (Hypothetical Document Embeddings) query expansion.
///
/// Generates a hypothetical answer passage for vector retrieval.
/// Requires LLM integration (xz-provider feature).
pub struct HydeExpander;

impl HydeExpander {
    /// Create a new `HydeExpander`.
    pub fn new() -> Self {
        Self
    }

    /// Generate a hypothetical answer passage for the given query.
    #[cfg(feature = "hyde")]
    pub async fn expand(
        &self,
        query: &str,
        provider: &dyn xz_provider::LlmProvider,
    ) -> Result<String, RagError> {
        let prompt = format!(
            "Please write a passage that answers the following question:\n\nQuestion: {}\n\nPassage:",
            query
        );
        let request = xz_provider::CompletionRequest {
            messages: vec![xz_provider::Message::user(&prompt)],
            temperature: Some(0.7),
            max_tokens: Some(256),
            ..Default::default()
        };
        let response = provider
            .complete(request, xz_provider::RequestOptions::default())
            .await
            .map_err(|e| RagError::QueryPreprocessing(e.to_string()))?;

        Ok(response.content.unwrap_or_default())
    }

    /// Fallback when LLM is not available: returns query as-is.
    #[cfg(not(feature = "hyde"))]
    pub async fn expand(&self, query: &str) -> Result<String, RagError> {
        Ok(query.to_string())
    }
}

impl Default for HydeExpander {
    fn default() -> Self {
        Self::new()
    }
}