semantic_search/lib.rs
1//! # Semantic Search Library
2//!
3//! `semantic-search` is a library for searching semantically similar documents.
4//!
5//! To be specific, it helps you get embeddings of texts and search for top-k similar texts, where similarity is defined by cosine similarity of embeddings.
6
7#![deny(missing_docs)]
8#![warn(clippy::all, clippy::nursery, clippy::pedantic, clippy::cargo)]
9#![allow(clippy::multiple_crate_versions, reason = "Dependencies")]
10
11mod api;
12pub mod embedding;
13mod error;
14
15pub use api::{ApiClient, Model};
16pub use embedding::Embedding;
17pub use error::SenseError;