terraphim_rlm 1.20.5

Recursive Language Model (RLM) orchestration for Terraphim AI
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
//! LLM Bridge for VM-to-host communication.
//!
//! This module provides an HTTP endpoint that allows code running inside VMs
//! to invoke the LLM recursively. The bridge:
//!
//! - Validates session tokens before processing requests
//! - Forwards queries to the LLM service
//! - Tracks budget consumption (tokens, time)
//! - Supports batched queries for concurrent execution
//!
//! ## Security
//!
//! Every request must include an `X-Session-Token` header containing a valid
//! session ID. The bridge validates this against the SessionManager before
//! processing any queries.
//!
//! ## API Endpoints
//!
//! - `POST /query` - Single LLM query
//! - `POST /query_batched` - Multiple concurrent queries
//! - `GET /health` - Bridge health check

use std::sync::Arc;

use serde::{Deserialize, Serialize};

use crate::budget::BudgetTracker;
use crate::error::{RlmError, RlmResult};
use crate::session::SessionManager;
use crate::types::{LlmQuery, SessionId};

/// Request body for single LLM query.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct QueryRequest {
    /// The prompt to send to the LLM.
    pub prompt: String,
    /// Optional model override.
    pub model: Option<String>,
    /// Optional temperature override.
    pub temperature: Option<f32>,
    /// Optional max tokens override.
    pub max_tokens: Option<u32>,
}

impl From<QueryRequest> for LlmQuery {
    fn from(req: QueryRequest) -> Self {
        LlmQuery {
            prompt: req.prompt,
            model: req.model,
            temperature: req.temperature,
            max_tokens: req.max_tokens,
        }
    }
}

/// Response body for LLM query.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct QueryResponse {
    /// The LLM's response text.
    pub response: String,
    /// Tokens consumed by this query.
    pub tokens_used: u64,
    /// Time taken in milliseconds.
    pub time_ms: u64,
    /// Remaining token budget after this query.
    pub tokens_remaining: u64,
    /// Remaining time budget in milliseconds.
    pub time_remaining_ms: u64,
}

/// Request body for batched LLM queries.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BatchedQueryRequest {
    /// List of queries to execute concurrently.
    pub queries: Vec<QueryRequest>,
}

/// Response body for batched queries.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BatchedQueryResponse {
    /// List of responses in the same order as queries.
    pub responses: Vec<Result<QueryResponse, String>>,
    /// Total tokens consumed by all queries.
    pub total_tokens_used: u64,
    /// Total time taken in milliseconds.
    pub total_time_ms: u64,
}

/// LLM Bridge server configuration.
#[derive(Debug, Clone)]
pub struct LlmBridgeConfig {
    /// Port to listen on.
    pub port: u16,
    /// Bind address. Defaults to "127.0.0.1" to avoid exposing the bridge to all interfaces.
    /// Set to "0.0.0.0" explicitly when the bridge needs to be accessible from VMs or remote hosts.
    pub bind_addr: String,
    /// Maximum concurrent queries in a batch.
    pub max_batch_size: usize,
    /// Request timeout in milliseconds.
    pub request_timeout_ms: u64,
}

impl Default for LlmBridgeConfig {
    fn default() -> Self {
        Self {
            port: 8080,
            bind_addr: "127.0.0.1".to_string(),
            max_batch_size: 10,
            request_timeout_ms: 30_000,
        }
    }
}

/// LLM Bridge handles VM-to-host LLM queries.
///
/// The bridge runs as an HTTP server accessible from VMs and forwards
/// queries to the LLM service while enforcing session-based authentication
/// and budget limits.
pub struct LlmBridge {
    /// Configuration for the bridge.
    config: LlmBridgeConfig,
    /// Session manager for token validation.
    session_manager: Arc<SessionManager>,
    /// Budget trackers per session.
    budget_trackers: dashmap::DashMap<SessionId, Arc<BudgetTracker>>,
    /// Optional real LLM client.  When `None`, `query()` returns
    /// `LlmNotConfigured` instead of a silent stub.
    #[cfg(feature = "llm")]
    llm_client: Option<Arc<dyn terraphim_service::llm::LlmClient>>,
}

