Struct RemoteEmbeddingGenerator 

pub struct RemoteEmbeddingGenerator {
    pub model_type: EmbeddingModelType,
    pub api_url: String,
    pub api_key: Option<String>,
}

Fields

model_type: EmbeddingModelType

api_url: String

api_key: Option<String>

Implementations

impl RemoteEmbeddingGenerator

pub fn new( model_type: EmbeddingModelType, api_url: &str, api_key: Option<String>, ) -> RemoteEmbeddingGenerator

Create a RemoteEmbeddingGenerator

pub fn new_default() -> RemoteEmbeddingGenerator

Create a RemoteEmbeddingGenerator that uses the default model and server

pub fn new_default_local() -> RemoteEmbeddingGenerator

Create a RemoteEmbeddingGenerator that uses the default model and server

pub async fn generate_embedding_ollama( &self, input_string: String, model: String, ) -> Result<Vec<f32>, ZooEmbeddingError>

Generates embeddings using Hugging Face’s Text Embedding Interface server pub async fn generate_embedding_open_ai(&self, input_string: &str, id: &str) -> Result<Embedding, VRError> {

pub async fn generate_embedding_tei( &self, input_strings: Vec<String>, ) -> Result<Vec<Vec<f32>>, ZooEmbeddingError>

Generates embeddings using Hugging Face’s Text Embedding Interface server

pub async fn generate_embedding_open_ai( &self, input_string: &str, ) -> Result<Vec<f32>, ZooEmbeddingError>

Generate an Embedding for an input string by using the external OpenAI-matching API.

Trait Implementations

impl Clone for RemoteEmbeddingGenerator

fn clone(&self) -> RemoteEmbeddingGenerator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RemoteEmbeddingGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RemoteEmbeddingGenerator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EmbeddingGenerator for RemoteEmbeddingGenerator

fn box_clone(&self) -> Box<dyn EmbeddingGenerator>

Clones self and wraps it in a Box

fn generate_embeddings_blocking( &self, input_strings: &Vec<String>, ) -> Result<Vec<Vec<f32>>, ZooEmbeddingError>

Generate Embeddings for an input list of strings by using the external API. This method batch generates whenever possible to increase speed. Note this method is blocking.

fn generate_embedding_blocking( &self, input_string: &str, ) -> Result<Vec<f32>, ZooEmbeddingError>

Generate an Embedding for an input string by using the external API. Note this method is blocking.

fn generate_embeddings<'life0, 'life1, 'async_trait>( &'life0 self, input_strings: &'life1 Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, ZooEmbeddingError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate an Embedding for an input string by using the external API. This method batch generates whenever possible to increase speed.

fn generate_embedding<'life0, 'life1, 'async_trait>( &'life0 self, input_string: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<f32>, ZooEmbeddingError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate an Embedding for an input string by using the external API.

fn model_type(&self) -> EmbeddingModelType

Returns the EmbeddingModelType

fn set_model_type(&mut self, model_type: EmbeddingModelType)

Sets the EmbeddingModelType

fn generate_embedding_default_blocking( &self, input_string: &str, ) -> Result<Vec<f32>, ZooEmbeddingError>

Generate an Embedding for an input string, sets id to a default value of empty string.

fn generate_embeddings_blocking_default( &self, input_strings: &Vec<String>, ) -> Result<Vec<Vec<f32>>, ZooEmbeddingError>

Generate Embeddings for a list of input strings, sets ids to default.

fn generate_embedding_default<'life0, 'life1, 'async_trait>( &'life0 self, input_string: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<f32>, ZooEmbeddingError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate an Embedding for an input string, sets id to a default value of empty string.

fn generate_embeddings_default<'life0, 'life1, 'async_trait>( &'life0 self, input_strings: &'life1 Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<f32>>, ZooEmbeddingError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate Embeddings for a list of input strings, sets ids to default

impl PartialEq for RemoteEmbeddingGenerator

fn eq(&self, other: &RemoteEmbeddingGenerator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RemoteEmbeddingGenerator

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RemoteEmbeddingGenerator