* feat: observation_scopes field to drive observations granularity * fix(migration): make a2b3c4d5e6f7 a no-op to fix CI on fresh DB The z1u2v3w4x5y6 migration already creates observation_scopes directly, so the rename migration fails on fresh installs where observation_tags never existed. * chore: remove no-op migration a2b3c4d5e6f7 * feat: regenerate clients with observation_scopes field - Add observation_scopes to OpenAPI spec and all generated clients - Fix Rust build.rs to handle anyOf with >2 variants containing null (previously only handled 2-item anyOf, causing progenitor to panic on the observation_scopes union type) * fix(rust): add observation_scopes: None to MemoryItem struct literals * fix(api): add title to observation_scopes Field for deterministic client generation Adding title="ObservationScopes" makes the inline anyOf schema use the explicit name instead of deriving it from the field name, which was non-deterministic between arm64 (macOS) and amd64 (CI) Docker. Also fixes description: "each entity" -> "each tag". * fix(scripts): use linux/amd64 Docker for client generation to ensure reproducibility Both Python and Go client generation now use --platform linux/amd64 Docker, ensuring identical output on macOS arm64 (local) and Linux amd64 (CI). Also switches Go from JAR+Java to Docker to eliminate Java version variability. * chore: update generated clients to API v0.4.14 * fix(test): add retry logic to test_retain_chinese_content to handle non-deterministic LLM output * fix(test): mark test_retain_chinese_content as xfail due to non-deterministic LLM translation |
||
|---|---|---|
| .. | ||
| src | ||
| build.rs | ||
| Cargo.lock | ||
| Cargo.toml | ||
| INTEGRATION.md | ||
| README.md | ||
Hindsight Rust Client
Auto-generated Rust client library for the Hindsight semantic memory system API.
Features
- 🦀 Fully typed - Complete type safety with Rust's type system
- 🔄 Auto-generated - Stays in sync with the OpenAPI spec automatically
- ⚡ Async/await - Built on tokio and reqwest for modern async Rust
- 📦 Standalone - Can be published to crates.io independently
Installation
Add to your Cargo.toml:
[dependencies]
hindsight-client = "0.1.0"
tokio = { version = "1", features = ["full"] }
Quick Start
use hindsight_client::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// Create a client
let client = Client::new("http://localhost:8888");
// List all agents
let agents = client.list_agents().await?;
for agent in agents {
println!("Agent: {} - {}", agent.agent_id, agent.name);
}
// Get agent profile
let profile = client.get_agent_profile("my-agent").await?;
println!("Background: {}", profile.background);
// Search memories
let search_request = hindsight_client::types::SearchRequest {
query: "What did I learn today?".to_string(),
fact_type: None,
thinking_budget: Some(100),
max_tokens: Some(4096),
trace: Some(false),
};
let results = client.search_memories("my-agent", &search_request).await?;
for result in results.results {
println!("- {}", result.text);
}
// Store a memory
let memory_request = hindsight_client::types::BatchMemoryRequest {
items: vec![
hindsight_client::types::MemoryItem {
content: "I learned about Rust today".to_string(),
context: Some("Daily learning".to_string()),
}
],
document_id: Some("my-doc".to_string()),
};
client.batch_put_memories("my-agent", &memory_request).await?;
Ok(())
}
How It Works
This library uses progenitor to generate the client code from the OpenAPI specification at build time.
The generation happens automatically when you run cargo build, so the client always stays in sync with the API schema.
Build Process
build.rsreads the OpenAPI spec from../../openapi.json- Converts OpenAPI 3.1 → 3.0 (for progenitor compatibility)
- Generates Rust client code using progenitor
- Code is included in the library via
include!()macro
API Methods
All API endpoints are available as async methods on the Client struct:
Agent Management
list_agents()- List all agentscreate_or_update_agent()- Create or update an agentget_agent_profile()- Get agent profile with personalityupdate_agent_personality()- Update agent personality traitsadd_agent_background()- Add/merge agent backgroundget_agent_stats()- Get memory statistics
Memory Operations
search_memories()- Semantic search across memoriesthink()- Generate contextual answers using agent identitybatch_put_memories()- Store multiple memoriesbatch_put_async()- Queue memories for background processinglist_memories()- List memory units with paginationdelete_memory_unit()- Delete a specific memoryclear_agent_memories()- Clear all or filtered memories
Document Management
list_documents()- List documents with optional searchget_document()- Get document details and contentdelete_document()- Delete document and its memories
Operations (Async Tasks)
list_operations()- List async operationscancel_operation()- Cancel a pending operation
Visualization
get_graph()- Get memory graph data for visualization
Error Handling
The client uses progenitor_client::Error for all errors:
match client.get_agent_profile("my-agent").await {
Ok(profile) => println!("Got profile: {}", profile.name),
Err(progenitor_client::Error::ErrorResponse(resp)) => {
println!("API error: {} - {}", resp.status, resp.body);
}
Err(e) => println!("Other error: {}", e),
}
Development
Building
cargo build
The OpenAPI spec is automatically converted and the client is generated during build.
Testing
cargo test
Releasing
This client can be published to crates.io independently of the CLI:
cargo publish
Architecture
hindsight-clients/rust/
├── Cargo.toml # Package definition
├── build.rs # Build script (generates client)
├── src/
│ └── lib.rs # Library entry point
└── target/
└── debug/build/
└── hindsight-client-.../out/
└── hindsight_client_generated.rs # Generated code
License
MIT