impl LlmBridge {
    /// Create a new LLM bridge without a real LLM client.
    /// Queries will return `LlmNotConfigured`.
    pub fn new(config: LlmBridgeConfig, session_manager: Arc<SessionManager>) -> Self {
        Self {
            config,
            session_manager,
            budget_trackers: dashmap::DashMap::new(),
            #[cfg(feature = "llm")]
            llm_client: None,
        }
    }

    /// Create a new LLM bridge with a configured LLM client.
    #[cfg(feature = "llm")]
    pub fn with_llm_client(
        config: LlmBridgeConfig,
        session_manager: Arc<SessionManager>,
        client: Arc<dyn terraphim_service::llm::LlmClient>,
    ) -> Self {
        Self {
            config,
            session_manager,
            budget_trackers: dashmap::DashMap::new(),
            llm_client: Some(client),
        }
    }

    /// Validate a session token.
    ///
    /// Returns the session ID if valid.
    pub fn validate_token(&self, token: &str) -> RlmResult<SessionId> {
        let session_id =
            SessionId::from_string(token).map_err(|_| RlmError::InvalidSessionToken {
                token: token.to_string(),
            })?;

        // Validate session exists and is not expired
        self.session_manager.validate_session(&session_id)?;

        Ok(session_id)
    }

    /// Get or create a budget tracker for a session.
    pub fn get_budget_tracker(&self, session_id: &SessionId) -> Arc<BudgetTracker> {
        self.budget_trackers
            .entry(*session_id)
            .or_insert_with(|| {
                let session = self
                    .session_manager
                    .get_session(session_id)
                    .expect("session should exist after validation");
                Arc::new(BudgetTracker::from_status(&session.budget_status))
            })
            .clone()
    }

    /// Process a single LLM query.
    ///
    /// # Arguments
    ///
    /// * `session_id` - The validated session ID
    /// * `request` - The query request
    ///
    /// # Returns
    ///
    /// The query response with budget information.
    pub async fn query(
        &self,
        session_id: &SessionId,
        request: QueryRequest,
    ) -> RlmResult<QueryResponse> {
        let budget = self.get_budget_tracker(session_id);

        // Check budget before processing
        budget.check_all()?;

        // Increment recursion depth
        budget.push_recursion()?;

        let start = std::time::Instant::now();

        #[cfg(feature = "llm")]
        let response_text = match &self.llm_client {
            Some(client) => {
                let chat_opts = terraphim_service::llm::ChatOptions {
                    max_tokens: request.max_tokens,
                    temperature: request.temperature,
                };
                let messages = vec![serde_json::json!({
                    "role": "user",
                    "content": request.prompt
                })];
                client
                    .chat_completion(messages, chat_opts)
                    .await
                    .map_err(|e| RlmError::LlmCallFailed {
                        message: e.to_string(),
                    })?
            }
            None => {
                return Err(RlmError::LlmNotConfigured);
            }
        };

        #[cfg(not(feature = "llm"))]
        {
            let _request = request;
            return Err(RlmError::LlmNotConfigured);
        }

        // Estimate tokens (1 token ~= 4 chars for English text)
        let estimated_tokens = (request.prompt.len() / 4 + response_text.len() / 4) as u64;

        // Record token usage
        budget.add_tokens(estimated_tokens)?;

        let time_ms = start.elapsed().as_millis() as u64;

        // Pop recursion depth
        budget.pop_recursion();

        Ok(QueryResponse {
            response: response_text,
            tokens_used: estimated_tokens,
            time_ms,
            tokens_remaining: budget.tokens_remaining(),
            time_remaining_ms: budget.time_remaining_ms(),
        })
    }

