Skip to main content

Package for managing agent memory in AI applications

Project description

AgentMemory Package

CI release

Description

AgentMemory is a Python package for managing agent memory structures in AI applications. It provides a flexible data model for long-term and short-term memory and supports storing and managing:

  • Persona: Information and properties of an agent.
  • Conversation: Conversations between agents and users.
  • ConversationItems: Individual messages or actions within a conversation.
  • Workflows: Workflows executed by agents.
  • WorkflowSteps: Individual steps within a workflow.

Additionally, a cache system is provided for fast access and temporary storage.

Installation

Install the package using pip or uv:

pip install agentmemory-py
# or
uv add agentmemory-py

Quickstart

Create a Memory Object

from agentmemory import AgentMemory
from agentmemory.connection import AgentMemoryConnection
from agentmemory.connection.longterm import MongoDBConnection
from agentmemory.connection.shortterm import RedisConnection

con = AgentMemoryConnection(
    longterm_con=MongoDBConnection(
        mongo_uri="mongodb://localhost:27017",
        database="support-agentmemory"
    ),
    shortterm_con=RedisConnection(
        host="localhost"
    )
)

memory = AgentMemory("support-agentmemory", con=con)

Manage Conversations

Create a New Conversation

from agentmemory.schema.conversations import Conversation

conversation = Conversation(
    title="New Conversation",
)

created_conversation = memory.conversations.create(conversation)
print(created_conversation)

List Conversations

# Get all conversations
conversations = memory.conversations.list()

# Get only 5 conversations
conversations = memory.conversations.list(limit=5)

# Filter by title
conversations = memory.conversations.list(query={"title": "title1"})

Retrieve and Update a Conversation

id = "<ID>"
conversation = memory.conversations.get(id)
conversation.title = "Updated Title"
memory.conversations.update(conversation)

Delete a Conversation

id = "<ID>"
memory.conversations.delete(id)

Manage ConversationItems

from agentmemory.schema.conversations import ConversationItem

item = ConversationItem(
    conversation_id="<CONVERSATION_ID>",
    role="system",
    content="Hello, how can I help?",
    data={
        "custom": "data"
    }
)

created_item = memory.conversation_items.create(item)
print(created_item)

# Get items of a conversation
items = memory.conversation_items.list_by_conversation_id("<CONVERSATION_ID>")

Manage Personas

from agentmemory.schema.personas import Persona

persona = Persona(
    name="<NAME>",
    role="<ROLE>",
    goals="<GOALS>",
    background="<BACKGROUND>",
    data={
        "custom": "data"
    }
)

created_persona = memory.personas.create(persona)
print(created_persona)

# Retrieve persona by name
persona = memory.personas.get_by_name("<NAME>")

Manage Workflows and WorkflowSteps

from agentmemory.schema.workflows import Workflow, WorkflowStep, WorkflowStatus

workflow = Workflow(
    conversation_item_id="<CONVERSATION_ITEM_ID>",
    user_query="<USER_QUERY>",
    status=WorkflowStatus.RUNNING,
    data={
        "custom": "data"
    }
)

created_workflow = memory.workflows.create(workflow)
print(created_workflow)

step = WorkflowStep(
    workflow_id=created_workflow.workflow_id,
    name="<NAME>",
    tool="<TOOL_NAME>",
    arguments={
        "arg1": "value1"
    },
    status=WorkflowStatus.SUCCESS,
    result="<RESULT>",
    logs=[],
    data={
        "custom": "data"
    }
)

created_step = memory.workflow_steps.create(step)
print(created_step)

Custom Caching

The integrated cache system enables fast access to frequently used data.

memory.cache.keys("*")                       # List all keys
memory.cache.get("<KEY>")                    # Get value
memory.cache.set("<KEY>", {"key": "value"})  # Set value
memory.cache.clear("<PATTERN>")              # Clear cache by pattern

Tests

To run the tests:

uv run pytest

License

MIT License. See LICENSE for details.

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

agentmemory_py-0.1.0.tar.gz (45.7 kB view details)

Uploaded Source

Built Distribution

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

agentmemory_py-0.1.0-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

Details for the file agentmemory_py-0.1.0.tar.gz.

File metadata

  • Download URL: agentmemory_py-0.1.0.tar.gz
  • Upload date:
  • Size: 45.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for agentmemory_py-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bd97c610fdbafc50685c5cc1f74f78d45320a7e0d751de4ab2a5b9ba06db86ee
MD5 8e189e73cd3cebce86d42daa8718b5a8
BLAKE2b-256 389e743bdd9b1bfd866a45e3b2b1746c94811809494fdf4936a5f10093e05f77

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentmemory_py-0.1.0.tar.gz:

Publisher: release.yml on enricogoerlitz/agentmemory-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agentmemory_py-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: agentmemory_py-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for agentmemory_py-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f196bd47ea3ed538a810a538f50181538727d81f04d7991e2ea2ed1a6506315
MD5 acb1e76477b1f71f46970cb7870d17b5
BLAKE2b-256 aa9735c3ebe490a2205c6f9f335876e7836b367994a58bc0df4be7cf1d33aa39

See more details on using hashes here.

Provenance

The following attestation bundles were made for agentmemory_py-0.1.0-py3-none-any.whl:

Publisher: release.yml on enricogoerlitz/agentmemory-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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