Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion crates/basic-api/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

83 changes: 9 additions & 74 deletions crates/basic-api/src/api/handlers.rs
Original file line number Diff line number Diff line change
@@ -1,88 +1,23 @@
use axum::{extract::State, Json};

use crate::{
api::response::{bad_request, ApiError, ApiResult},
models::{
DeleteRequest, InsertRequest, MessageResponse, SearchRequest, SearchResponse,
},
state::AppState,
api::response::ApiResult,
models::{DeleteRequest, InsertRequest, MessageResponse, SearchRequest, SearchResponse},
service::VectorService,
};

pub async fn health() -> &'static str {
"ok"
}

pub async fn insert(
State(state): State<AppState>,
Json(request): Json<InsertRequest>,
) -> ApiResult<MessageResponse> {
if request.id.trim().is_empty() {
return Err(bad_request("id must not be empty"));
}

validate_vector(&request.vector)?;

let mut engine = state.engine.lock().expect("engine mutex poisoned");

if let Some(expected_dimension) = engine.dimension() {
if request.vector.len() != expected_dimension {
return Err(bad_request("vector dimension does not match existing vectors"));
}
}

engine.insert(request.id, request.vector);

Ok(Json(MessageResponse {
message: "vector inserted".to_string(),
}))
pub async fn insert(State(service): State<VectorService>, Json(request): Json<InsertRequest>) -> ApiResult<MessageResponse> {
Ok(Json(service.insert(request.id, request.vector)?))
}

pub async fn search(
State(state): State<AppState>,
Json(request): Json<SearchRequest>,
) -> ApiResult<SearchResponse> {
if request.k == 0 {
return Err(bad_request("k must be greater than 0"));
}

validate_vector(&request.query)?;

let engine = state.engine.lock().expect("engine mutex poisoned");

if let Some(expected_dimension) = engine.dimension() {
if request.query.len() != expected_dimension {
return Err(bad_request("query dimension does not match stored vectors"));
}
}

let results = engine.search(request.query, request.k);
Ok(Json(SearchResponse { results }))
pub async fn search(State(service): State<VectorService>, Json(request): Json<SearchRequest>) -> ApiResult<SearchResponse> {
Ok(Json(service.search(request.query, request.k)?))
}

pub async fn delete_vector(
State(state): State<AppState>,
Json(request): Json<DeleteRequest>,
) -> ApiResult<MessageResponse> {
if request.id.trim().is_empty() {
return Err(bad_request("id must not be empty"));
}

let mut engine = state.engine.lock().expect("engine mutex poisoned");
engine.delete(&request.id);

Ok(Json(MessageResponse {
message: "vector deleted".to_string(),
}))
}

fn validate_vector(vector: &[f32]) -> Result<(), ApiError> {
if vector.is_empty() {
return Err(bad_request("vector must not be empty"));
}

if vector.iter().any(|value| !value.is_finite()) {
return Err(bad_request("vector must contain only finite floats"));
}

Ok(())
pub async fn delete_vector(State(service): State<VectorService>, Json(request): Json<DeleteRequest>) -> ApiResult<MessageResponse> {
Ok(Json(service.delete(&request.id)?))
}
69 changes: 4 additions & 65 deletions crates/basic-api/src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pub trait VectorEngine {

pub struct FfiEngineAdapter {
engine: FfiVectorEngine,
stored_dimensions: HashMap<String, usize>, // maps vector ID : dimension
stored_dimensions: HashMap<String, usize>,
dimension: Option<usize>,
}

Expand All @@ -38,12 +38,12 @@ impl VectorEngine for FfiEngineAdapter {
fn search(&self, query: Vec<f32>, k: usize) -> Vec<SearchResult> {
let results = self.engine.search(&query, k);

(0..results.len())
.map(|index| SearchResult {
(0..results.len()) // creating range from 0 to len - 1
.map(|index| SearchResult { // for every number, build SearchResult
id: results.id_at(index),
score: results.score_at(index),
})
.collect()
.collect() // return vector of SearchResults
}

fn delete(&mut self, id: &str) {
Expand All @@ -60,64 +60,3 @@ impl VectorEngine for FfiEngineAdapter {
self.dimension
}
}


// Old hardcoded implementation minus the FFI
// ------------------------------------------------
// #[derive(Default)]
// pub struct FlatIndex {
// vectors: Vec<(String, Vec<f32>)>,
// }

// impl FlatIndex {
// pub fn new() -> Self {
// Self::default()
// }
// }
// impl VectorEngine for FlatIndex {
// fn insert(&mut self, id: String, vector: Vec<f32>) {
// self.delete(&id);
// self.vectors.push((id, vector));
// }

// fn search(&self, query: Vec<f32>, k: usize) -> Vec<SearchResult> {
// let mut results: Vec<SearchResult> = self
// .vectors
// .iter()
// .map(|(id, vector)| SearchResult {
// id: id.clone(),
// score: cosine_similarity(&query, vector),
// })
// .collect();

// results.sort_by(|left, right| right.score.total_cmp(&left.score));
// results.truncate(k);
// results
// }

// fn delete(&mut self, id: &str) {
// self.vectors.retain(|(stored_id, _)| stored_id != id);
// }

// fn dimension(&self) -> Option<usize> {
// self.vectors.first().map(|(_, vector)| vector.len())
// }
// }

// fn cosine_similarity(left: &[f32], right: &[f32]) -> f32 {
// let mut dot = 0.0;
// let mut left_norm = 0.0;
// let mut right_norm = 0.0;

// for (left_value, right_value) in left.iter().zip(right.iter()) {
// dot += left_value * right_value;
// left_norm += left_value * left_value;
// right_norm += right_value * right_value;
// }

// if left_norm == 0.0 || right_norm == 0.0 {
// return 0.0;
// }

// dot / (left_norm.sqrt() * right_norm.sqrt())
// }
7 changes: 4 additions & 3 deletions crates/basic-api/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
mod api;
mod engine;
mod models;
mod service;
mod state;

use axum::{routing::{get, post}, Router};
use tokio::net::TcpListener;

use crate::{api::handlers, state::AppState};
use crate::{api::handlers, service::VectorService, state::AppState};

#[tokio::main]
async fn main() {
let state = AppState::new();
let service = VectorService::new(AppState::new());

let app = Router::new()
.route("/health", get(handlers::health))
.route("/insert", post(handlers::insert))
.route("/search", post(handlers::search))
.route("/delete", post(handlers::delete_vector))
.with_state(state);
.with_state(service);

let listener = TcpListener::bind("127.0.0.1:3000")
.await
Expand Down
93 changes: 93 additions & 0 deletions crates/basic-api/src/service.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
use crate::{
api::response::{bad_request, ApiError},
models::{MessageResponse, SearchResponse},
state::AppState,
};

#[derive(Clone)]
pub struct VectorService {
state: AppState,
}

impl VectorService {
pub fn new(state: AppState) -> Self {
Self { state }
}

pub fn insert(&self, id: String, vector: Vec<f32>) -> Result<MessageResponse, ApiError> {
self.validate_id(&id)?;
self.validate_vector(&vector)?;

let mut engine = self.state.engine.lock().expect("engine lock failed");

self.validate_dimension(engine.dimension(), vector.len(), "vector dimension does not match existing vectors")?;

engine.insert(id, vector);

Ok(MessageResponse {
message: "vector inserted".to_string(),
})
}

pub fn search(&self, query: Vec<f32>, k: usize) -> Result<SearchResponse, ApiError> {
self.validate_k(k)?;
self.validate_vector(&query)?;

let engine = self.state.engine.lock().expect("engine lock failed");

self.validate_dimension(engine.dimension(), query.len(), "query dimension does not match stored vectors")?;

let results = engine.search(query, k);
Ok(SearchResponse { results })
}

pub fn delete(&self, id: &str) -> Result<MessageResponse, ApiError> {
self.validate_id(id)?;

let mut engine = self.state.engine.lock().expect("engine lock failed");
engine.delete(id);

Ok(MessageResponse {
message: "vector deleted".to_string(),
})
}

fn validate_id(&self, id: &str) -> Result<(), ApiError> {
if id.trim().is_empty() {
return Err(bad_request("id must not be empty"));
}

Ok(())
}

fn validate_k(&self, k: usize) -> Result<(), ApiError> {
if k == 0 {
return Err(bad_request("k must be greater than 0"));
}

Ok(())
}

fn validate_vector(&self, vector: &[f32]) -> Result<(), ApiError> {
if vector.is_empty() {
return Err(bad_request("vector must not be empty"));
}

if vector.iter().any(|value| !value.is_finite()) {
return Err(bad_request("vector must contain only finite floats"));
}

Ok(())
}

fn validate_dimension(&self, expected_dimension: Option<usize>, actual_dimension: usize, message: &str) -> Result<(), ApiError> {
// Option<type> in Rust always returns None or Some(value), so we strip it
if let Some(expected_dimension) = expected_dimension {
if actual_dimension != expected_dimension {
return Err(bad_request(message));
}
}

Ok(())
}
}
Loading