    /// Process batched LLM queries concurrently.
    ///
    /// # Arguments
    ///
    /// * `session_id` - The validated session ID
    /// * `request` - The batched query request
    ///
    /// # Returns
    ///
    /// The batched response with all query results.
    pub async fn query_batched(
        &self,
        session_id: &SessionId,
        request: BatchedQueryRequest,
    ) -> RlmResult<BatchedQueryResponse> {
        let budget = self.get_budget_tracker(session_id);

        // Check budget before processing
        budget.check_all()?;

        // Enforce batch size limit
        if request.queries.len() > self.config.max_batch_size {
            return Err(RlmError::BatchSizeTooLarge {
                size: request.queries.len(),
                max: self.config.max_batch_size,
            });
        }

        let start = std::time::Instant::now();

        // Execute queries concurrently using tokio::join_all
        let futures: Vec<_> = request
            .queries
            .into_iter()
            .map(|query| {
                let session_id = *session_id;
                let this = self;
                async move { this.query(&session_id, query).await }
            })
            .collect();

        let results = futures::future::join_all(futures).await;

        // Convert results to response format
        let mut total_tokens = 0u64;
        let responses: Vec<Result<QueryResponse, String>> = results
            .into_iter()
            .map(|r| match r {
                Ok(resp) => {
                    total_tokens += resp.tokens_used;
                    Ok(resp)
                }
                Err(e) => Err(e.to_string()),
            })
            .collect();

        let total_time_ms = start.elapsed().as_millis() as u64;

        Ok(BatchedQueryResponse {
            responses,
            total_tokens_used: total_tokens,
            total_time_ms,
        })
    }

    /// Get the bind address for the HTTP server.
    pub fn bind_addr(&self) -> String {
        format!("{}:{}", self.config.bind_addr, self.config.port)
    }

    /// Get the configuration.
    pub fn config(&self) -> &LlmBridgeConfig {
        &self.config
    }
}

impl BudgetTracker {
    /// Create a budget tracker from a budget status.
    pub fn from_status(status: &crate::types::BudgetStatus) -> Self {
        use crate::config::RlmConfig;

        let config = RlmConfig {
            token_budget: status.token_budget,
            time_budget_ms: status.time_budget_ms,
            max_recursion_depth: status.max_recursion_depth,
            ..Default::default()
        };

        let tracker = Self::new(&config);

        // Restore current state
        if status.tokens_used > 0 {
            tracker.add_tokens(status.tokens_used).ok();
        }

        for _ in 0..status.current_recursion_depth {
            tracker.push_recursion().ok();
        }

        tracker
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::RlmConfig;

    fn create_test_bridge() -> (LlmBridge, SessionId) {
        let config = RlmConfig::default();
        let session_manager = Arc::new(SessionManager::new(config));
        let session = session_manager.create_session().unwrap();

        #[cfg(feature = "llm")]
        let bridge = {
            use ahash::AHashMap;
            use serde_json::Value;
            use terraphim_config::Role;
            use terraphim_types::RelevanceFunction;

            if let Ok(api_key) = std::env::var("OPENROUTER_API_KEY") {
                let mut extra = AHashMap::new();
                extra.insert(
                    "llm_provider".to_string(),
                    Value::String("genai".to_string()),
                );
                extra.insert(
                    "llm_model".to_string(),
                    Value::String("mistralai/mistral-7b-instruct:free".to_string()),
                );

                let role = Role {
                    shortname: None,
                    name: "test".into(),
                    relevance_function: RelevanceFunction::TitleScorer,
                    terraphim_it: false,
                    theme: "default".to_string(),
                    kg: None,
                    haystacks: vec![],
                    llm_enabled: true,
                    llm_api_key: Some(api_key),
                    llm_model: Some("mistralai/mistral-7b-instruct:free".to_string()),
                    llm_auto_summarize: false,
                    llm_chat_enabled: false,
                    llm_chat_system_prompt: None,
                    llm_chat_model: None,
                    llm_context_window: None,
                    extra,
                    llm_router_enabled: false,
                    llm_router_config: None,
                };

                if let Some(client) = terraphim_service::llm::build_llm_from_role(&role) {
                    LlmBridge::with_llm_client(LlmBridgeConfig::default(), session_manager, client)
                } else {
                    LlmBridge::new(LlmBridgeConfig::default(), session_manager)
                }
            } else {
                LlmBridge::new(LlmBridgeConfig::default(), session_manager)
            }
        };

        #[cfg(not(feature = "llm"))]
        let bridge = LlmBridge::new(LlmBridgeConfig::default(), session_manager);

        (bridge, session.id)
    }

    #[test]
    fn test_token_validation() {
        let (bridge, session_id) = create_test_bridge();

        // Valid token should succeed
        let result = bridge.validate_token(&session_id.to_string());
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), session_id);

