Skip to main content

Memor: A Python Library for Managing and Transferring Conversational Memory Across LLMs

Project description

Memor: A Python Library for Managing and Transferring Conversational Memory Across LLMs


PyPI version built with Python3 GitHub repo size Discord Channel

Overview

Memor is a library designed to help users manage the memory of their interactions with Large Language Models (LLMs). It enables users to seamlessly access and utilize the history of their conversations when prompting LLMs. That would create a more personalized and context-aware experience. Memor stands out by allowing users to transfer conversational history across different LLMs, eliminating cold starts where models don't have information about user and their preferences. Users can select specific parts of past interactions with one LLM and share them with another. By bridging the gap between isolated LLM instances, Memor revolutionizes the way users interact with AI by making transitions between models smoother.

PyPI Counter
Github Stars
Branch main dev
CI
Code Quality CodeFactor

Installation

PyPI

Source code

Usage

Define your prompt and the response(s) to that; Memor will wrap it into a object with a templated representation. You can create a session by combining multiple prompts and responses, gradually building it up:

>>> from memor import Session, Prompt, Response, Role
>>> from memor import PresetPromptTemplate, RenderFormat
>>> response = Response(message="I am fine.", role=Role.ASSISTANT, temperature=0.9, score=0.9)
>>> prompt = Prompt(message="Hello, how are you?",
                    responses=[response],
                    role=Role.USER,
                    template=PresetPromptTemplate.INSTRUCTION1.PROMPT_RESPONSE_STANDARD)
>>> system_prompt = Prompt(message="You are a friendly and informative AI assistant designed to answer questions on a wide range of topics.",
                    role=Role.SYSTEM)
>>> session = Session(messages=[system_prompt, prompt])
>>> session.render(RenderFormat.OPENAI)

The rendered output will be a list of messages formatted for compatibility with the OpenAI API.

[{"content": "You are a friendly and informative AI assistant designed to answer questions on a wide range of topics.", "role": "system"},
 {"content": "I'm providing you with a history of a previous conversation. Please consider this context when responding to my new question.\n"
             "Prompt: Hello, how are you?\n"
             "Response: I am fine.",
  "role": "user"}]

Prompt Templates

Preset Templates

Memor provides a variety of pre-defined prompt templates to control how prompts and responses are rendered. Each template is prefixed by an optional instruction string and includes variations for different formatting styles. Following are different variants of parameters:

Instruction Name Description
INSTRUCTION1 "I'm providing you with a history of a previous conversation. Please consider this context when responding to my new question."
INSTRUCTION2 "Here is the context from a prior conversation. Please learn from this information and use it to provide a thoughtful and context-aware response to my next questions."
INSTRUCTION3 "I am sharing a record of a previous discussion. Use this information to provide a consistent and relevant answer to my next query."
Template Title Description
PROMPT Only includes the prompt message.
RESPONSE Only includes the response message.
RESPONSE0 to RESPONSE3 Include specific responses from a list of multiple responses.
PROMPT_WITH_LABEL Prompt with a "Prompt: " prefix.
RESPONSE_WITH_LABEL Response with a "Response: " prefix.
RESPONSE0_WITH_LABEL to RESPONSE3_WITH_LABEL Labeled response for the i-th response.
PROMPT_RESPONSE_STANDARD Includes both labeled prompt and response on a single line.
PROMPT_RESPONSE_FULL A detailed multi-line representation including role, date, model, etc.

You can access them like this:

>>> from memor import PresetPromptTemplate
>>> template = PresetPromptTemplate.INSTRUCTION1.PROMPT_RESPONSE_STANDARD

Custom Templates

You can define custom templates for your prompts using the PromptTemplate class. This class provides two key parameters that control its functionality:

  • content: A string that defines the template structure, following Python string formatting conventions. You can include dynamic fields using placeholders like {field_name}, which will be automatically populated using attributes from the prompt object. Some common examples of auto-filled fields are shown below:
