brain-db-sdk 0.3.1

Rust client SDK for the Brain memory database. Speaks Brain's BRN0 wire protocol directly over TCP.
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

//! Feature: QUERY introspection debug surface — explain (plan) and trace
//! (execution).
//!
//! Integration tests against a real server, gated on `BRAIN_SDK_IT_DATA`
//! (see `scripts/it-server.sh`). Each test mints a fresh, isolated agent.

#[path = "../common/mod.rs"]
mod common;

use brain_db_sdk::wire::types::{
    QueryExplainRequest, QueryRequest, QueryTraceRequest, RetrieverSelectionWire,
};
use brain_db_sdk::{new_id, EncodeBuilder};

fn query(text: &str) -> QueryRequest {
    QueryRequest {
        text: text.to_string(),
        entity_anchor: None,
        kind_filter: vec![],
        predicate_filter: vec![],
        session_filter: None,
        time_filter: None,
        as_of_record_time_unix_nanos: None,
        confidence_min: None,
        include_tombstoned: false,
        include_superseded: false,
        limit: 10,
        retrievers: RetrieverSelectionWire::Auto,
        fusion_config: None,
        request_id: new_id(),
    }
}

#[tokio::test]
async fn explain_returns_a_plan() {
    let Some(it) = common::It::from_env() else {
        return common::skip("explain_returns_a_plan");
    };
    let (client, _agent) = it.connect_fresh().await;

    let resp = client
        .query_explain(&QueryExplainRequest {
            query: query("coffee"),
        })
        .await
        .expect("query_explain");
    assert!(
        !resp.plan_text.is_empty(),
        "explain returns a non-empty plan"
    );
    assert!(resp.estimated_cost_ms >= 0.0);
    client.close().await.expect("close");
}

#[tokio::test]
async fn trace_returns_an_execution_trace() {
    let Some(it) = common::It::from_env() else {
        return common::skip("trace_returns_an_execution_trace");
    };
    let (client, _agent) = it.connect_fresh().await;
    client
        .encode(&EncodeBuilder::new("Espresso is a concentrated coffee.").build())
        .await
        .expect("encode");

    let resp = client
        .query_trace(&QueryTraceRequest {
            query: query("coffee"),
        })
        .await
        .expect("query_trace");
    assert!(
        !resp.trace_text.is_empty(),
        "trace returns a non-empty trace"
    );
    assert!(resp.total_latency_ms >= 0.0);
    client.close().await.expect("close");
}