通过

Neo4j GraphRAG 上下文提供程序

Neo4j GraphRAG 上下文提供程序使用 Neo4j 知识图将检索扩充生成（RAG）功能添加到 Agent Framework 代理。 它支持矢量、全文和混合搜索模式，使用可选的图形遍历通过自定义 Cypher 查询来扩充相关实体的结果。

对于实体之间的关系很重要的知识图方案，此提供程序检索相关的子图而不是独立文本区块，从而为代理提供更丰富的上下文来生成响应。

为什么将 Neo4j 用于 GraphRAG？

  • 图形增强检索：标准矢量搜索返回独立区块;图形遍历遵循与图面相关实体的连接，为代理提供更丰富的上下文。
  • 灵活的搜索模式：在单个查询中合并矢量相似性、关键字/BM25 和图形遍历。
  • 自定义检索查询：使用 Cypher 查询可以准确控制要遍历的关系以及要返回的上下文。

注释

Neo4j 为 Agent Framework 提供两个单独的集成。 此提供程序适用于 GraphRAG ， 将现有知识图搜索到地面代理响应。 有关从对话中学习并随时间推移生成知识图的 持久内存 ，请参阅 Neo4j 内存提供程序。

先决条件

  • 配置矢量或全文索引的 Neo4j 实例（自托管或 Neo4j AuraDB）
  • 具有已部署聊天模型和嵌入模型的 Azure AI Foundry 项目（例如 text-embedding-3-small）
  • 环境变量集：NEO4J_URI、、NEO4J_USERNAMENEO4J_PASSWORD、AZURE_AI_SERVICES_ENDPOINT、AZURE_AI_EMBEDDING_NAME
  • 已配置 Azure CLI 凭据 （az login）
  • .NET 8.0 或更高版本

安装

dotnet add package Neo4j.AgentFramework.GraphRAG

用法

using Azure.AI.OpenAI;
using Azure.Identity;
using Microsoft.Agents.AI;
using Microsoft.Agents.AI.OpenAI;
using Microsoft.Extensions.AI;
using Neo4j.AgentFramework.GraphRAG;
using Neo4j.Driver;

// Read connection details from environment variables
var neo4jSettings = new Neo4jSettings();
var azureEndpoint = Environment.GetEnvironmentVariable("AZURE_AI_SERVICES_ENDPOINT")!;

// Create embedding generator
var credential = new DefaultAzureCredential();
var azureClient = new AzureOpenAIClient(new Uri(azureEndpoint), credential);

IEmbeddingGenerator<string, Embedding<float>> embedder = azureClient
    .GetEmbeddingClient("text-embedding-3-small")
    .AsIEmbeddingGenerator();

// Create Neo4j driver
await using var driver = GraphDatabase.Driver(
    neo4jSettings.Uri, AuthTokens.Basic(neo4jSettings.Username, neo4jSettings.Password!));

// Create the Neo4j context provider
await using var provider = new Neo4jContextProvider(driver, new Neo4jContextProviderOptions
{
    IndexName = "chunkEmbeddings",
    IndexType = IndexType.Vector,
    EmbeddingGenerator = embedder,
    TopK = 5,
    RetrievalQuery = """
        MATCH (node)-[:FROM_DOCUMENT]->(doc:Document)
        OPTIONAL MATCH (doc)<-[:FILED]-(company:Company)
        RETURN node.text AS text, score, doc.title AS title, company.name AS company
        ORDER BY score DESC
        """,
});

// Create an agent with the provider
AIAgent agent = azureClient
    .GetChatClient("gpt-4o")
    .AsIChatClient()
    .AsBuilder()
    .UseAIContextProviders(provider)
    .BuildAIAgent(new ChatClientAgentOptions
    {
        ChatOptions = new ChatOptions
        {
            Instructions = "You are a financial analyst assistant.",
        },
    });

var session = await agent.CreateSessionAsync();
Console.WriteLine(await agent.RunAsync("What risks does Acme Corp face?", session));

主要功能

  • 索引驱动：适用于任何 Neo4j 向量或全文索引
  • 图形遍历：自定义 Cypher 查询使用相关实体扩充搜索结果
  • 搜索模式：矢量（语义相似性）、全文（关键字/BM25）或混合（两者均组合）

资源

先决条件

  • 配置矢量或全文索引的 Neo4j 实例（自托管或 Neo4j AuraDB）
  • 具有已部署聊天模型和嵌入模型的 Azure AI Foundry 项目（例如 text-embedding-ada-002）
  • 环境变量集：NEO4J_URI、、NEO4J_USERNAME、NEO4J_PASSWORDFOUNDRY_PROJECT_ENDPOINT、FOUNDRY_MODEL、AZURE_AI_EMBEDDING_NAME
  • 已配置 Azure CLI 凭据 （az login）
  • Python 3.10 或更高版本

安装

pip install agent-framework-neo4j

用法

import os

from agent_framework import Agent
from agent_framework.foundry import FoundryChatClient
from agent_framework_neo4j import Neo4jContextProvider, Neo4jSettings, AzureAISettings, AzureAIEmbedder
from azure.identity import DefaultAzureCredential
from azure.identity.aio import AzureCliCredential

# Reads NEO4J_URI, NEO4J_USERNAME, NEO4J_PASSWORD from environment variables
neo4j_settings = Neo4jSettings()

# Reads FOUNDRY_PROJECT_ENDPOINT, AZURE_AI_EMBEDDING_NAME from environment variables
azure_settings = AzureAISettings()

sync_credential = DefaultAzureCredential()
embedder = AzureAIEmbedder(
    endpoint=azure_settings.inference_endpoint,
    credential=sync_credential,
    model=azure_settings.embedding_model,
)

neo4j_provider = Neo4jContextProvider(
    uri=neo4j_settings.uri,
    username=neo4j_settings.username,
    password=neo4j_settings.get_password(),
    index_name=neo4j_settings.vector_index_name,
    index_type="vector",
    embedder=embedder,
    top_k=5,
    retrieval_query="""
        MATCH (node)-[:FROM_DOCUMENT]->(doc:Document)
        OPTIONAL MATCH (doc)<-[:FILED]-(company:Company)
        RETURN node.text AS text, score, doc.title AS title, company.name AS company
        ORDER BY score DESC
    """,
)

async with (
    neo4j_provider,
    AzureCliCredential() as credential,
    Agent(
        client=FoundryChatClient(
            credential=credential,
            project_endpoint=azure_settings.project_endpoint,
            model=os.environ["FOUNDRY_MODEL"],
        ),
        instructions="You are a financial analyst assistant.",
        context_providers=[neo4j_provider],
    ) as agent,
):
    session = agent.create_session()
    response = await agent.run("What risks does Acme Corp face?", session=session)

主要功能

  • 索引驱动：适用于任何 Neo4j 向量或全文索引
  • 图形遍历：自定义 Cypher 查询使用相关实体扩充搜索结果
  • 搜索模式：矢量（语义相似性）、全文（关键字/BM25）或混合（两者均组合）

资源

后续步骤

Neo4j 内存提供程序

  • Last updated on