Prompt Object Attribute Placeholder Syntax Description
prompt.message {prompt[message]} The main prompt message
prompt.selected_response {prompt[response]} The selected response for the prompt
prompt.date_modified {prompt[date_modified]} Timestamp of the last modification
prompt.responses[2].message {responses[2][message]} Message from the response at index 2
prompt.responses[0].inference_time {responses[0][inference_time]} Inference time for the response at index 0
  • custom_map: In addition to the attributes listed above, you can define and insert custom placeholders (e.g., {field_name}) and provide their values through a dictionary. When rendering the template, each placeholder will be replaced with its corresponding value from custom_map.

Suppose you want to prepend an instruction to every prompt message. You can define and use a template as follows:

>>> template = PromptTemplate(content="{instruction}, {prompt[message]}", custom_map={"instruction": "Hi"})
>>> prompt = Prompt(message="How are you?", template=template)
>>> prompt.render()
Hi, How are you?

By using this dynamic structure, you can create flexible and sophisticated prompt templates with Memor. You can design specific schemas for your conversational or instructional formats when interacting with LLM.

Issues & bug reports

Just fill an issue and describe it. We'll check it ASAP! or send an email to memor@openscilab.com.

  • Please complete the issue template

You can also join our discord server

Discord Channel

Show your support

Star this repo

Give a ⭐️ if this project helped you!

Donate to our project

If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .

Memor Donation

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

0.5 - 2025-04-16

Added

  • Session class check_render method
  • Session class clear_messages method
  • Prompt class check_render method
  • Session class estimate_tokens method
  • Prompt class estimate_tokens method
  • Response class estimate_tokens method
  • universal_tokens_estimator function
  • openai_tokens_estimator_gpt_3_5 function
  • openai_tokens_estimator_gpt_4 function

Changed

  • init_check parameter added to Prompt class
  • init_check parameter added to Session class
  • Test system modified
  • Python 3.6 support dropped
  • README.md updated

0.4 - 2025-03-17

Added

  • Session class __contains__ method
  • Session class __getitem__ method
  • Session class mask_message method
  • Session class unmask_message method
  • Session class masks attribute
  • Response class __len__ method
  • Prompt class __len__ method

Changed

  • inference_time parameter added to Response class
  • README.md updated
  • Test system modified
  • Python typing features added to all modules
  • Prompt class default values updated
  • Response class default values updated

0.3 - 2025-03-08

Added

  • Session class __len__ method
  • Session class __iter__ method
  • Session class __add__ and __radd__ methods

Changed

  • tokens parameter added to Prompt class
  • tokens parameter added to Response class
  • tokens parameter added to preset templates
  • Prompt class modified
  • Response class modified
  • PromptTemplate class modified

0.2 - 2025-03-01

Added

  • Session class

Changed

  • Prompt class modified
  • Response class modified
  • PromptTemplate class modified
  • README.md updated
  • Test system modified

0.1 - 2025-02-12

Added

  • Prompt class
  • Response class
  • PromptTemplate class
  • PresetPromptTemplate class

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

memor-0.5.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

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

memor-0.5-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file memor-0.5.tar.gz.

File metadata

  • Download URL: memor-0.5.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for memor-0.5.tar.gz
Algorithm Hash digest
SHA256 2723eedf57034bb867dde0b1718c11a77a5ab36753080f2a4714915a13ee22de
MD5 ff647876738140a140dac3499a0d590b
BLAKE2b-256 d87baa43bb303a5074bdc4e1ab265fdaf7905799f6be9bc13313dfc96c36c27d

See more details on using hashes here.

File details

Details for the file memor-0.5-py3-none-any.whl.

File metadata

  • Download URL: memor-0.5-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for memor-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7c505f17a5a163abca88a75e32e1ef5f6d6fe090d2ca3f228187eaebc6575c63
MD5 bfa802445ed7696265b9b83aa628d520
BLAKE2b-256 03449ba07148dfd52f7ba203334d84d2752d48857df359ecbd8bfe45054afbb0

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