Python SDK

The Python SDK is the smritea-sdk package. It gives you a synchronous SmriteaClient with four calls: add, search, get and delete. It needs Python 3.9 or later.

InstallCopy Anchor Link

pip install smritea-sdk

Import the client and the scope type from smritea:

from smritea import MemoryScope, SmriteaClient

Create a clientCopy Anchor Link

SmriteaClient takes your API key and your app ID. You must pass both. Create them in the dashboard; see Create an app and API key.

The client has no timeout argument. Set a timeout on the http_client you pass in.

MethodsCopy Anchor Link

The table lists the client methods and what each one returns.

The get_all method exists but raises NotImplementedError. Use search to find memories.

Add optionsCopy Anchor Link

The table lists the options that add accepts.

Build a RelativeStanding with importance, decay_factor and decay_function. Import it from smritea.types, because the top-level package does not export it. importance ranges from 0 to 1. decay_factor is 0 or higher. decay_function takes exponential, gaussian or linear. Decay affects quick_search, context_aware_search and deep_search with temporal or rrf_temporal; importance affects deep_search with rrf or rrf_temporal.

Search optionsCopy Anchor Link

The table lists the options that search accepts.

You cannot combine valid_at with from_time or to_time.

Memory scopeCopy Anchor Link

MemoryScope decides who a memory belongs to. Every field is optional. See Memory scope for the rules.

ResultsCopy Anchor Link

search returns a list of SearchResult. Each one has a score and a memory.

add returns a MemoryCreationResult.

get returns a Memory. It has id, app_id, content, created_at, updated_at, active_from, active_to, metadata and scope.

ExceptionsCopy Anchor Link

Every error derives from SmriteaError. The SDK picks the class from the HTTP status.

Each exception has http_status, code, retryable, body and request_id. SmriteaTooManyRequestsError also has retry_after, in seconds.

The SDK retries a 429 up to max_retries times. It never retries a 402. For every code, see Errors and codes.

ExampleCopy Anchor Link

This script stores a memory, searches for it and handles the failures.

import os

from smritea import (
    MemoryScope,
    SmriteaClient,
    SmriteaError,
    SmriteaPaymentRequiredError,
    SmriteaTooManyRequestsError,
)

client = SmriteaClient(
    api_key=os.environ["SMRITEA_API_KEY"],
    app_id=os.environ["SMRITEA_APP_ID"],
)
alice = MemoryScope(actor_id="alice", actor_type="user")

try:
    client.add("Alice is vegetarian and loves hiking", scope=alice)
    results = client.search("What does Alice eat?", scope=alice)
    for r in results:
        if r.memory:
            print(f"{r.score:.2f}  {r.memory.content}")
except SmriteaPaymentRequiredError:
    print("Plan quota used up (402)")
except SmriteaTooManyRequestsError as e:
    print(f"Rate limited. Retry in {e.retry_after}s")
except SmriteaError as e:
    print(e.http_status, e.code, e.request_id)

Don't see your language? Request it on GitHub. Search existing requests first and add a 👍 if yours is there. That helps the Smritea team rank requests.