fastembed-rs

anush008Apache-2.0活跃维护

Rust 编写的本地向量嵌入与重排库,无需调用外部 API 即可在本地生成文本向量并做检索结果重排,适合搭建 RAG 和向量检索。

Rust library for generating vector embeddings and reranking locally!

v7.7.0发布于 2026-11-09 14:01 UTC1,051star149fork同步于 2026-11-10 17:53 UTC

怎么上手

由 README 提炼,执行前请确认
cargo add fastembed
硬件要求按 README 说明

README 未说明显存或 GPU 型号要求;Qwen3 系列示例用 candle 后端,示例中设备为 Device::Cpu。

支持 Apple Silicon
下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

由 README 自动翻译提炼

Rust 库,本地生成文本、图像向量嵌入并做重排序,无需调用外部 API

Rust 编写的本地向量嵌入与重排库,无需调用外部 API 即可在本地生成文本向量并做检索结果重排,适合搭建 RAG 和向量检索。

核心能力

  • 用 ort 做 ONNX 推理,用 HuggingFace tokenizers 做快速编码
  • 同步 API,不依赖 Tokio 异步运行时
  • 支持稠密、稀疏文本嵌入、图像嵌入与候选重排序
  • 内置 similarity 模块做余弦相似度打分与 top-k 检索
  • 支持加载本地模型文件,用 try_new_from_user_defined 系列方法

容易踩的坑

首次使用会从 HuggingFace 下载模型权重,需联网或改用本地模型文件;Qwen3 与 nomic-v2-moe 等模型需开启对应 feature(如 qwen3)并走 candle 后端;稀疏模型 OpenSearchNeuralSparseDocV3Gte 每个 token 输出全词表分数,需保持较小 batch size。

内容由模型根据 README 生成,可能不完整或不准确,以官方文档为准。看原文 README

最近发版

