Skip to main content

Python SDK for Neocortex API by TinyHumans - ingest and delete memory with human context

Project description

TinyHuman Neocortex SDK

A persistent memory layer for AI applications. Neocortex lets your AI agents store, retrieve, and use context across conversations -- so they remember what matters.

Built on the TinyHumans API.

Install

pip install tinyhumansai

Requires Python 3.9+. The only runtime dependency is httpx.

Running locally

From the package directory (packages/sdk-python), install the project and optional dependency groups with uv:

uv sync --group dev --group examples
  • --group dev — test and lint tools (pytest, pytest-asyncio, mypy, ruff).
  • --group examplespython-dotenv for running the example script.

Then run the example:

# Copy .env.example to .env and set TINYHUMANS_TOKEN, TINYHUMANS_MODEL_ID, OPENAI_API_KEY (for recall_with_llm).
uv run python example.py

To install only the package and examples (no dev tools): uv sync --group examples.

Quick start

import tinyhumansai as api

client = api.TinyHumanMemoryClient("YOUR_APIKEY_HERE")

# Store a single memory
client.ingest_memory({
    "key": "user-preference-theme",
    "content": "User prefers dark mode",
    "namespace": "preferences",
    "metadata": {"source": "onboarding"},
})

# Ask a LLM something from the memory
response = client.recall_with_llm(
    prompt="What is the user's preference for theme?",
    api_key="OPENAI_API_KEY"
)
print(response.text) # The user prefers dark mode

Core concepts

Memory items are the basic unit of storage. Each item has:

Field Required Description
key yes Unique identifier within a namespace (used for upsert/dedup)
content yes The memory text
namespace yes Scope for organizing items
metadata no Arbitrary dict for tagging/filtering
created_at no Unix timestamp in seconds
updated_at no Unix timestamp in seconds

Namespaces let you organize memories by category (e.g. "preferences", "conversation-history", "user-facts").

Context is a pre-formatted string built from your stored memories, ready to inject into any LLM prompt as system context.

API reference

TinyHumanMemoryClient

client = api.TinyHumanMemoryClient(
    token="your-api-key",       # Required. TinyHumans API key.
    model_id="neocortex-mk1",   # Required. Model identifier.
    base_url="https://...",     # Optional. Override API base URL.
)

The client supports the context-manager protocol for automatic cleanup:

with api.TinyHumanMemoryClient(token="...", model_id="...") as client:
    ctx = client.recall_memory(namespace="preferences", prompt="User preferences", num_chunks=10)

ingest_memory

Upsert a single memory item. The item is deduped by (namespace, key) -- if a match exists, it is updated; otherwise a new item is created.

result = client.ingest_memory(
    item={
        "key": "fav-color",
        "content": "User's favorite color is blue",
        "namespace": "preferences",
    }
)
print(result.ingested, result.updated, result.errors)

With the MemoryItem dataclass:

from tinyhumansai import MemoryItem

result = client.ingest_memory(
    item=MemoryItem(key="fav-color", content="Blue", namespace="preferences")
)

ingest_memories

Upsert multiple memory items in one call. Items are deduped by (namespace, key).

result = client.ingest_memories(
    items=[
        {"key": "fav-color", "content": "Blue", "namespace": "preferences"},
        {"key": "fav-food", "content": "Pizza", "namespace": "preferences"},
    ]
)
print(result.ingested, result.updated, result.errors)

recall_memory

Fetch relevant memory chunks using a prompt and return them as an LLM-friendly context string. The API uses the prompt to retrieve the most relevant chunks from the namespace.

# Fetch up to 10 chunks relevant to the prompt
ctx = client.recall_memory(
    namespace="preferences",
    prompt="What is the user's favorite color?",
    num_chunks=10,
)
print(ctx.context)  # Formatted string
print(ctx.items)    # List of ReadMemoryItem objects
print(ctx.count)    # Number of items

# Optional: fetch more or fewer chunks
ctx = client.recall_memory(namespace="preferences", prompt="User preferences", num_chunks=5)

# Optional: filter by specific key(s) instead of prompt-based retrieval
ctx = client.recall_memory(namespace="preferences", prompt="", key="fav-color", num_chunks=10)

delete_memory

Remove memory items by key or delete all in a namespace. namespace is required.

# Delete a specific key
client.delete_memory(namespace="preferences", key="fav-color")

# Delete multiple keys
client.delete_memory(namespace="preferences", keys=["fav-color", "fav-food"])

# Delete all memories in a namespace
client.delete_memory(namespace="preferences", delete_all=True)

recall_with_llm (optional)

Query an LLM provider with your stored context injected -- no extra SDK dependencies needed. Supports OpenAI, Anthropic, and Google Gemini out of the box, plus any OpenAI-compatible endpoint.

ctx = client.recall_memory(namespace="preferences", prompt="User preferences", num_chunks=10)

# OpenAI
response = client.recall_with_llm(
    prompt="What is the user's favorite color?",
    provider="openai",
    model="gpt-4o-mini",
    api_key="your-openai-key",
    context=ctx.context,
)
print(response.text)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tinyhumansai-0.5.3.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tinyhumansai-0.5.3-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file tinyhumansai-0.5.3.tar.gz.

File metadata

  • Download URL: tinyhumansai-0.5.3.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tinyhumansai-0.5.3.tar.gz
Algorithm Hash digest
SHA256 4d4d677a009db243447b1d6869e4e2deb005aead1402761362e226cf728f0bcd
MD5 50942c48fe12dc74dcdd2f3998e1c14b
BLAKE2b-256 6aa16012fcabaf24ab13fdab409bee76ab3f19561ef01d560941448cad975b7a

See more details on using hashes here.

File details

Details for the file tinyhumansai-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: tinyhumansai-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for tinyhumansai-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 815a56d9b335084a22fc857b1d49d8c18fd398d1c15a9a6fdc0e93c2e0129985
MD5 5cc4aa68bafe6c8a63c07669110cde44
BLAKE2b-256 7f57910bdd006a407c5bfbd965754cd8c77eaeca07f0550733df3b6fb1380cb5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page