txtai 9.8.0

Rust client for txtai
Documentation
use serde_json::json;

pub use crate::api::{API, IndexResults, IndexResultsBatch};

/// Similarity definition
pub struct Similarity {
    api: API
}

/// Similarity implementation
impl Similarity {
    /// Creates a Similarity instance.
    /// 
    pub fn new() -> Similarity {
        Similarity { 
            api: API::new()
        }
    }

    /// Creates a Similarity instance.
    /// 
    /// # Arguments
    /// * `url` - API url
    pub fn with_url(url: &str) -> Similarity {
        Similarity {
            api: API::with_url(url) 
        }
    }

    /// Creates a Similarity instance.
    /// 
    /// # Arguments
    /// * `url` - API url
    /// * `token` - API token
    pub fn with_url_token(url: &str, token: &str) -> Similarity {
        Similarity {
            api: API::with_url_token(url, token)
        }
    }

    /// Computes the similarity between query and list of text. Returns a list of
    /// {id: value, score: value} sorted by highest score, where id is the index
    /// in texts.
    ///
    /// # Arguments
    /// * `query` - query text
    /// * `texts` - list of text
    pub async fn similarity(&self, query: &str, texts: &Vec<&str>) -> IndexResults {
        // Post parameters
        let params = json!({"query": query, "texts": texts});

        // Execute API call
        Ok(self.api.post("similarity", &params).await?.json().await?)
    }

    /// Computes the similarity between list of queries and list of text. Returns a list
    /// of {id: value, score: value} sorted by highest score per query, where id is the
    /// index in texts.
    ///
    /// # Arguments
    /// * `queries` - queries text
    /// * `texts` - list of text
    pub async fn batchsimilarity(&self, queries: &Vec<&str>, texts: &Vec<&str>) -> IndexResultsBatch {
        // Post parameters
        let params = json!({"queries": queries, "texts": texts});

        // Execute API call
        Ok(self.api.post("batchsimilarity", &params).await?.json().await?)
    }
}