polymathy/lib.rs
1//! # Polymathy
2//! A high-performance web service that processes search queries, retrieves relevant content,
3//! and performs semantic chunking and embedding operations.
4//!
5//! ## Overview
6//!
7//! Polymathy is a Rust library that provides functionality for:
8//! - Processing search queries through SearxNG integration
9//! - Retrieving and processing web content
10//! - Performing semantic chunking of content
11//! - Generating embeddings for content chunks
12//! - Indexing content with vector similarity search
13//!
14//! ## Features
15//!
16//! - **Search Processing**: Handles search queries through SearxNG integration
17//! - **Content Processing**: Chunks content and generates embeddings
18//! - **Vector Indexing**: Manages similarity search using USearch
19//! - **Concurrent Processing**: Processes multiple URLs simultaneously using Tokio
20//! - **OpenAPI Documentation**: Built-in API documentation with multiple UI options
21//!
22//! ## Usage
23//!
24//! Add this to your `Cargo.toml`:
25//! ```toml
26//! [dependencies]
27//! polymathy = { path = "." }
28//! ```
29//!
30//! Then use it in your code:
31//! ```rust
32//! use polymathy::run;
33//!
34//! #[tokio::main]
35//! async fn main() -> std::io::Result<()> {
36//! run().await
37//! }
38//! ```
39//!
40//! ## Modules
41//!
42//! - [`search`]: Handles search query processing and data structures
43//! - [`index`]: Manages vector indexing with USearch
44//! - [`api`]: Defines API endpoints and server implementation
45
46pub mod search;
47pub mod index;
48pub mod api;
49
50pub use api::run;