M0: compilable skeleton — Kigi 0.1.0 fork surgery
Hard fork of xai-org/grok-build (Apache-2.0) re-targeted as Kigi, an
unofficial Kimi Code CLI community build.
Rename & identity
- 72 xai-*/xai-grok-* crates -> kigi-* (explicit: xai-grok-pager-bin ->
kigi-bin [binary `kigi`], xai-grok-pager -> kigi-tui; rest mechanical);
ptyctl, ptyctl-cli, third_party/ unchanged; proto package
xai.grok.tools.v1 -> kigi.tools.v1
- Config home ~/.kigi (KIGI_SHARE_DIR override), env prefix GROK_* ->
KIGI_*, `kigi --version` carries the unofficial-community-build notice
- clap identity, help text, startup banner, prompt templates rebranded
(templates re-encrypted)
Deletions (PRD removal list #5/#6/#7/#9/#10)
- voice input (xai-grok-voice) and all TUI wiring
- telemetry: Mixpanel client, external OTel stream, Sentry, OTLP layers,
trace/GCS/S3 upload queues (kigi-file-utils halved), workspace upload
module & dc_log, heap-profile uploader, auth-diagnostics uploader,
session-analytics halves of feedback; local zero-egress observability
preserved in new kigi-log crate (unified log, --debug firehose,
subsystem file logs, opt-in instrumentation)
- announcements (crate, remote-settings fields, TUI surfaces)
- plugin marketplace (crate, sources/browse/CTA/extensions-modal tab);
direct plugin install/uninstall/update via kigi-agent git_install kept
- relay/gateway/assets endpoints and features (agent relay, headless
relay transport, gateway bridge, LeaderEnvUrls); leader IPC socket now
~/.kigi/leader.sock + KIGI_LEADER_SOCKET, no ws-url derivation
- functional types rehomed instead of deleted: PermissionMode ->
kigi-config-types, McpInitStrategy -> kigi-mcp, PrCreationSource ->
session signals, TerminalDiagnostics -> kigi-pager-render, agent_id ->
shell util
Endpoints
- kigi-env rewritten: single production KigiEndpoints {coding_api_base_url
https://api.kimi.com/coding/v1 (KIGI_CODE_BASE_URL), oauth_host
https://auth.kimi.com (KIGI_OAUTH_HOST), update_base_url (GitHub
Releases API), upgrade_page_url}; GrokBuildEnvironment enum deleted
Toolchain & workspace hygiene
- Rust 1.97.0 pinned; edition 2024; full cargo update; git2 hoisted to
workspace at 0.21 (Option->Result API migration), quick-xml 0.41
- Root Cargo.toml hand-maintained (PRD §8.1): version 0.1.0 inherited by
all members, members sorted, unused deps pruned
- cargo-deny advisories gate (deny.toml with documented transitive
exceptions); CI workflow (check/clippy/fmt/deny/test, macOS+Linux)
- cross-crate test seams re-gated behind `test-support` cargo feature;
insta snapshot baselines renamed to the kigi_tui prefix
- clippy --workspace --all-targets: zero warnings; fmt clean
Fixes surfaced by the port
- updater probe/installer divergence (bin/kigi vs bin/grok symlink set)
- idle model-metadata refresh dead under KIGI_CODE_BASE_URL override
(new is_effective_coding_endpoint_url, loopback+override aware)
- macOS symlinked-TMPDIR fixture canonicalization (foreign_sessions,
fast-worktree); RSS measurement tests serialized via serial_test
Docs & legal (Apache §4)
- NOTICE added (upstream attribution + change statement); THIRD-PARTY
notices sustained; kigi-tools ported-code notices extended; README,
CONTRIBUTING, SECURITY, AGENTS.md rewritten
Out of scope for M0 (tracked): Kimi auth/inference (M1), search/fetch,
command parity, config import (M2), Computer Hub excision & final
brand-token sweep (M2), distribution & self-update rewrite (M3).
This commit is contained in:
@@ -0,0 +1,281 @@
|
||||
//! Embedding provider abstraction for memory vector search.
|
||||
//!
|
||||
//! Defines the `EmbeddingProvider` trait and an API-based implementation
|
||||
//! that calls an OpenAI-compatible embeddings API endpoint.
|
||||
//!
|
||||
//! Embeddings are cached in the sqlite-vec `chunks_vec` table — the vec0
|
||||
//! virtual table IS the cache. No separate cache needed.
|
||||
|
||||
use async_trait::async_trait;
|
||||
|
||||
/// Maximum retry attempts for transient API errors (429, 5xx).
|
||||
const MAX_RETRIES: usize = 3;
|
||||
/// Initial backoff delay in milliseconds (doubles on each retry: 1s, 2s, 4s).
|
||||
const INITIAL_BACKOFF_MS: u64 = 1000;
|
||||
|
||||
/// Trait for generating text embeddings.
|
||||
///
|
||||
/// Implementations must be `Send + Sync` so they can be used in `Send`
|
||||
/// futures (e.g., inside `tokio::spawn`). The `embed_batch` method is
|
||||
/// async to support API-based providers.
|
||||
#[async_trait]
|
||||
pub trait EmbeddingProvider: Send + Sync {
|
||||
/// Embed a batch of texts, returning one vector per input text.
|
||||
async fn embed_batch(
|
||||
&self,
|
||||
texts: &[&str],
|
||||
) -> Result<Vec<Vec<f32>>, Box<dyn std::error::Error>>;
|
||||
|
||||
/// The model name used for embeddings.
|
||||
fn model_name(&self) -> &str;
|
||||
|
||||
/// The dimensionality of the embedding vectors.
|
||||
fn dimensions(&self) -> usize;
|
||||
}
|
||||
|
||||
/// API-based embedding provider using an OpenAI-compatible embeddings endpoint.
|
||||
pub struct ApiEmbeddingProvider {
|
||||
api_base: String,
|
||||
model: String,
|
||||
dimensions: usize,
|
||||
client: reqwest_middleware::ClientWithMiddleware,
|
||||
max_batch_size: usize,
|
||||
}
|
||||
|
||||
impl ApiEmbeddingProvider {
|
||||
pub fn new(
|
||||
api_base: String,
|
||||
model: String,
|
||||
dimensions: usize,
|
||||
client: reqwest_middleware::ClientWithMiddleware,
|
||||
) -> Self {
|
||||
Self {
|
||||
api_base,
|
||||
model,
|
||||
dimensions,
|
||||
client,
|
||||
max_batch_size: 32,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn from_config(
|
||||
config: &kigi_config_types::MemoryEmbeddingConfig,
|
||||
api_base: String,
|
||||
client: reqwest_middleware::ClientWithMiddleware,
|
||||
) -> Option<Self> {
|
||||
let model = config.model.clone().filter(|m| !m.is_empty())?;
|
||||
Some(Self::new(api_base, model, config.dimensions, client))
|
||||
}
|
||||
|
||||
pub fn from_session(
|
||||
config: &kigi_config_types::MemoryEmbeddingConfig,
|
||||
proxy_base_url: String,
|
||||
auth_key: String,
|
||||
) -> Option<Self> {
|
||||
let client = build_static_middleware_client(Some(auth_key));
|
||||
Self::from_config(config, proxy_base_url, client)
|
||||
}
|
||||
}
|
||||
|
||||
pub(super) fn build_middleware_client(
|
||||
credentials: std::sync::Arc<dyn kigi_auth::AuthCredentialProvider>,
|
||||
) -> reqwest_middleware::ClientWithMiddleware {
|
||||
kigi_http::with_auth_retry(kigi_http::shared_client(), credentials)
|
||||
}
|
||||
|
||||
fn build_static_middleware_client(
|
||||
api_key: Option<String>,
|
||||
) -> reqwest_middleware::ClientWithMiddleware {
|
||||
let provider: std::sync::Arc<dyn kigi_auth::AuthCredentialProvider> = std::sync::Arc::new(
|
||||
kigi_auth::StaticAuthCredentialProvider::new(Box::new(NoopHttpAuth), api_key),
|
||||
);
|
||||
build_middleware_client(provider)
|
||||
}
|
||||
|
||||
struct NoopHttpAuth;
|
||||
|
||||
impl kigi_auth::HttpAuth for NoopHttpAuth {
|
||||
fn apply(&self, builder: reqwest::RequestBuilder, _base_url: &str) -> reqwest::RequestBuilder {
|
||||
builder
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl EmbeddingProvider for ApiEmbeddingProvider {
|
||||
#[tracing::instrument(name = "memory.embed_batch", skip_all, fields(batch_size = texts.len()))]
|
||||
async fn embed_batch(
|
||||
&self,
|
||||
texts: &[&str],
|
||||
) -> Result<Vec<Vec<f32>>, Box<dyn std::error::Error>> {
|
||||
if texts.is_empty() {
|
||||
return Ok(vec![]);
|
||||
}
|
||||
|
||||
let mut all_embeddings = Vec::with_capacity(texts.len());
|
||||
|
||||
// Process in batches to respect API payload limits
|
||||
for batch in texts.chunks(self.max_batch_size) {
|
||||
let input: Vec<&str> = batch.to_vec();
|
||||
let body_json = serde_json::json!({
|
||||
"model": self.model,
|
||||
"input": input,
|
||||
"dimensions": self.dimensions,
|
||||
});
|
||||
|
||||
// Retry with exponential backoff on transient errors (429, 5xx)
|
||||
let mut last_err = String::new();
|
||||
let mut success = false;
|
||||
for attempt in 0..MAX_RETRIES {
|
||||
if attempt > 0 {
|
||||
let delay = INITIAL_BACKOFF_MS * 2u64.pow(attempt as u32 - 1);
|
||||
tracing::warn!(
|
||||
attempt,
|
||||
delay_ms = delay,
|
||||
"retrying embedding API call after transient error"
|
||||
);
|
||||
tokio::time::sleep(std::time::Duration::from_millis(delay)).await;
|
||||
}
|
||||
|
||||
let request = kigi_http::shared_client()
|
||||
.post(format!("{}/embeddings", self.api_base))
|
||||
.json(&body_json)
|
||||
.header("X-XAI-Token-Auth", "xai-grok-cli")
|
||||
.header("x-grok-client-version", kigi_version::VERSION);
|
||||
|
||||
let req = match request.build() {
|
||||
Ok(r) => r,
|
||||
Err(e) => {
|
||||
return Err(format!("failed to build embedding request: {e}").into());
|
||||
}
|
||||
};
|
||||
let response = match self.client.execute(req).await {
|
||||
Ok(r) => r,
|
||||
Err(e) => {
|
||||
last_err = format!("request failed: {e}");
|
||||
continue;
|
||||
}
|
||||
};
|
||||
|
||||
let status = response.status();
|
||||
if status.is_success() {
|
||||
let body: serde_json::Value = response.json().await?;
|
||||
let data = body
|
||||
.get("data")
|
||||
.and_then(|d| d.as_array())
|
||||
.ok_or("embedding response missing 'data' array")?;
|
||||
|
||||
for item in data {
|
||||
let embedding: Vec<f32> = item
|
||||
.get("embedding")
|
||||
.and_then(|e| e.as_array())
|
||||
.ok_or("embedding item missing 'embedding' array")?
|
||||
.iter()
|
||||
.filter_map(|v| v.as_f64().map(|f| f as f32))
|
||||
.collect();
|
||||
all_embeddings.push(embedding);
|
||||
}
|
||||
success = true;
|
||||
break;
|
||||
}
|
||||
|
||||
// Retry on 429 (rate limit) or 5xx (server error)
|
||||
if status == reqwest::StatusCode::TOO_MANY_REQUESTS || status.is_server_error() {
|
||||
last_err = format!(
|
||||
"HTTP {status}: {}",
|
||||
response.text().await.unwrap_or_default()
|
||||
);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Non-retryable error (4xx other than 429)
|
||||
let body = response.text().await.unwrap_or_default();
|
||||
return Err(format!("embedding API error {status}: {body}").into());
|
||||
}
|
||||
|
||||
if !success {
|
||||
return Err(format!(
|
||||
"embedding API failed after {MAX_RETRIES} attempts: {last_err}"
|
||||
)
|
||||
.into());
|
||||
}
|
||||
}
|
||||
|
||||
Ok(all_embeddings)
|
||||
}
|
||||
|
||||
fn model_name(&self) -> &str {
|
||||
&self.model
|
||||
}
|
||||
|
||||
fn dimensions(&self) -> usize {
|
||||
self.dimensions
|
||||
}
|
||||
}
|
||||
|
||||
/// A mock embedding provider for testing that returns deterministic vectors.
|
||||
/// Uses blake3 hash of text → float values for reproducible results.
|
||||
pub struct MockEmbeddingProvider {
|
||||
pub dimensions: usize,
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl EmbeddingProvider for MockEmbeddingProvider {
|
||||
async fn embed_batch(
|
||||
&self,
|
||||
texts: &[&str],
|
||||
) -> Result<Vec<Vec<f32>>, Box<dyn std::error::Error>> {
|
||||
Ok(texts
|
||||
.iter()
|
||||
.map(|text| {
|
||||
let hash = blake3::hash(text.as_bytes());
|
||||
let bytes = hash.as_bytes();
|
||||
(0..self.dimensions)
|
||||
.map(|i| bytes[i % 32] as f32 / 255.0)
|
||||
.collect()
|
||||
})
|
||||
.collect())
|
||||
}
|
||||
|
||||
fn model_name(&self) -> &str {
|
||||
"mock-embedding"
|
||||
}
|
||||
|
||||
fn dimensions(&self) -> usize {
|
||||
self.dimensions
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mock_embedding_deterministic() {
|
||||
let provider = MockEmbeddingProvider { dimensions: 4 };
|
||||
let r1 = provider.embed_batch(&["hello"]).await.unwrap();
|
||||
let r2 = provider.embed_batch(&["hello"]).await.unwrap();
|
||||
assert_eq!(r1, r2);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mock_embedding_different_texts() {
|
||||
let provider = MockEmbeddingProvider { dimensions: 4 };
|
||||
let results = provider.embed_batch(&["hello", "world"]).await.unwrap();
|
||||
assert_eq!(results.len(), 2);
|
||||
assert_ne!(results[0], results[1]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mock_embedding_empty_input() {
|
||||
let provider = MockEmbeddingProvider { dimensions: 4 };
|
||||
let results = provider.embed_batch(&[]).await.unwrap();
|
||||
assert!(results.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_mock_embedding_correct_dimensions() {
|
||||
let provider = MockEmbeddingProvider { dimensions: 128 };
|
||||
let results = provider.embed_batch(&["test"]).await.unwrap();
|
||||
assert_eq!(results[0].len(), 128);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user