-
Notifications
You must be signed in to change notification settings - Fork 731
docs(python): iii-sdk example replaces standalone REST client #364
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+208
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # Python usage via `iii-sdk` | ||
|
|
||
| agentmemory registers its core operations as iii functions (`mem::remember`, | ||
| `mem::observe`, `mem::context`, `mem::smart-search`, `mem::forget`). Any | ||
| language with an iii SDK can call them directly over the WebSocket transport | ||
| on `ws://localhost:49134` — no separate REST client needed. | ||
|
|
||
| This example uses the official Python SDK. | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| pip install iii-sdk | ||
| ``` | ||
|
|
||
| ## Quickstart | ||
|
|
||
| Start the agentmemory daemon (defaults to `ws://localhost:49134`, REST on | ||
| `:3111`): | ||
|
|
||
| ```bash | ||
| npx -y @agentmemory/agentmemory | ||
| ``` | ||
|
|
||
| Then from Python: | ||
|
|
||
| ```python | ||
| from iii import register_worker | ||
|
|
||
| iii = register_worker("ws://localhost:49134") | ||
| iii.connect() | ||
|
|
||
| iii.trigger({ | ||
| "function_id": "mem::remember", | ||
| "payload": { | ||
| "project": "demo", | ||
| "title": "auth-stack", | ||
| "content": "Service uses HMAC bearer tokens; refresh every 24h.", | ||
| "concepts": ["auth", "hmac", "refresh"], | ||
| }, | ||
| }) | ||
|
|
||
| hits = iii.trigger({ | ||
| "function_id": "mem::smart-search", | ||
| "payload": {"project": "demo", "query": "how do tokens refresh", "limit": 5}, | ||
| }) | ||
| print(hits) | ||
| ``` | ||
|
|
||
| ## Functions exposed | ||
|
|
||
| | Function id | Purpose | Required payload | | ||
| |---|---|---| | ||
| | `mem::remember` | Save a memory | `project`, `title`, `content` | | ||
| | `mem::observe` | Hook-driven observation ingest | `hookType`, `sessionId`, `project`, `cwd`, `timestamp` | | ||
| | `mem::context` | Render context for a session under a token budget | `sessionId`, `project`, optional `budget` | | ||
| | `mem::smart-search` | Hybrid BM25 + vector + concept recall | `project`, `query`, optional `limit` | | ||
| | `mem::forget` | Delete a memory by id | `id` | | ||
|
|
||
| The HTTP-trigger wrappers under `api::*` (callable via REST on `:3111`) exist | ||
| for the same operations if you need to reach the daemon from a host without an | ||
| iii runtime. Inside the iii ecosystem, calling the `mem::*` functions directly | ||
| is lower latency. | ||
|
|
||
| ## Files | ||
|
|
||
| - `quickstart.py` — minimal save-then-search loop. | ||
| - `observe_and_recall.py` — observation ingest + context rendering at a token | ||
| budget. | ||
|
|
||
| Both scripts assume the daemon is already running. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| """Observation ingest + context rendering at a token budget. | ||
|
|
||
| Pattern: send hook-style observations during a coding session, then ask | ||
| agentmemory to render the most relevant context back at a fixed token budget. | ||
|
|
||
| Prerequisites: | ||
| pip install iii-sdk | ||
| npx -y @agentmemory/agentmemory | ||
|
|
||
| Run: | ||
| python examples/python/observe_and_recall.py | ||
| """ | ||
|
|
||
| from datetime import datetime, timezone | ||
| from iii import register_worker | ||
|
|
||
|
|
||
| SESSION_ID = "py-example-session-001" | ||
| PROJECT = "demo" | ||
|
|
||
|
|
||
| def now_iso() -> str: | ||
| return datetime.now(timezone.utc).isoformat() | ||
|
|
||
|
|
||
| def main() -> None: | ||
| iii = register_worker("ws://localhost:49134") | ||
| iii.connect() | ||
|
|
||
| observations = [ | ||
| ("PreToolUse", {"tool": "Bash", "command": "cargo test"}), | ||
| ("PostToolUse", {"tool": "Bash", "exit_code": 0}), | ||
| ("UserPromptSubmit", {"prompt": "refactor auth middleware to use HMAC"}), | ||
| ] | ||
|
|
||
| for hook_type, data in observations: | ||
| iii.trigger( | ||
| { | ||
| "function_id": "mem::observe", | ||
| "payload": { | ||
| "hookType": hook_type, | ||
| "sessionId": SESSION_ID, | ||
| "project": PROJECT, | ||
| "cwd": "/home/user/service", | ||
| "timestamp": now_iso(), | ||
| "data": data, | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| context = iii.trigger( | ||
| { | ||
| "function_id": "mem::context", | ||
| "payload": { | ||
| "sessionId": SESSION_ID, | ||
| "project": PROJECT, | ||
| "budget": 2000, | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| print(f"Rendered context ({context.get('token_count', 0)} tokens):\n") | ||
| print(context.get("text", "")) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| """Minimal agentmemory usage via iii-sdk. | ||
|
|
||
| Prerequisites: | ||
| pip install iii-sdk | ||
| npx -y @agentmemory/agentmemory # daemon at ws://localhost:49134 | ||
|
|
||
| Run: | ||
| python examples/python/quickstart.py | ||
| """ | ||
|
|
||
| from iii import register_worker | ||
|
|
||
|
|
||
| def main() -> None: | ||
| iii = register_worker("ws://localhost:49134") | ||
| iii.connect() | ||
|
|
||
| iii.trigger( | ||
| { | ||
| "function_id": "mem::remember", | ||
| "payload": { | ||
| "project": "demo", | ||
| "title": "auth-stack", | ||
| "content": "Service uses HMAC bearer tokens; refresh every 24h.", | ||
| "concepts": ["auth", "hmac", "refresh"], | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| hits = iii.trigger( | ||
| { | ||
| "function_id": "mem::smart-search", | ||
| "payload": { | ||
| "project": "demo", | ||
| "query": "how do tokens refresh", | ||
| "limit": 5, | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| for memory in hits.get("results", []): | ||
| print(f"[{memory.get('score', 0):.3f}] {memory.get('title')}: {memory.get('content')}") | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use a unique session id per run to keep the example deterministic.
A fixed session id makes repeated runs bleed context across executions, which can confuse quick verification.
Suggested patch
🤖 Prompt for AI Agents