5 个版本v7.7.0
  1. v7.7.0最新正式版2026-11-09 · 2026-11-09 14:01 UTC

    7.7.0 (2026-11-09)

    🍕 Features

    • BERT-family text embeddings on Metal, with fused epilogues (#352) (90ba8a5) - @ernestas-poskus
  2. v7.6.12026-11-06 · 2026-11-06 04:27 UTC
    查看更新说明

    7.6.1 (2026-11-06)

    🐛 Bug Fixes

    • Keep cosine scores finite for finite vectors (#350) (678001a) - By @jihtsan
  3. v7.6.02026-11-05 · 2026-11-05 10:16 UTC
    查看更新说明

    7.6.0 (2026-11-05)

    🍕 Features

    • Expose ONNX Runtime automatic device selection through InitOptions (#348) (63ce1c1) - By @julihoh

    🧹 Chores

    • Bump Swatinem/rust-cache from 2.9.2 to 2.9.3 in the github-actions group (#347) (d6c7d91) - By @dependabot
  4. v7.5.02026-10-23 · 2026-10-23 09:47 UTC
    查看更新说明

    7.5.0 (2026-10-23)

    🍕 Features

    • Run the Qwen3 reranker's shared prompt head once per score call (#342) (477c69a) - @dhkts1
  5. v7.4.12026-10-23 · 2026-10-23 09:13 UTC
    查看更新说明

    7.4.1 (2026-10-23)

    🐛 Bug Fixes

    • Qwen3 reranker scores in f32, without padding, in bounded forwards, loading two output rows (#339) (562795e) - By @dhkts1
    • Tokenize only the kept prefix of a long Qwen3 text (#340) (64ec3ac) - By @dhkts1

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    Features

    Not looking for Rust?

    Supported Models

    Text Embedding

    Quantized versions are also available for several models above (append Q to the model enum variant, e.g., EmbeddingModel::BGESmallENV15Q). EmbeddingGemma additionally ships a 4-bit build as EmbeddingModel::EmbeddingGemma300MQ4.

    Sparse Text Embedding

    Image Embedding

    Reranking

    ✊ Support

    To support the library, please donate to our primary upstream dependency, ort - The Rust wrapper for the ONNX runtime.

    Installation

    Run the following in your project directory:

    cargo add fastembed
    

    Or add the following line to your Cargo.toml:

    [dependencies]
    fastembed = "7"
    

    Text Embeddings

    use fastembed::{TextEmbedding, TextInitOptions, EmbeddingModel};
    
    // With default options
    let mut model = TextEmbedding::try_new(Default::default())?;
    
    // With custom options
    let mut model = TextEmbedding::try_new(
        TextInitOptions::new(EmbeddingModel::AllMiniLML6V2).with_show_download_progress(true).with_intra_threads(4),
    )?;
    
    let documents = vec![
        "passage: Hello, World!",
        "query: Hello, World!",
        "passage: This is an example passage.",
        // You can leave out the prefix but it's recommended
        "fastembed-rs is licensed under Apache 2.0"
    ];
    
     // Generate embeddings with the default batch size, 256
     let embeddings = model.embed(documents, None)?;
    
     println!("Embeddings length: {}", embeddings.len()); // -> Embeddings length: 4
     println!("Embedding dimension: {}", embeddings[0].len()); // -> Embedding dimension: 384
    

    Sparse Text Embeddings

    use fastembed::{SparseEmbedding, SparseInitOptions, SparseModel, SparseTextEmbedding};
    
    // With default options
    let mut model = SparseTextEmbedding::try_new(Default::default())?;
    
    // With custom options
    let mut model = SparseTextEmbedding::try_new(
        SparseInitOptions::new(SparseModel::SPLADEPPV1).with_show_download_progress(true),
    )?;
    
    let documents = vec![
        "passage: Hello, World!",
        "query: Hello, World!",
        "passage: This is an example passage.",
        "fastembed-rs is licensed under Apache 2.0"
    ];
    
    // Generate embeddings with the default batch size, 256
    let embeddings: Vec<SparseEmbedding> = model.embed(documents, None)?;
    

    Image Embeddings

    use fastembed::{ImageEmbedding, ImageInitOptions, ImageEmbeddingModel};
    
    // With default options
    let mut model = ImageEmbedding::try_new(Default::default())?;
    
    // With custom options
    let mut model = ImageEmbedding::try_new(
        ImageInitOptions::new(ImageEmbeddingModel::ClipVitB32).with_show_download_progress(true),
    )?;
    
    let images = vec!["assets/image_0.png", "assets/image_1.png"];
    
    // Generate embeddings with the default batch size, 256
    let embeddings = model.embed(images, None)?;
    
    println!("Embeddings length: {}", embeddings.len()); // -> Embeddings length: 2
    println!("Embedding dimension: {}", embeddings[0].len()); // -> Embedding dimension: 512
    

    Candidates Reranking

    use fastembed::{TextRerank, RerankInitOptions, RerankerModel};
    
    // With default options
    let mut model = TextRerank::try_new(Default::default())?;
    
    // With custom options
    let mut model = TextRerank::try_new(
        RerankInitOptions::new(RerankerModel::BGERerankerBase).with_show_download_progress(true),
    )?;
    
    let documents = vec![
        "hi",
        "The giant panda (Ailuropoda melanoleuca), sometimes called a panda bear, is a bear species endemic to China.",
        "panda is animal",
        "i dont know",
        "kind of mammal",
    ];
    
    // Rerank with the default batch size, 256 and return document contents
    let results = model.rerank("what is panda?", documents, true, None)?;
    println!("Rerank result: {:?}", results);
    

    Locally Available Models

    Alternatively, local model files can be used for inference via the try_new_from_user_defined(...) methods of the respective structs.

    Similarity Search

    Helpers in the similarity module score and rank the vectors embed returns, so a quick in-memory search needs no extra crate:

    use fastembed::similarity::{cosine_similarity, top_k};
    
    // `embeddings` is the Vec<Embedding> from model.embed(...)
    let query = &embeddings[0];
    
    // Score two vectors directly ([-1.0, 1.0], higher = closer)
    let score = cosine_similarity(query, &embeddings[1]);
    
    // Or rank the corpus: (index, score) pairs, best first
    let hits = top_k(query, &embeddings, 5);
    println!("Closest: {:?}", hits);
    

    For larger corpora or persistence, push the vectors to a vector search engine (e.g. Qdrant) and query there.

    Inference-free Sparse Embeddings

    use fastembed::{SparseInitOptions, SparseModel, SparseTextEmbedding};
    
    let mut model = SparseTextEmbedding::try_new(
        SparseInitOptions::new(SparseModel::OpenSearchNeuralSparseDocV3Gte).with_max_length(8192),
    )?;
    
    //  This model emits one score per vocabulary entry per token.
    // So keep the batch size small.
    let documents = model.embed(vec!["Hello World"], Some(4))?;
    
    // Queries are from the tokenizer and a precomputed IDF table alone, without any inference.
    let queries = model.query_embed(vec!["Hello World"])?;
    

    Qwen3 Embeddings

    Qwen3 embedding models are available behind the qwen3 feature flag (candle backend).

    [dependencies]
    fastembed = { version = "7", features = ["qwen3"] }
    
    use candle_core::{DType, Device};
    use fastembed::Qwen3TextEmbedding;
    
    let device = Device::Cpu;
    let model = Qwen3TextEmbedding::from_hf(
        "Qwen/Qwen3-Embedding-0.6B",
        &device,
        DType::F32,
        512,
    )?;
    
    // Text-only usage with the Qwen3-VL embedding checkpoint is also supported:
    // let model = Qwen3TextEmbedding::from_hf("Qwen/Qwen3-VL-Embedding-2B", &device, DType::F32, 512)?;
    
    let embeddings = model.embed(&["query: ...", "passage: ..."])?;
    println!("Embeddings length: {}", embeddings.len());
    

    For multimodal text/image usage with Qwen/Qwen3-VL-Embedding-2B:

    use candle_core::{DType, Device};
    use fastembed::Qwen3VLEmbedding;
    
    let device = Device::Cpu;
    let model = Qwen3VLEmbedding::from_hf(
        "Qwen/Qwen3-VL-Embedding-2B",
        &device,
        DType::F32,
        2048,
    )?;
    
    let image_embeddings = model.embed_images(&["tests/assets/image_0.png", "tests/assets/image_1.png"])?;
    let text_embeddings = model.embed_texts(&["query: blue cat", "query: red cat"])?;
    
    println!("Image embeddings: {}", image_embeddings.len());
    println!("Text embeddings: {}", text_embeddings.len());
    

    Quantized GGUF files (for example from Qwen/Qwen3-Embedding-4B-GGUF or Qwen/Qwen3-Embedding-8B-GGUF) load with the same qwen3 feature. The weights stay quantized in memory, and the tokenizer comes from the original model's repo:

    use candle_core::Device;
    use fastembed::Qwen3TextEmbedding;
    
    let device = Device::Cpu;
    let model = Qwen3TextEmbedding::from_hf_gguf(
        "Qwen/Qwen3-Embedding-4B-GGUF",
        "Qwen3-Embedding-4B-Q8_0.gguf",
        "Qwen/Qwen3-Embedding-4B",
        &device,
        512,
    )?;
    
    let embeddings = model.embed(&["query: ...", "passage: ..."])?;
    println!("Embeddings length: {}", embeddings.len());
    

    Nomic Embed Text v2 MoE

    The nomic-embed-text-v2-moe model is available behind the nomic-v2-moe feature flag (candle backend). First general-purpose MoE embedding model with 100+ language support.

    [dependencies]
    fastembed = { version = "7", features = ["nomic-v2-moe"] }
    
    use candle_core::{DType, Device};
    use fastembed::NomicV2MoeTextEmbedding;
    
    let device = Device::Cpu;
    let model = NomicV2MoeTextEmbedding::from_hf(
        "nomic-ai/nomic-embed-text-v2-moe",
        &device,
        DType::F32,
        512,
    )?;
    
    let embeddings = model.embed(&["search_query: ...", "search_document: ..."])?;
    println!("Embeddings length: {}", embeddings.len());
    

    BGE-M3 Joint Embeddings

    The BGE-M3 model produces dense, sparse, and ColBERT embeddings simultaneously in a single forward pass.

    use fastembed::{Bgem3Embedding, Bgem3InitOptions, Bgem3Model};
    
    // With default options
    let mut model = Bgem3Embedding::try_new(Default::default())?;
    
    // With custom options (supporting custom max length up to 8192 tokens)
    let mut model = Bgem3Embedding::try_new(
        Bgem3InitOptions::new(Bgem3Model::BGEM3Q)
            .with_max_length(1024)
            .with_show_download_progress(true),
    )?;
    
    let documents = vec![
        "Hello, World!",
        "This is an example passage.",
        "fastembed-rs is licensed under Apache 2.0",
        "i dont know"
    ];
    
    // Generate all three representations in a single forward pass
    let output = model.embed(documents, None)?;
    
    println!("Dense dimension: {}", output.dense[0].len()); // -> Dense dimension: 1024
    
    let sparse_emb = &output.sparse[0];
    println!("Sparse non-zero tokens: {}", sparse_emb.indices.len());
    
    println!("ColBERT token count: {}", output.colbert[0].len());
    

    Model cache

    Models download on first use and load from cache afterwards (no network needed at runtime once cached).

    • FASTEMBED_CACHE_DIR — cache location (default: .fastembed_cache). Equivalent to TextInitOptions::with_cache_dir.
    • HF_HOME — if set, takes precedence over the above.
    • HF_ENDPOINT — Hugging Face mirror base URL, for restricted networks.
    • HF_TOKEN — Hugging Face access token, for gated repositories and higher rate limits. Without it, the token saved by huggingface-cli login is used when present.

    DirectML (Windows)

    To run models on a GPU via DirectML on Windows, enable the directml feature:

    [dependencies]
    fastembed = { version = "7", features = ["directml"] }
    

    Then pass a DirectML execution provider when initializing a model:

    use fastembed::{TextEmbedding, TextInitOptions, EmbeddingModel};
    use ort::ep::DirectML;
    
    let model = TextEmbedding::try_new(
        TextInitOptions::new(EmbeddingModel::AllMiniLML6V2)
            .with_execution_providers(vec![DirectML::default().into()]),
    )?;
    

    When DirectML is detected, fastembed automatically disables memory pattern optimization and parallel execution on the ONNX Runtime session, as required by the DirectML execution provider.

    Automatic device selection

    When no execution provider is registered, ort enables ONNX Runtime's automatic device selection with AutoDevicePolicy::MaxEfficiency, which registers CoreML on macOS. Registering ort::ep::CPU does not prevent this, because the CPU provider is built in and registers nothing. Set a policy to control the selection:

    use fastembed::{AutoDevicePolicy, EmbeddingModel, TextEmbedding, TextInitOptions};
    
    let model = TextEmbedding::try_new(
        TextInitOptions::new(EmbeddingModel::AllMiniLML6V2)
            .with_auto_device(AutoDevicePolicy::PreferCPU),
    )?;
    

    AutoDevicePolicy::PreferCPU selects a CPU device, which in a standard ONNX Runtime build is the built-in CPU execution provider.

    Error handling

    Fastembed returns a typed fastembed::Error. The type is re-exported from the crate root. The enum is #[non_exhaustive]. New variants can be added in minor releases without breaking match arms.

    use fastembed::{Error, Result, TextEmbedding};
    
    fn load() -> Result<TextEmbedding> {
        let model = TextEmbedding::try_new(Default::default())?;
        Ok(model)
        // ...
    }
    

    To handle an error, match on the variant that applies:

    use fastembed::{Error, TextEmbedding, TextInitOptions, EmbeddingModel};
    
    match TextEmbedding::try_new(TextInitOptions::new(EmbeddingModel::AllMiniLML6V2)) {
        Ok(model) => { /* ... */ }
        Err(Error::ModelRetrieval { file, source }) => {
            eprintln!("could not fetch {file}: {source}");
        }
        /*
        ...
        */
        Err(Error::Ort(err)) => {
            eprintln!("ONNX runtime error: {err}");
        }
        Err(e) => eprintln!("{e}"),
    }
    

    LICENSE

    Apache 2.0