improve llms.txt

This commit is contained in:
Nicolò Boschi 2025-12-10 13:55:55 +01:00
parent 0000c54509
commit 52826de55d

View file

@ -4,7 +4,16 @@
Hindsight is an agent memory system that gives AI agents persistent, structured memory across sessions. It extracts facts, entities, and relationships from conversations and enables temporal reasoning, opinion formation, and multi-strategy retrieval.
For complete documentation, see: https://vectorize-io.github.io/hindsight/llms-full.txt
## Links
- [Full Documentation (llms-full.txt)](https://vectorize-io.github.io/hindsight/llms-full.txt): Complete documentation for LLM consumption
- [Quick Start](https://vectorize-io.github.io/hindsight/developer/api/quickstart): Get started in 60 seconds
- [Python SDK](https://vectorize-io.github.io/hindsight/sdks/python): Python client library
- [TypeScript SDK](https://vectorize-io.github.io/hindsight/sdks/nodejs): Node.js/TypeScript client
- [API Reference](https://vectorize-io.github.io/hindsight/api-reference): REST API documentation
- [OpenAPI Spec](https://vectorize-io.github.io/hindsight/openapi.json): Machine-readable API specification
- [MCP Server](https://vectorize-io.github.io/hindsight/sdks/mcp): Model Context Protocol integration
- [GitHub](https://github.com/vectorize-io/hindsight): Source code and issues
## Core Operations
@ -14,6 +23,10 @@ For complete documentation, see: https://vectorize-io.github.io/hindsight/llms-f
## Quick Start
```bash
pip install hindsight-client
```
```python
from hindsight import HindsightClient
@ -50,39 +63,55 @@ client.retain(
)
```
## Documentation
## API Endpoints
- Docs: https://vectorize-io.github.io/hindsight
- GitHub: https://github.com/vectorize-io/hindsight
- Python client: pip install hindsight-client
- TypeScript client: npm install @vectorize-io/hindsight-client
Base URL: `http://localhost:8888`
## API Reference
Base URL: http://localhost:8888 (default)
### POST /v1/default/banks/{bank_id}/retain
Store memories in a bank.
### POST /v1/default/banks/{bank_id}/recall
Retrieve memories matching a query.
### POST /v1/default/banks/{bank_id}/reflect
Analyze memories and form opinions/insights.
### GET /v1/default/banks/{bank_id}/profile
Get bank profile (disposition, background).
### PUT /v1/default/banks/{bank_id}/profile
Update bank disposition and background.
| Method | Endpoint | Description |
|--------|----------|-------------|
| POST | `/v1/default/banks/{bank_id}/retain` | Store memories |
| POST | `/v1/default/banks/{bank_id}/recall` | Retrieve memories |
| POST | `/v1/default/banks/{bank_id}/reflect` | Analyze and form opinions |
| GET | `/v1/default/banks/{bank_id}/profile` | Get bank profile |
| PUT | `/v1/default/banks/{bank_id}/profile` | Update bank profile |
| GET | `/v1/default/banks` | List all banks |
| POST | `/v1/default/banks` | Create a bank |
## Architecture Patterns
### Per-User Memory
One bank per user. Simplest pattern for chatbots and assistants.
[Guide](https://vectorize-io.github.io/hindsight/cookbook/per-user-memory)
### Support Agent + Shared Knowledge
User bank + shared docs bank. Client orchestrates queries to both banks and merges results.
[Guide](https://vectorize-io.github.io/hindsight/cookbook/support-agent-with-shared-knowledge)
### With Curated Learnings
User bank + shared docs + learnings bank. Promote verified solutions to shared learnings.
## Installation
### Docker (recommended)
```bash
docker run -p 8888:8888 -e HINDSIGHT_API_LLM_PROVIDER=openai -e HINDSIGHT_API_LLM_API_KEY=$OPENAI_API_KEY ghcr.io/vectorize-io/hindsight
```
### Python (embedded)
```bash
pip install hindsight-all
```
### Clients
```bash
pip install hindsight-client # Python
npm install @vectorize-io/hindsight-client # TypeScript
```
## MCP Integration
Hindsight provides a Model Context Protocol server for direct AI agent integration:
```bash
pip install hindsight-mcp-server
hindsight-mcp-server --api-url http://localhost:8888
```
Tools exposed: `retain`, `recall`, `reflect`, `list_banks`, `create_bank`