From 31a4bfeeb2996b96b2b3b769c4c345c3e8576374 Mon Sep 17 00:00:00 2001
From: Daniel Chalef <131175+danielchalef@users.noreply.github.com>
Date: Tue, 15 Apr 2025 14:54:02 -0700
Subject: [PATCH] docs: add note on LLM service compatibility in README.md
 (#359)

Enhance README with important note on LLM service compatibility. Clarified that Graphiti works best with LLMs supporting Structured Output, highlighting potential issues with smaller models.
---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 19e93ecc..94d00471 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,11 @@ Requirements:
 - Neo4j 5.26 or higher (serves as the embeddings storage backend)
 - OpenAI API key (for LLM inference and embedding)
 
+> [!IMPORTANT]
+> Graphiti works best with LLM services that support Structured Output (such as OpenAI and Gemini).
+> Using other services may result in incorrect output schemas and ingestion failures. This is particularly
+> problematic when using smaller models.
+
 Optional:
 
 - Google Gemini, Anthropic, or Groq API key (for alternative LLM providers)