Skip to main content

rig_core/embeddings/
mod.rs

1//! Provider-agnostic embedding abstractions.
2//!
3//! Embeddings are numerical representations of text or other inputs. Rig uses
4//! an embedding [`Model`](crate::Model) to generate vectors, [`Embed`] to
5//! select which text from a Rust value should be embedded, and
6//! [`EmbeddingsBuilder`] to batch embedding requests for vector stores or
7//! retrieval workflows.
8//!
9//! ```
10//! use rig_core::embeddings::to_texts;
11//!
12//! assert_eq!(to_texts(vec!["first", "second"])?, vec!["first", "second"]);
13//! # Ok::<(), rig_core::embeddings::EmbedError>(())
14//! ```
15
16pub mod builder;
17pub mod embed;
18pub mod embedding;
19pub mod tool;
20
21pub mod distance;
22pub use builder::EmbeddingsBuilder;
23pub use embed::{Embed, EmbedError, TextEmbedder, to_texts};
24pub use embedding::*;
25pub use tool::ToolSchema;