Provedor de Memória Neo4j

O Provedor de Memória Neo4j fornece aos agentes do Agent Framework memória persistente apoiada por um grafo de conhecimento. Ao contrário dos provedores RAG que recuperam de bases de conhecimento estáticas, o provedor de memória armazena e recupera interações do agente, extraindo automaticamente entidades e construindo um grafo de conhecimento ao longo do tempo.

O provedor gerencia três tipos de memória:

  • Memória de curto prazo: histórico de conversas e contexto recente
  • Memória de longo prazo: entidades, preferências e fatos extraídos das interações
  • Memória de raciocínio: rastreamentos de raciocínio anteriores e padrões de uso de ferramentas

Por que usar o Neo4j para memória do agente?

  • Persistência do grafo de conhecimento: as memórias são armazenadas como entidades conectadas, não registros simples, para que o agente possa raciocinar sobre relações entre as coisas que se lembra.
  • Extração automática de entidade: as conversas são analisadas em entidades e relações estruturadas sem design de esquema manual.
  • Recuperação de memória entre sessões: preferências, fatos e traços de raciocínio persistem entre sessões e são exibidos automaticamente através de provedores de contexto.

Observação

O Neo4j oferece duas integrações separadas para o Agent Framework. Esse provedor (neo4j-agent-memory) destina-se à memória persistente – armazenando e recuperando interações do agente, extraindo entidades e criando um grafo de conhecimento ao longo do tempo. Para GraphRAG a partir de um grafo de conhecimento existente usando vetor, texto completo ou pesquisa híbrida, consulte o Provedor de Contexto do GraphRAG Neo4j.

Observação

O pacote .NET (AgentMemory) é uma porta de .NET independente mantida pela comunidade do provedor de memória Neo4j Labs — não é um pacote oficial do Neo4j Labs. Consulte o repositório AgentMemory (.NET) para obter a origem e os detalhes.

Pré-requisitos

  • Uma instância neo4j (auto-hospedada ou Neo4j AuraDB)
  • Uma implantação do Azure OpenAI ou do Microsoft Foundry (um modelo de chat + um modelo de embeddings)
  • Conjunto de variáveis de ambiente: NEO4J_URI, , NEO4J_USERNAME, NEO4J_PASSWORDAZURE_OPENAI_ENDPOINT
  • credenciais configuradas da CLI do Azure (az login) ou uma chave de API
  • .NET 8.0 ou posterior

Installation

dotnet add package AgentMemory
dotnet add package AgentMemory.AgentFramework

Usage

using Azure.AI.OpenAI;
using Azure.Identity;
using Microsoft.Agents.AI;
using Microsoft.Extensions.AI;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using AgentMemory;
using AgentMemory.Abstractions.Services;
using AgentMemory.AgentFramework;
using AgentMemory.AgentFramework.Tools;

var builder = Host.CreateApplicationBuilder(args);

// Registers Core + Neo4j infrastructure in one call (reads NEO4J_URI / NEO4J_USERNAME /
// NEO4J_PASSWORD, falling back to local-dev defaults). Passing configureLlm opts in to
// LLM-backed entity/fact/preference extraction, using the IChatClient registered below.
builder.Services.AddNeo4jAgentMemory(
    configureMemory: _ => { },
    configureNeo4j: neo4j =>
    {
        neo4j.Uri = Environment.GetEnvironmentVariable("NEO4J_URI") ?? "bolt://localhost:7687";
        neo4j.Username = Environment.GetEnvironmentVariable("NEO4J_USERNAME") ?? "neo4j";
        neo4j.Password = Environment.GetEnvironmentVariable("NEO4J_PASSWORD") ?? "password";
    },
    configureLlm: _ => { });

