humanus.cpp/memory/base.h

450 lines
16 KiB
C++

#ifndef HUMANUS_MEMORY_BASE_H
#define HUMANUS_MEMORY_BASE_H
#include "schema.h"
#include "memory/base.h"
#include "vector_store/base.h"
#include "embedding_model/base.h"
#include "schema.h"
#include "prompt.h"
#include "httplib.h"
#include "llm.h"
#include "utils.h"
#include "tool/fact_extract.h"
#include <deque>
#include <vector>
namespace humanus {
struct BaseMemory {
std::deque<Message> messages;
std::string current_request;
// Add a message to the memory
virtual bool add_message(const Message& message) {
messages.push_back(message);
return true;
}
// Add multiple messages to the memory
virtual bool add_messages(const std::vector<Message>& messages) {
for (const auto& message : messages) {
if (!add_message(message)) {
return false;
}
}
return true;
}
// Clear all messages
virtual void clear() {
messages.clear();
}
virtual std::vector<Message> get_messages(const std::string& query = "") const {
std::vector<Message> result;
for (const auto& message : messages) {
result.push_back(message);
}
return result;
}
// Convert messages to list of dicts
json to_json_list() const {
json memory = json::array();
for (const auto& message : messages) {
memory.push_back(message.to_json());
}
return memory;
}
};
struct Memory : BaseMemory {
MemoryConfig config;
std::string fact_extraction_prompt;
std::string update_memory_prompt;
int max_messages;
int max_tokens_context;
int retrieval_limit;
FilterFunc filter;
std::shared_ptr<EmbeddingModel> embedding_model;
std::shared_ptr<VectorStore> vector_store;
std::shared_ptr<LLM> llm;
std::shared_ptr<FactExtract> fact_extract_tool;
bool retrieval_enabled;
int num_tokens_context;
Memory(const MemoryConfig& config) : config(config) {
fact_extraction_prompt = config.fact_extraction_prompt;
update_memory_prompt = config.update_memory_prompt;
max_messages = config.max_messages;
retrieval_limit = config.retrieval_limit;
filter = config.filter;
size_t pos = fact_extraction_prompt.find("{current_date}");
if (pos != std::string::npos) {
// %Y-%d-%m
auto current_date = std::chrono::system_clock::now();
auto in_time_t = std::chrono::system_clock::to_time_t(current_date);
std::stringstream ss;
std::tm tm_info = *std::localtime(&in_time_t);
ss << std::put_time(&tm_info, "%Y-%m-%d");
std::string formatted_date = ss.str(); // YYYY-MM-DD
fact_extraction_prompt.replace(pos, 14, formatted_date);
}
try {
embedding_model = EmbeddingModel::get_instance("default", config.embedding_model_config);
vector_store = VectorStore::get_instance("default", config.vector_store_config);
llm = LLM::get_instance("memory", config.llm_config);
logger->info("🔥 Memory is warming up...");
auto test_response = llm->ask(
{Message::user_message("Hello")}
);
auto test_embedding = embedding_model->embed(test_response, EmbeddingType::ADD);
vector_store->insert(test_embedding, 0);
vector_store->remove(0);
logger->info("📒 Memory is ready!");
retrieval_enabled = true;
} catch (const std::exception& e) {
logger->warn("Error in initializing memory: " + std::string(e.what()) + ", fallback to default FIFO memory");
embedding_model = nullptr;
vector_store = nullptr;
llm = nullptr;
retrieval_enabled = false;
}
fact_extract_tool = std::make_shared<FactExtract>();
}
bool add_message(const Message& message) override {
if (message.num_tokens > config.max_tokens_context) {
logger->warn("Message is too long, skipping"); // TODO: use content_provider to handle this
return false;
}
messages.push_back(message);
num_tokens_context += message.num_tokens;
std::vector<Message> messages_to_memory;
while (messages.size() > max_messages || num_tokens_context > config.max_tokens_context) {
messages_to_memory.push_back(messages.front());
num_tokens_context -= messages.front().num_tokens;
messages.pop_front();
}
if (!messages.empty()) { // Ensure the first message is always a user or system message
if (messages.front().role == "assistant") {
messages.push_front(Message::user_message("Current request: " + current_request + "\n\nDue to limited memory, some previous messages are not shown."));
num_tokens_context += messages.front().num_tokens;
} else if (messages.front().role == "tool") {
messages_to_memory.push_back(messages.front());
num_tokens_context -= messages.front().num_tokens;
messages.pop_front();
}
}
if (retrieval_enabled && !messages_to_memory.empty()) {
if (llm->enable_vision()) {
for (auto& m : messages_to_memory) {
m = parse_vision_message(m, llm, llm->vision_details());
}
} else {
for (auto& m : messages_to_memory) {
m = parse_vision_message(m);
}
}
_add_to_vector_store(messages_to_memory);
}
return true;
}
std::vector<Message> get_messages(const std::string& query = "") const override {
std::vector<Message> messages_with_memory;
if (retrieval_enabled && !query.empty()) {
auto embeddings = embedding_model->embed(
query.size() > 8192 ? query.substr(0, validate_utf8(query.substr(0, 8192))) : query, // TODO: split to chunks instead of truncating
EmbeddingType::SEARCH
);
std::vector<MemoryItem> memories;
// Check if vectore store is available
if (vector_store) {
memories = vector_store->search(embeddings, retrieval_limit, filter);
}
if (!memories.empty()) {
sort(memories.begin(), memories.end(), [](const MemoryItem& a, const MemoryItem& b) {
return a.updated_at < b.updated_at;
});
std::string memory_prompt;
for (const auto& memory_item : memories) {
memory_prompt += "<memory>" + memory_item.memory + "</memory>";
}
messages_with_memory.push_back(Message::user_message(memory_prompt));
logger->info("📤 Total retreived memories: " + std::to_string(memories.size()));
}
}
messages_with_memory.insert(messages_with_memory.end(), messages.begin(), messages.end());
return messages_with_memory;
}
void clear() override {
if (messages.empty()) {
return;
}
if (retrieval_enabled) {
std::vector<Message> messages_to_memory(messages.begin(), messages.end());
_add_to_vector_store(messages_to_memory);
}
messages.clear();
}
void _add_to_vector_store(const std::vector<Message>& messages) {
// Check if vector store is available
if (!vector_store) {
logger->warn("Vector store is not initialized, skipping memory operation");
return;
}
std::string parsed_message;
for (const auto& message : messages) {
parsed_message += message.role + ": " + (message.content.is_string() ? message.content.get<std::string>() : message.content.dump()) + "\n";
for (const auto& tool_call : message.tool_calls) {
parsed_message += "<tool_call>" + tool_call.to_json().dump() + "</tool_call>\n";
}
}
std::string system_prompt = fact_extraction_prompt;
size_t pos = system_prompt.find("{current_request}");
if (pos != std::string::npos) {
system_prompt = system_prompt.replace(pos, 17, current_request);
}
std::string user_prompt = "<input>" + parsed_message + "</input>";
Message user_message = Message::user_message(user_prompt);
json response = llm->ask_tool(
{user_message},
system_prompt,
"",
json::array({fact_extract_tool->to_param()}),
"required"
);
std::vector<std::string> new_facts; // ["fact1", "fact2", "fact3"]
try {
auto tool_calls = ToolCall::from_json_list(response["tool_calls"]);
for (const auto& tool_call : tool_calls) {
if (tool_call.function.name != "fact_extract") { // might be other tools because of hallucinations (e.g. wrongly responsed to user message)
continue;
}
// Parse arguments
json args = tool_call.function.arguments;
if (args.is_string()) {
args = json::parse(args.get<std::string>());
}
auto facts = fact_extract_tool->execute(args).output.get<std::vector<std::string>>();
if (!facts.empty()) {
new_facts.insert(new_facts.end(), facts.begin(), facts.end());
}
}
} catch (const std::exception& e) {
logger->warn("Error in new_facts: " + std::string(e.what()));
}
if (new_facts.empty()) {
return;
}
logger->info("📫 New facts to remember: " + json(new_facts).dump());
std::vector<json> old_memories;
std::map<std::string, std::vector<float>> new_message_embeddings;
for (const auto& fact : new_facts) {
auto message_embedding = embedding_model->embed(fact, EmbeddingType::ADD);
new_message_embeddings[fact] = message_embedding;
auto existing_memories = vector_store->search(
message_embedding,
5
);
for (const auto& memory : existing_memories) {
old_memories.push_back({
{"id", memory.id},
{"text", memory.memory}
});
}
}
// sort and unique by id
std::sort(old_memories.begin(), old_memories.end(), [](const json& a, const json& b) {
return a["id"] < b["id"];
});
old_memories.resize(std::unique(old_memories.begin(), old_memories.end(), [](const json& a, const json& b) {
return a["id"] == b["id"];
}) - old_memories.begin());
logger->info("📒 Existing memories about new facts: " + std::to_string(old_memories.size()));
// mapping UUIDs with integers for handling ID hallucinations
std::vector<size_t> temp_id_mapping;
for (size_t idx = 0; idx < old_memories.size(); ++idx) {
temp_id_mapping.push_back(old_memories[idx]["id"].get<size_t>());
old_memories[idx]["id"] = idx;
}
std::string function_calling_prompt = get_update_memory_messages(old_memories, new_facts, update_memory_prompt);
std::string new_memories_with_actions_str;
json new_memories_with_actions = json::array();
try {
new_memories_with_actions_str = llm->ask(
{Message::user_message(function_calling_prompt)}
);
new_memories_with_actions_str = remove_code_blocks(new_memories_with_actions_str);
} catch (const std::exception& e) {
logger->error("Error in parsing new_memories_with_actions: " + std::string(e.what()));
}
try {
new_memories_with_actions = json::parse(new_memories_with_actions_str);
} catch (const std::exception& e) {
logger->error("Invalid JSON response: " + std::string(e.what()));
}
try {
for (const auto& resp : new_memories_with_actions["memory"]) {
logger->debug("Processing memory: " + resp.dump(2));
try {
if (!resp.contains("text")) {
logger->warn("Skipping memory entry because of empty `text` field.");
continue;
}
std::string event = resp.value("event", "NONE");
size_t memory_id;
try {
if (event != "ADD") {
memory_id = temp_id_mapping.at(resp["id"].get<size_t>());
} else {
memory_id = get_uuid_64();
}
} catch (...) {
memory_id = get_uuid_64();
}
if (event == "ADD") {
_create_memory(
memory_id,
resp["text"], // data
new_message_embeddings // existing_embeddings
);
} else if (event == "UPDATE") {
_update_memory(
memory_id,
resp["text"], // data
new_message_embeddings // existing_embeddings
);
} else if (event == "DELETE") {
_delete_memory(memory_id);
}
} catch (const std::exception& e) {
logger->error("Error in new_memories_with_actions: " + std::string(e.what()));
}
}
} catch (const std::exception& e) {
logger->error("Error in new_memories_with_actions: " + std::string(e.what()));
}
}
void _create_memory(const size_t& memory_id, const std::string& data, const std::map<std::string, std::vector<float>>& existing_embeddings) {
if (!vector_store) {
logger->warn("Vector store is not initialized, skipping create memory");
return;
}
logger->info("🆕 Creating memory: " + data);
std::vector<float> embedding;
if (existing_embeddings.find(data) != existing_embeddings.end()) {
embedding = existing_embeddings.at(data);
} else {
embedding = embedding_model->embed(data, EmbeddingType::ADD);
}
MemoryItem metadata{
memory_id,
data,
httplib::detail::MD5(data)
};
vector_store->insert(
embedding,
memory_id,
metadata
);
}
void _update_memory(const size_t& memory_id, const std::string& data, const std::map<std::string, std::vector<float>>& existing_embeddings) {
if (!vector_store) {
logger->warn("Vector store is not initialized, skipping update memory");
return;
}
MemoryItem existing_memory;
try {
existing_memory = vector_store->get(memory_id);
} catch (const std::exception& e) {
logger->error("Error fetching existing memory: " + std::string(e.what()));
return;
}
logger->info("🆕 Updating memory: (old) " + existing_memory.memory + " (new) " + data);
std::vector<float> embedding;
if (existing_embeddings.find(data) != existing_embeddings.end()) {
embedding = existing_embeddings.at(data);
} else {
embedding = embedding_model->embed(data, EmbeddingType::ADD);
}
existing_memory.memory = data;
existing_memory.hash = httplib::detail::MD5(data);
existing_memory.updated_at = std::chrono::system_clock::now().time_since_epoch().count();
vector_store->update(
memory_id,
embedding,
existing_memory
);
}
void _delete_memory(const size_t& memory_id) {
if (!vector_store) {
logger->warn("Vector store is not initialized, skipping delete memory");
return;
}
logger->info("❌ Deleting memory: " + std::to_string(memory_id));
vector_store->remove(memory_id);
}
};
}
#endif // HUMANUS_MEMORY_BASE_H