From 078e46e52bf2beb7c2105afc59bd5122dcf6d7a6 Mon Sep 17 00:00:00 2001 From: Ben Date: Thu, 21 May 2026 13:34:07 -0400 Subject: [PATCH] docs(agno): prioritize Hindsight Cloud in quickstart MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Lead README + docs Quick Start with Cloud sign-up + Cloud API URL. Bulk-replace localhost:8888 examples with Cloud URL. Demote self-hosted to a 'Self-hosting (local development)' section below. Update docstring examples in __init__.py and tools.py. No framework guide exists for agno (skipped). Includes 2-line incidental skills/hindsight-docs/ regen drift. Note: 8 pre-existing test failures in tests/test_tools.py (TestResolveClient and friends) exist on main — production code passes user_agent kwarg to Hindsight() but the assertions don't expect it. Out of scope for this PR. --- hindsight-docs/docs-integrations/agno.md | 25 ++++++++++----- hindsight-integrations/agno/README.md | 32 ++++++++++++++----- .../agno/hindsight_agno/__init__.py | 4 +-- .../agno/hindsight_agno/tools.py | 3 +- .../references/developer/models.md | 1 + skills/hindsight-docs/references/faq.md | 1 + 6 files changed, 47 insertions(+), 19 deletions(-) diff --git a/hindsight-docs/docs-integrations/agno.md b/hindsight-docs/docs-integrations/agno.md index 9836ff91b..a48b04c56 100644 --- a/hindsight-docs/docs-integrations/agno.md +++ b/hindsight-docs/docs-integrations/agno.md @@ -24,6 +24,10 @@ pip install hindsight-agno ## Quick Start +:::tip Recommended: Hindsight Cloud +[Sign up free](https://ui.hindsight.vectorize.io/signup) and grab an API key — no self-hosting required. +::: + ```python from agno.agent import Agent from agno.models.openai import OpenAIChat @@ -33,7 +37,8 @@ agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", + api_key="hsk_...", # or set HINDSIGHT_API_KEY env var )], ) @@ -41,6 +46,10 @@ agent.print_response("Remember that I prefer dark mode") agent.print_response("What are my preferences?") ``` +### Self-hosting (local development) + +If you're running Hindsight locally with `./scripts/dev/start-api.sh`, swap the URL to `http://localhost:8888`. See the [installation guide](/developer/installation) for setup. + The agent now has three tools it can call: - **`retain_memory`** — Store information to long-term memory @@ -58,11 +67,11 @@ agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], instructions=[memory_instructions( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], ) ``` @@ -74,7 +83,7 @@ Include only the tools you need: ```python tools = [HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", enable_retain=True, enable_recall=True, enable_reflect=False, # Omit reflect @@ -93,7 +102,7 @@ The bank ID is resolved in order: # Per-user banks from RunContext agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), - tools=[HindsightTools(hindsight_api_url="http://localhost:8888")], + tools=[HindsightTools(hindsight_api_url="https://api.hindsight.vectorize.io")], user_id="user-123", # Used as bank_id ) @@ -105,7 +114,7 @@ agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_resolver=resolve_bank, - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], ) ``` @@ -118,7 +127,7 @@ Instead of passing connection details to every toolkit, configure once: from hindsight_agno import configure, HindsightTools configure( - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", api_key="your-api-key", # Or set HINDSIGHT_API_KEY env var budget="mid", # Recall budget: low/mid/high max_tokens=4096, # Max tokens for recall results @@ -171,7 +180,7 @@ tools = [HindsightTools(bank_id="user-123")] | Parameter | Default | Description | |---|---|---| -| `hindsight_api_url` | Production API | Hindsight API URL | +| `hindsight_api_url` | Hindsight Cloud (`https://api.hindsight.vectorize.io`) | Hindsight API URL | | `api_key` | `HINDSIGHT_API_KEY` env | API key for authentication | | `budget` | `"mid"` | Default recall budget level | | `max_tokens` | `4096` | Default max tokens for recall | diff --git a/hindsight-integrations/agno/README.md b/hindsight-integrations/agno/README.md index d0755dc06..a83eeb7d6 100644 --- a/hindsight-integrations/agno/README.md +++ b/hindsight-integrations/agno/README.md @@ -18,6 +18,8 @@ pip install hindsight-agno ## Quick Start +> ✨ **Recommended: [Hindsight Cloud](https://ui.hindsight.vectorize.io/signup)** — free tier, no self-hosting required. Sign up and grab an API key in under a minute. + ```python from agno.agent import Agent from agno.models.openai import OpenAIChat @@ -27,7 +29,8 @@ agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", + api_key="hsk_...", # or set HINDSIGHT_API_KEY env var )], ) @@ -41,6 +44,19 @@ The agent now has three tools it can call: - **`recall_memory`** — Search long-term memory for relevant facts - **`reflect_on_memory`** — Synthesize a reasoned answer from memories +### Self-hosting (local development) + +If you're running Hindsight locally with `./scripts/dev/start-api.sh`, point at your local server instead: + +```python +tools=[HindsightTools( + bank_id="user-123", + hindsight_api_url="https://api.hindsight.vectorize.io", +)] +``` + +See the [Hindsight installation guide](https://hindsight.vectorize.io/developer/installation) for self-hosting setup. + ## With Memory Instructions Pre-recall relevant memories and inject them into the system prompt: @@ -52,11 +68,11 @@ agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], instructions=[memory_instructions( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], ) ``` @@ -68,7 +84,7 @@ Include only the tools you need: ```python tools = [HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", enable_retain=True, enable_recall=True, enable_reflect=False, # Omit reflect @@ -87,7 +103,7 @@ The bank ID is resolved in order: # Per-user banks from RunContext agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), - tools=[HindsightTools(hindsight_api_url="http://localhost:8888")], + tools=[HindsightTools(hindsight_api_url="https://api.hindsight.vectorize.io")], user_id="user-123", # Used as bank_id ) @@ -99,7 +115,7 @@ agent = Agent( model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_resolver=resolve_bank, - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], ) ``` @@ -112,7 +128,7 @@ Instead of passing connection details to every toolkit, configure once: from hindsight_agno import configure, HindsightTools configure( - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", api_key="your-api-key", # Or set HINDSIGHT_API_KEY env var budget="mid", # Recall budget: low/mid/high max_tokens=4096, # Max tokens for recall results @@ -165,7 +181,7 @@ tools = [HindsightTools(bank_id="user-123")] | Parameter | Default | Description | |---|---|---| -| `hindsight_api_url` | Production API | Hindsight API URL | +| `hindsight_api_url` | Hindsight Cloud (`https://api.hindsight.vectorize.io`) | Hindsight API URL | | `api_key` | `HINDSIGHT_API_KEY` env | API key for authentication | | `budget` | `"mid"` | Default recall budget level | | `max_tokens` | `4096` | Default max tokens for recall | diff --git a/hindsight-integrations/agno/hindsight_agno/__init__.py b/hindsight-integrations/agno/hindsight_agno/__init__.py index bcab7145d..28588af4d 100644 --- a/hindsight-integrations/agno/hindsight_agno/__init__.py +++ b/hindsight-integrations/agno/hindsight_agno/__init__.py @@ -13,11 +13,11 @@ model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], instructions=[memory_instructions( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", )], ) diff --git a/hindsight-integrations/agno/hindsight_agno/tools.py b/hindsight-integrations/agno/hindsight_agno/tools.py index fa4b2d5cd..050709b36 100644 --- a/hindsight-integrations/agno/hindsight_agno/tools.py +++ b/hindsight-integrations/agno/hindsight_agno/tools.py @@ -96,7 +96,8 @@ class HindsightTools(Toolkit): model=OpenAIChat(id="gpt-4o-mini"), tools=[HindsightTools( bank_id="user-123", - hindsight_api_url="http://localhost:8888", + hindsight_api_url="https://api.hindsight.vectorize.io", + api_key="hsk_...", )], ) agent.print_response("Remember that I prefer dark mode") diff --git a/skills/hindsight-docs/references/developer/models.md b/skills/hindsight-docs/references/developer/models.md index b50e625a4..51278726a 100644 --- a/skills/hindsight-docs/references/developer/models.md +++ b/skills/hindsight-docs/references/developer/models.md @@ -30,6 +30,7 @@ Used for fact extraction, entity resolution, mental model consolidation, and ans - MiniMax - DeepSeek - z.ai +- opencode-go - Volcano Engine - OpenRouter - OpenAI Codex diff --git a/skills/hindsight-docs/references/faq.md b/skills/hindsight-docs/references/faq.md index 8b8b96a62..f4f8f2aca 100644 --- a/skills/hindsight-docs/references/faq.md +++ b/skills/hindsight-docs/references/faq.md @@ -76,6 +76,7 @@ Browse all supported integrations in the Integrations Hub. - MiniMax - DeepSeek - z.ai +- opencode-go - Volcano Engine - OpenRouter - OpenAI Codex