// Any Microsoft.Extensions.AI-compatible chat + embedding client works
var azureClient = new AzureOpenAIClient(
    new Uri(Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")!), new DefaultAzureCredential());
builder.Services.AddSingleton(azureClient.GetChatClient("gpt-4o-mini").AsIChatClient());
builder.Services.AddSingleton(azureClient.GetEmbeddingClient("text-embedding-3-small").AsIEmbeddingGenerator());

// AutoExtractOnPersist builds the knowledge graph from every conversation turn
builder.Services.AddAgentMemoryFramework(options =>
{
    options.AutoExtractOnPersist = true;
    options.ContextFormat.IncludeEntities = true;
    options.ContextFormat.IncludeFacts = true;
    options.ContextFormat.IncludePreferences = true;
});

using var host = builder.Build();
await using var scope = host.Services.CreateAsyncScope();
var services = scope.ServiceProvider;

// Bootstraps Neo4j schema/indexes on first run (idempotent)
await services.GetRequiredService<ISchemaBootstrapper>().BootstrapAsync();

var memoryProvider = services.GetRequiredService<Neo4jMemoryContextProvider>();
var memoryTools = services.GetRequiredService<MemoryToolFactory>().CreateAIFunctions();

// WithMemoryOwnerScoping wraps the whole invocation — recall, the tool-calling loop, and
// persistence — in the owner scope set by WithMemoryIdentity below, so no manual
// BeginOwnerScope call is needed around RunAsync.
AIAgent agent = services.GetRequiredService<IChatClient>().AsAIAgent(new ChatClientAgentOptions
{
    ChatOptions = new ChatOptions
    {
        Instructions = "You are a helpful assistant with persistent memory.",
        Tools = [.. memoryTools],
    },
    AIContextProviders = [memoryProvider],
}).WithMemoryOwnerScoping(services);

var session = (await agent.CreateSessionAsync())
    .WithMemoryIdentity(userId: "user-123", sessionId: "session-1", applicationId: "my-app");

var response = await agent.RunAsync("Remember that I prefer window seats on flights.", session);

Características principais

  • Bidirecional: Neo4jMemoryContextProvider lembra a memória relevante antes de cada execução e persiste a nova memória depois — nenhuma fiação manual é necessária
  • Extração de entidades: cria um grafo de conhecimento a partir de conversas com um pipeline de extração configurável (AutoExtractOnPersist)
  • Aprendizado de preferência: infere e armazena preferências, fatos e entidades do usuário, chamados automaticamente por um novo AgentSession para o mesmo usuário
  • Ferramentas de memória: MemoryToolFactory expõe AIFunctions para que o modelo possa pesquisar, lembrar e recordar explicitamente
  • Injeção de dependência primeiro: registra-se por meio AddNeo4jAgentMemory (conecta o Core + Neo4j internamente) e AddAgentMemoryFramework, encaixando-se naturalmente em aplicativos de Host Genérico e ASP.NET Core
  • Além do Agent Framework: a mesma biblioteca também se integra a clientes Kernel semântico e MCP e inclui a observabilidade interna do OpenTelemetry

Recursos

Pré-requisitos

  • Uma instância neo4j (auto-hospedada ou Neo4j AuraDB)
  • Um projeto do Fábrica de IA do Azure com um modelo de chat implantado
  • Uma chave de API OpenAI ou implantação do Azure OpenAI (para incorporações e extração de entidades)
  • Conjunto de variáveis de ambiente: NEO4J_URI, , NEO4J_PASSWORD, FOUNDRY_PROJECT_ENDPOINT, FOUNDRY_MODEL, OPENAI_API_KEY
  • Credenciais da CLI do Azure configuradas (az login)
  • Python 3.10 ou posterior

Installation

pip install neo4j-agent-memory[microsoft-agent]

Usage

import os
from pydantic import SecretStr
from agent_framework import Agent
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from neo4j_agent_memory import MemoryClient, MemorySettings
from neo4j_agent_memory.integrations.microsoft_agent import (
    Neo4jMicrosoftMemory,
    create_memory_tools,
)

# Pass Neo4j and embedding configuration directly via constructor arguments.
# MemorySettings also supports loading from environment variables or .env files
# using the NAM_ prefix (e.g. NAM_NEO4J__URI, NAM_EMBEDDING__MODEL).
settings = MemorySettings(
    neo4j={
        "uri": os.environ["NEO4J_URI"],
        "username": os.environ.get("NEO4J_USERNAME", "neo4j"),
        "password": SecretStr(os.environ["NEO4J_PASSWORD"]),
    },
    embedding={
        "provider": "openai",
        "model": "text-embedding-3-small",
    },
)

memory_client = MemoryClient(settings)

async with memory_client:
    memory = Neo4jMicrosoftMemory.from_memory_client(
        memory_client=memory_client,
        session_id="user-123",
    )
    tools = create_memory_tools(memory)

    async with AzureCliCredential() as credential, Agent(
            client=FoundryChatClient(
            credential=credential,
            project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
            model=os.environ["FOUNDRY_MODEL"],
        ),
        instructions="You are a helpful assistant with persistent memory.",
        tools=tools,
        context_providers=[memory.context_provider],
    ) as agent:
        session = agent.create_session()
        response = await agent.run("Remember that I prefer window seats on flights.", session=session)

Características principais

  • Bidirecional: recupera automaticamente o contexto relevante antes da invocação e salva novas memórias após as respostas
  • Extração de entidade: cria um grafo de conhecimento a partir de conversas usando um pipeline de extração de vários estágios
  • Aprendizado de preferência: infere e armazena as preferências do usuário entre sessões
  • Ferramentas de memória: os agentes podem pesquisar explicitamente a memória, lembrar preferências e encontrar conexões de entidade

Recursos

Observação

O suporte para Go a este recurso estará disponível em breve. Consulte o repositório Agent Framework Go para obter o status mais recente.

Próximas Etapas