kernelmemory/service repository overview

Kernel Memory (KM) is a multi-modal AI Service specialized in the efficient indexing of datasets through custom continuous data hybrid pipelines, with support for Retrieval Augmented Generation (RAG), synthetic memory, prompt engineering, and custom semantic memory processing.

• Documentation: https://microsoft.github.io/kernel-memory⁠
• Source: https://github.com/microsoft/kernel-memory⁠
• Dockerfile: https://github.com/microsoft/kernel-memory/blob/main/tools/docker/Dockerfile⁠

⁠Quick test

docker run -e OPENAI_API_KEY="..." -p 9001:9001 -it --rm kernelmemory/service

⁠Full setup

⁠Create "appsettings.Development.json" file using the config wizard

git clone https://github.com/microsoft/kernel-memory.git
cd kernel-memory/service/Service
dotnet run setup

The wizard will ask some basic questions and parameters.

For the full set of settings check https://github.com/microsoft/kernel-memory/blob/main/service/Service/appsettings.json⁠ and edit appsettings.Development.json manually.

⁠Start service using the config file just created:

On macOS/Linux:

docker run --volume ./appsettings.Development.json:/app/appsettings.Production.json \
         -it --rm -p 9001:9001 kernelmemory/service

On Windows:

docker run --volume .\appsettings.Development.json:/app/appsettings.Production.json ^
         -it --rm -p 9001:9001 kernelmemory/service

Notes:

• appsettings.Development.json must be a valid JSON file
• the appsettings.Development.json file must be mounted as appsettings.Production.json.
• Windows requires using backslash in the volume source path, otherwise the file might be mounted as a directory and the service won't start