        // Invalid token should fail
        let result = bridge.validate_token("invalid-token");
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_single_query() {
        if std::env::var("OPENROUTER_API_KEY").is_err() {
            eprintln!("Skipping test_single_query: OPENROUTER_API_KEY not set");
            return;
        }

        let (bridge, session_id) = create_test_bridge();

        let request = QueryRequest {
            prompt: "Hello, world!".to_string(),
            model: None,
            temperature: None,
            max_tokens: None,
        };

        let result = bridge.query(&session_id, request).await;
        assert!(result.is_ok(), "query failed: {:?}", result.err());

        let response = result.unwrap();
        assert!(!response.response.is_empty());
        assert!(response.tokens_used > 0);
    }

    #[tokio::test]
    async fn test_batched_query() {
        if std::env::var("OPENROUTER_API_KEY").is_err() {
            eprintln!("Skipping test_batched_query: OPENROUTER_API_KEY not set");
            return;
        }

        let (bridge, session_id) = create_test_bridge();

        let request = BatchedQueryRequest {
            queries: vec![
                QueryRequest {
                    prompt: "Query 1".to_string(),
                    model: None,
                    temperature: None,
                    max_tokens: None,
                },
                QueryRequest {
                    prompt: "Query 2".to_string(),
                    model: None,
                    temperature: None,
                    max_tokens: None,
                },
            ],
        };

        let result = bridge.query_batched(&session_id, request).await;
        assert!(result.is_ok(), "batched query failed: {:?}", result.err());

        let response = result.unwrap();
        assert_eq!(response.responses.len(), 2);
        assert!(response.total_tokens_used > 0);
    }

    #[tokio::test]
    async fn test_batch_size_limit() {
        let config = LlmBridgeConfig {
            max_batch_size: 2,
            ..Default::default()
        };
        let rlm_config = RlmConfig::default();
        let session_manager = Arc::new(SessionManager::new(rlm_config));
        let session = session_manager.create_session().unwrap();

        let bridge = LlmBridge::new(config, session_manager);

        let request = BatchedQueryRequest {
            queries: vec![
                QueryRequest {
                    prompt: "Query 1".to_string(),
                    model: None,
                    temperature: None,
                    max_tokens: None,
                },
                QueryRequest {
                    prompt: "Query 2".to_string(),
                    model: None,
                    temperature: None,
                    max_tokens: None,
                },
                QueryRequest {
                    prompt: "Query 3".to_string(),
                    model: None,
                    temperature: None,
                    max_tokens: None,
                },
            ],
        };

        let result = bridge.query_batched(&session.id, request).await;
        assert!(matches!(result, Err(RlmError::BatchSizeTooLarge { .. })));
    }

    #[test]
    fn test_budget_tracker_from_status() {
        let status = crate::types::BudgetStatus {
            token_budget: 1000,
            tokens_used: 100,
            time_budget_ms: 60_000,
            time_used_ms: 0,
            max_recursion_depth: 5,
            current_recursion_depth: 2,
        };

        let tracker = BudgetTracker::from_status(&status);
        assert_eq!(tracker.tokens_used(), 100);
        assert_eq!(tracker.current_depth(), 2);
    }
}