pip install neo4j-graphrag

要求：Python ≥ 3.10，Neo4j ≥ 5.18.1 或 Aura ≥ 5.18.0。

---

是否有全文索引？是 → 混合变体（召回率更高）
                   否 → 向量变体（基线版本）

向量查找后是否需要图谱上下文？是 → Cypher变体
                                         否 → 普通变体

需要自然语言转Cypher？ → Text2CypherRetriever（无需嵌入器）
需要多工具LLM路由？ → ToolsRetriever
使用外部向量数据库？ → WeaviateNeo4jRetriever / PineconeNeo4jRetriever / QdrantNeo4jRetriever

// 向量索引（所有检索器都需要）
CREATE VECTOR INDEX chunk_embedding IF NOT EXISTS
FOR (c:Chunk) ON (c.embedding)
OPTIONS { indexConfig: {
  `vector.dimensions`: 1536,
  `vector.similarity_function`: 'cosine'
} };

// 全文索引（仅混合检索器需要）
CREATE FULLTEXT INDEX chunk_fulltext IF NOT EXISTS
FOR (c:Chunk) ON EACH [c.text];

// 确认索引处于ONLINE状态后再进行数据导入：
SHOW INDEXES YIELD name, state
WHERE name IN ['chunk_embedding', 'chunk_fulltext']
RETURN name, state;
// 两个索引的状态都必须显示为'ONLINE'

from neo4j import GraphDatabase
from neo4j_graphrag.retrievers import HybridCypherRetriever
from neo4j_graphrag.embeddings import OpenAIEmbeddings
from neo4j_graphrag.generation import GraphRAG
from neo4j_graphrag.llm import OpenAILLM

driver = GraphDatabase.driver("neo4j+s://<host>:7687", auth=("neo4j", "<password>"))
embedder = OpenAIEmbeddings(model="text-embedding-3-small")  # 1536维度——需与索引匹配

// retrieval_query：向量查找后执行的Cypher片段。
// `node` = 向量索引匹配到的节点 （自动注入——请勿声明）
// `score` = 相似度浮点值 （自动注入——请勿声明）
// 必须包含RETURN子句，且必须返回`score`列。
retrieval_query = """
MATCH (node)<-[:HAS_CHUNK]-(article:Article)
OPTIONAL MATCH (article)-[:MENTIONS]->(org:Organization)
RETURN node.text AS chunk_text,
       article.title AS article_title,
       collect(DISTINCT org.name) AS mentioned_organizations,
       score
"""

retriever = HybridCypherRetriever(
    driver=driver,
    vector_index_name="chunk_embedding",
    fulltext_index_name="chunk_fulltext",
    retrieval_query=retrieval_query,
    embedder=embedder,
)

llm = OpenAILLM(model_name="gpt-4o", model_params={"temperature": 0})
rag = GraphRAG(retriever=retriever, llm=llm)

response = rag.search(query_text="Who does Alice work for?", retriever_config={"top_k": 5})
print(response.answer)

retrieval_query = """
MATCH (node)<-[:HAS_CHUNK]-(article:Article)-[:MENTIONS]->(org:Organization)
WHERE org.name = $entity_name
RETURN node.text AS chunk_text, article.title AS title, score
"""

retriever = VectorCypherRetriever(
    driver=driver,
    index_name="chunk_embedding",
    retrieval_query=retrieval_query,
    embedder=embedder,
)

// 在每次搜索时通过retriever_config传递query_params：
response = rag.search(
    query_text="What happened at Apple?",
    retriever_config={"top_k": 10, "query_params": {"entity_name": "Apple"}},
)

// 直接调用检索器（无需GraphRAG包装器）：
results = retriever.search(
    query_text="What happened at Apple?",
    top_k=10,
    query_params={"entity_name": "Apple"},
)

// 过滤器会在向量相似度排序前缩小候选池范围
results = retriever.search(
    query_text="quarterly results",
    top_k=5,
    filters={"date": {"$gte": "2024-01-01"}},
)
// 支持的操作符：$eq $ne $lt $lte $gt $gte $between $in $like $ilike

from neo4j_graphrag.retrievers import VectorRetriever

retriever = VectorRetriever(
    driver=driver,
    index_name="chunk_embedding",
    embedder=embedder,
    return_properties=["text", "source", "page_number"],  // 节点属性的子集
)
// 无需retrieval_query——直接返回节点属性

from neo4j_graphrag.retrievers import Text2CypherRetriever

// LLM从自然语言生成Cypher；无需向量索引
retriever = Text2CypherRetriever(
    driver=driver,
    llm=OpenAILLM(model_name="gpt-4o"),
    neo4j_schema=None,   // 从数据库自动获取；或传入字符串
    examples=["Q: Who works at Neo4j? A: MATCH (p:Person)-[:WORKS_AT]->(c:Company {name:'Neo4j'}) RETURN p.name"],
)
results = retriever.search(query_text="Which people work at Neo4j?")

from neo4j_graphrag.generation.prompts import RagTemplate

custom_template = RagTemplate(
    template="""仅使用以下上下文回答问题。
Context: {context}
Question: {query_text}
Answer:""",
    expected_inputs=["context", "query_text"],
)

rag = GraphRAG(retriever=retriever, llm=llm, prompt_template=custom_template)

from neo4j_graphrag.embeddings import (
    OpenAIEmbeddings,           // OpenAI text-embedding-3-*系列
    AzureOpenAIEmbeddings,      // Azure托管的OpenAI
    VertexAIEmbeddings,         // Google Vertex AI
    MistralAIEmbeddings,        // Mistral
    CohereEmbeddings,           // Cohere embed-v3
    OllamaEmbeddings,           // 通过Ollama本地部署
    SentenceTransformerEmbeddings,  // 本地HuggingFace模型
)

// 维度映射（必须与向量索引匹配）：
// text-embedding-3-small → 1536
// text-embedding-3-large → 3072
// text-embedding-ada-002 → 1536
// all-MiniLM-L6-v2       → 384

from neo4j_graphrag.llm import (
    OpenAILLM,
    AzureOpenAILLM,
    AnthropicLLM,
    VertexAILLM,
    MistralAILLM,
    CohereLLM,
    OllamaLLM,
)
// GraphRAG也接受任何LangChain聊天模型

response = rag.search(
    query_text="...",
    retriever_config={
        "top_k": 5,              // 每次搜索的候选数量（默认5）
        "query_params": {...},   // 传递给retrieval_query Cypher的参数
        "filters": {...},        // 向量搜索前的预过滤条件
    },
    return_context=False,        // 设为True：在响应中包含检索到的文本块
    response_fallback="No context found.",  // 检索器无结果时返回的内容
)
// response.answer → 字符串类型
// response.retriever_result → RawSearchResult类型（当return_context=True时返回）