15ea23d5d6
* feat: introduce hindsight-api-slim and hindsight-all-slim packages Closes #552 - Move all source code from hindsight-api/ to new hindsight-api-slim/ - hindsight-api-slim has heavy ML deps (torch, sentence-transformers, transformers, einops, flashrank, mlx, mlx-lm, safetensors) and pg0-embedded as optional extras: [local-ml], [embedded-db], [all] - hindsight-api becomes a zero-code meta-package depending on hindsight-api-slim[all] for full backward compatibility - Add hindsight-all-slim meta-package: hindsight-api-slim + client + embed - hindsight-all updated to depend on hindsight-api-slim[all] - pg0.py: lazy-import pg0 with clear ImportError pointing to [embedded-db] - Dockerfile: replace sed hack with proper uv sync --extra flags - Update release.yml, test.yml, lint.sh, release.sh, CLAUDE.md and all path references throughout the repo * refactor: rename hindsight/ directory to hindsight-all/ * docs: document hindsight-api-slim and hindsight-all-slim package variants Add package variants table and extras explanation to installation.md * docs: remove emojis from installation.md, use professional tone * docs: link Docker slim variant to pip package variants section * docs: consolidate Docker image variants into single table * ci: fix working-directory paths after package restructure - Replace all hindsight-api → hindsight-api-slim in test.yml - Replace hindsight → hindsight-all in test.yml - Add --extra embedded-db to test-embed API install step * ci: add local-ml and embedded-db extras to API sync steps These extras were previously implicit in the old hindsight-api package (which bundled everything). Now that hindsight-api-slim uses optional extras, we must explicitly request local-ml and embedded-db in CI. * ci: add API install step with embedded-db to test-embed smoke test The smoke test starts hindsight-api as a daemon, which requires pg0-embedded. Add a dedicated install step for hindsight-api-slim with embedded-db extra so the daemon can start successfully. * ci: remove --no-install-project when using optional extras When --no-install-project is combined with --extra, the optional deps are not installed because extras require the project to be active. Remove --no-install-project from steps that need local-ml or embedded-db. * ci: fix ordering of uv sync steps to preserve optional extras When uv sync runs for a different workspace member, it removes optional extras installed for other members. Fix by always running extra-requiring API sync last, after other workspace member syncs. Also remove --no-install-project from embedded-db sync in test-embed, as --no-install-project prevents optional extras from being active. * ci: add local-ml extra to test-embed API install for smoke test The smoke test starts the full API server which needs sentence-transformers for local embeddings (default provider). Add local-ml extra to the install. * ci: simplify extras with --all-extras and add slim pip smoke test - Replace explicit --extra local-ml --extra embedded-db with --all-extras for cleaner, more maintainable sync steps - Add test-pip-slim job: tests hindsight-api-slim[embedded-db] without local ML models, using Cohere for embeddings/reranking (mirrors Docker slim smoke test approach) * ci: simplify slim smoke test to health check only (mirrors Docker test)
69 lines
1.9 KiB
Python
69 lines
1.9 KiB
Python
"""
|
|
Hindsight - All-in-one semantic memory system for AI agents.
|
|
|
|
This package provides a simple way to run Hindsight locally with embedded PostgreSQL.
|
|
|
|
Easiest way - Embedded client (recommended):
|
|
```python
|
|
from hindsight import HindsightEmbedded
|
|
|
|
# Server starts automatically on first use
|
|
client = HindsightEmbedded(
|
|
profile="myapp",
|
|
llm_provider="groq",
|
|
llm_api_key="your-api-key",
|
|
)
|
|
|
|
# Use immediately - no manual server management needed
|
|
client.retain(bank_id="alice", content="Alice loves AI")
|
|
results = client.recall(bank_id="alice", query="What does Alice like?")
|
|
```
|
|
|
|
Manual server management:
|
|
```python
|
|
from hindsight import start_server, HindsightClient
|
|
|
|
# Start server with embedded PostgreSQL (pg0)
|
|
server = start_server(
|
|
llm_provider="groq",
|
|
llm_api_key="your-api-key",
|
|
llm_model="openai/gpt-oss-120b"
|
|
)
|
|
|
|
# Create client
|
|
client = HindsightClient(base_url=server.url)
|
|
|
|
# Store memories
|
|
client.retain(bank_id="assistant", content="User prefers Python for data analysis")
|
|
|
|
# Search memories
|
|
results = client.recall(bank_id="assistant", query="programming preferences")
|
|
|
|
# Generate contextual response
|
|
response = client.reflect(bank_id="assistant", query="What are my interests?")
|
|
|
|
# Stop server when done
|
|
server.stop()
|
|
```
|
|
|
|
Using context manager:
|
|
```python
|
|
from hindsight import HindsightServer, HindsightClient
|
|
|
|
with HindsightServer(llm_provider="groq", llm_api_key="...") as server:
|
|
client = HindsightClient(base_url=server.url)
|
|
# ... use client ...
|
|
# Server automatically stops
|
|
```
|
|
"""
|
|
|
|
from .client_wrapper import HindsightClient
|
|
from .embedded import HindsightEmbedded
|
|
from .server import Server as HindsightServer, start_server
|
|
|
|
__all__ = [
|
|
"HindsightServer",
|
|
"start_server",
|
|
"HindsightClient",
|
|
"HindsightEmbedded",
|
|
]
|