Skip to main content

A minimal LLM agent with memory management.

Project description

Overview

Features:

  • simple and unified
  • memory management
  • a terminal simulation that allows for web-style interaction

Supported platforms/LLMs:

  • OpenAI
  • Grok (xAI)
  • DeepSeek
  • Gemini (Google)
  • Qwen (Alibaba)

Examples

See the demo folder.

1: String Input

from src.min_llm_agent import min_llm_agent_class

if __name__ == "__main__":

    llm_agent = min_llm_agent_class(platform_name="OpenAI", model_name="gpt-4o-mini")

    question = "What is the capital of France?"
    response = llm_agent(question)

    print(f"Question: {question}")
    print(f"Answer by model {llm_agent.model_name}: {response}")
    
    # llm_agent.print_memory(memory_item_separator="/")
    llm_agent.print_memory()

2: Dict Input

from src.min_llm_agent import min_llm_agent_class

if __name__ == "__main__":

    llm_agent = min_llm_agent_class(platform_name="OpenAI", model_name="gpt-4o-mini")

    messages = [
        {
            "role": "system",
            "content": "You are a helpful assistant.",
        },
        {
            "role": "user",
            "content": "What is the capital of France?",
        }
    ]
    response = llm_agent(messages)

    print(f"Messages: {messages}")
    print(f"Answer by model {llm_agent.model_name}: {response}")
    
    # llm_agent.print_memory(memory_item_separator="/")
    llm_agent.print_memory()

3: Interact

from src.min_llm_agent import min_llm_agent_class

if __name__ == "__main__":

    llm_agent = min_llm_agent_class(platform_name="OpenAI", model_name="gpt-4o-mini")
    llm_agent.interact()
==========================

This is Yue's minimal LLM agent, powered by the model "gpt-4o-mini".

- To submit a query: start a new line, type '/', and press Enter.
    - Line breaks are allowed and recognized as a part of the query.
- Query 'q' or 'Q' to exit.
- Query 'm' or 'M' to print the memory.

See more details on: https://github.com/YueLin301/min_llm_agent

>>>>>>>>>>>>>>>>>>>>>>>>>>
[0] Question:
> 1+1=
/

<<<<<<<<<<<<<<<<<<<<<<<<<<
[0] Answer by the model gpt-4o-mini:
1 + 1 = 2.


>>>>>>>>>>>>>>>>>>>>>>>>>>
[1] Question:
> how are you
/

<<<<<<<<<<<<<<<<<<<<<<<<<<
[1] Answer by the model gpt-4o-mini:
I'm just a computer program, so I don't have feelings, but I'm here and ready to help you! How can I assist you today?


>>>>>>>>>>>>>>>>>>>>>>>>>>
[2] Question:
> m
/
==========================
Memory:
--------------------------
[0] (user): 1+1=
[1] (assistant): 1 + 1 = 2.
[2] (user): how are you
[3] (assistant): I'm just a computer program, so I don't have feelings, but I'm here and ready to help you! How can I assist you today?
==========================
>>>>>>>>>>>>>>>>>>>>>>>>>>
[2] Question:
> q
/

How to Use

Installation

pip install 

API Key

For security reasons, this project does not maintain any API key files. You need to configure the API key yourself in the environment variables. Check the following guidelines to see how it is done:

Resources:

An Example Set Sp for MacOS Users:

  1. Append the following API configurations to the end of the ~/.zshrc file.
export OPENAI_API_KEY="sk-xxx"
export OPENAI_BASE_URL="https://api.openai.com/v1"

export XAI_API_KEY="xai-xxx"
export XAI_BASE_URL="https://api.x.ai/v1"

export DEEPSEEK_API_KEY="sk-xxx"
export DEEPSEEK_BASE_URL="https://api.deepseek.com"

export GEMINI_API_KEY=""
export GEMINI_BASE_URL="https://generativelanguage.googleapis.com/v1beta/openai/"

export DASHSCOPE_API_KEY="sk-xxx"
export DASHSCOPE_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
  1. Run source ~/.zshrc to update.

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

minimalllmagent-0.1.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

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

MinimalLLMAgent-0.1.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minimalllmagent-0.1.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for minimalllmagent-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e184d6ffa6b750a5303ab992dd254d0f82100a6c8f50b61f89497d5ad80d0d4d
MD5 ca0ca5a74474ff4f16b3c90fbc91ead8
BLAKE2b-256 9e5f0342ede167cdc903166a5c79bf1ab72b1c932e344982440615dfc83e3c01

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for MinimalLLMAgent-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 641307c174875d8168434a62a699c9105166a496fcb5d183a42093e6faa3ecb6
MD5 cff758378c8e9428c700dc210c19da11
BLAKE2b-256 eb4e4cd7f8ae62037a209e9370a389be583bcca0514697aac520b41826097e33

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