fleet-memory/hindsight-clients/rust
Nicolò Boschi 55af468187
feat: observation_scopes field to drive observations granularity (#447)
* 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
2026-02-28 10:46:21 +01:00
..
src feat: observation_scopes field to drive observations granularity (#447) 2026-02-28 10:46:21 +01:00
build.rs feat: observation_scopes field to drive observations granularity (#447) 2026-02-28 10:46:21 +01:00
Cargo.lock Fix Python SDK not sending Authorization header (#106) 2026-01-07 09:46:50 +01:00
Cargo.toml feat(misc): update clients types, test coverage, improve /health endpoint and add changelog (#70) 2025-12-23 12:49:31 +01:00
INTEGRATION.md rename to new names 2025-11-27 16:22:16 +01:00
README.md rename to new names 2025-11-27 16:22:16 +01:00

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

  1. build.rs reads the OpenAPI spec from ../../openapi.json
  2. Converts OpenAPI 3.1 → 3.0 (for progenitor compatibility)
  3. Generates Rust client code using progenitor
  4. 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 agents
  • create_or_update_agent() - Create or update an agent
  • get_agent_profile() - Get agent profile with personality
  • update_agent_personality() - Update agent personality traits
  • add_agent_background() - Add/merge agent background
  • get_agent_stats() - Get memory statistics

Memory Operations

  • search_memories() - Semantic search across memories
  • think() - Generate contextual answers using agent identity
  • batch_put_memories() - Store multiple memories
  • batch_put_async() - Queue memories for background processing
  • list_memories() - List memory units with pagination
  • delete_memory_unit() - Delete a specific memory
  • clear_agent_memories() - Clear all or filtered memories

Document Management

  • list_documents() - List documents with optional search
  • get_document() - Get document details and content
  • delete_document() - Delete document and its memories

Operations (Async Tasks)

  • list_operations() - List async operations
  • cancel_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