Guida rapida all'API Agent Platform Memory Bank

Agent Platform Memory Bank ti consente di effettuare chiamate API direttamente a Sessioni e Memory Bank utilizzando l'SDK Agent Platform. Utilizza l'SDK Agent Platform se non vuoi che un framework dell'agente orchestri le chiamate per te o se vuoi integrare Sessioni e Memory Bank con framework dell'agente diversi da Agent Development Kit (ADK).

Questo documento mostra come creare, caricare, recuperare e rimuovere i ricordi utilizzando le chiamate API.

Per la guida rapida all'utilizzo di ADK, consulta Guida rapida a Memory Bank con ADK.

Per vedere un esempio di utilizzo di con l'SDK, esegui il notebook "Inizia a utilizzare Memory Bank" in uno dei seguenti ambienti:

Apri in Colab | Apri in Colab Enterprise | Apri in Agent Platform Workbench | Visualizza su GitHub

Per vedere un esempio di utilizzo di con LangGraph, esegui il notebook "Guida introduttiva a - LangGraph" in uno dei seguenti ambienti:

Apri in Colab | Apri in Colab Enterprise | Apri in Agent Platform Workbench | Visualizza su GitHub

Prima di iniziare

Per completare i passaggi illustrati in questo tutorial, devi prima seguire i passaggi descritti in Configurazione di Memory Bank.

Generare ricordi con Agent Platform Sessions

Dopo aver configurato le sessioni di Agent Platform e Memory Bank, puoi creare sessioni e aggiungere eventi. Le memorie vengono generate come fatti dalla conversazione dell'utente con l'agente, in modo che siano disponibili per le interazioni future dell'utente. Per ulteriori informazioni, consulta Generare memorie e Recuperare memorie.

Nota: puoi anche fornire la cronologia della conversazione direttamente nel payload GenerateMemories utilizzando l'origine contenuti diretti.

1. Crea una sessione con un ID utente opaco. Tutti i ricordi generati da questa sessione vengono automaticamente associati all'ambito {"user_id": "USER_ID"}, a meno che tu non fornisca esplicitamente un ambito durante la generazione dei ricordi.

   import vertexai
   
   client = vertexai.Client(
   project="PROJECT_ID",
   location="LOCATION"
   )
   
   # This assumes that you already have an Agent Platform instance. If you don't,
   # you can create one using `agent_engine = client.agent_engines.create()`.
   session = client.agent_engines.sessions.create(
   # The name can be fetched using `agent_engine.api_resource.name`.
   name="AGENT_ENGINE_NAME",
   user_id="USER_ID"
   )
   

   Sostituisci quanto segue:

   • PROJECT_ID: il tuo ID progetto.

   • LOCATION: la tua regione. Consulta le regioni supportate per Memory Bank.

   • AGENT_ENGINE_NAME: il nome dell'istanza di Agent Platform che hai creato o di un'istanza di Agent Platform esistente. Il nome deve essere nel seguente formato: projects/{your project}/locations/{your location}/reasoningEngine/{your reasoning engine}.

   • USER_ID: un identificatore per l'utente. Tutti i ricordi generati da questa sessione vengono automaticamente associati all'ambito {"user_id": "USER_ID"}, a meno che tu non fornisca esplicitamente un ambito quando generi i ricordi.

2. Carica in modo iterativo gli eventi nella sessione. Gli eventi possono includere qualsiasi interazione tra l'utente, l'agente e gli strumenti. L'elenco ordinato degli eventi rappresenta la cronologia delle conversazioni della sessione. Questa cronologia delle conversazioni viene utilizzata come materiale di origine per generare ricordi per quell'utente specifico.

   import datetime
   
   client.agent_engines.sessions.events.append(
   name=session.response.name,
   author="user",  # Required by Sessions.
   invocation_id="1",  # Required by Sessions.
   timestamp=datetime.datetime.now(tz=datetime.timezone.utc),  # Required by Sessions.
   config={
     "content": {
       "role": "user",
       "parts": [{"text": "hello"}]
     }
   }
   )
   

3. Per generare ricordi dalla cronologia delle conversazioni, attiva una richiesta di generazione di ricordi per la sessione:

   client.agent_engines.memories.generate(
   name=agent_engine.api_resource.name,
   vertex_session_source={
     # `session` should have the format "projects/.../locations/.../reasoningEngines/.../sessions/...".
   "session": session.response.name
   },
   # Optional when using Sessions. Defaults to {"user_id": session.user_id}.
   scope=SCOPE
   )
   

Sostituisci quanto segue:

• (Facoltativo) SCOPE: un dizionario che rappresenta l'ambito dei ricordi generati, con un massimo di 5 coppie chiave-valore e nessun carattere *. Ad esempio: {"session_id": "MY_SESSION"}. Per il consolidamento vengono prese in considerazione solo le memorie con lo stesso ambito. Se non fornito, viene utilizzato {"user_id": session.user_id}.

Caricare i ricordi

In alternativa alla generazione di ricordi utilizzando dialoghi grezzi, puoi caricare i ricordi o chiedere ai tuoi agenti di aggiungerli direttamente utilizzando GenerateMemories confatti preestratti. Anziché estrarre informazioni dai tuoi contenuti, Memory Bank ti fornisce direttamente i fatti da memorizzare sull'utente.

Per garantire la coerenza con i ricordi generati, prova a scrivere i fatti preestratti nella stessa prospettiva che hai configurato per l'ambito specificato. Per impostazione predefinita, i ricordi vengono generati in prima persona (ad esempio, I am a software engineer).

client.agent_engines.memories.generate(
    name=agent_engine.api_resource.name,
    direct_memories_source={"direct_memories": [{"fact": "FACT"}]},
    scope=SCOPE
)

Sostituisci quanto segue:

• FACT: il fatto preestratto che deve essere consolidato con i ricordi esistenti. Puoi fornire fino a 5 fatti preestratti in un elenco come il seguente:

  {"direct_memories": [{"fact": "fact 1"}, {"fact": "fact 2"}]}
  

• SCOPE: un dizionario che rappresenta l'ambito dei ricordi generati. Ad esempio, {"session_id": "MY_SESSION"}. Per il consolidamento vengono prese in considerazione solo le memorie con lo stesso ambito.

In alternativa, puoi utilizzare CreateMemory per caricare i ricordi senza utilizzare Memory Bank per l'estrazione o il consolidamento dei ricordi.

Attenzione: i ricordi caricati utilizzando CreateMemory non verranno consolidati con i ricordi esistenti, quindi potresti ritrovarti con ricordi duplicati per lo stesso ambito. I ricordi creati sono disponibili per la ricerca per somiglianza e possono essere consolidati per le richieste future durante la generazione dei ricordi.

memory = client.agent_engines.memories.create(
    name=agent_engine.api_resource.name,
    fact="This is a fact.",
    scope={"user_id": "123"}
)

"""
Returns an AgentEngineMemoryOperation containing the created Memory like:

AgentEngineMemoryOperation(
  done=True,
  metadata={
    "@type': 'type.googleapis.com/google.cloud.aiplatform.v1beta1.CreateMemoryOperationMetadata",
    "genericMetadata": {
      "createTime": '2025-06-26T01:15:29.027360Z',
      "updateTime": '2025-06-26T01:15:29.027360Z'
    }
  },
  name="projects/.../locations/us-central1/reasoningEngines/.../memories/.../operations/...",
  response=Memory(
    create_time=datetime.datetime(2025, 6, 26, 1, 15, 29, 27360, tzinfo=TzInfo(UTC)),
    fact="This is a fact.",
    name="projects/.../locations/us-central1/reasoningEngines/.../memories/...",
    scope={
      "user_id": "123"
    },
    update_time=datetime.datetime(2025, 6, 26, 1, 15, 29, 27360, tzinfo=TzInfo(UTC))
  )
)
"""

Recuperare e utilizzare i ricordi

Puoi recuperare i ricordi per l'utente e includerli nelle istruzioni di sistema per dare all'LLM l'accesso al tuo contesto personalizzato.

Per saperne di più sul recupero dei ricordi utilizzando un metodo basato sull'ambito, consulta la sezione Recuperare i ricordi.

# Retrieve all memories for User ID 123.
retrieved_memories = list(
    client.agent_engines.memories.retrieve(
        name=agent_engine.api_resource.name,
        scope={"user_id": "123"}
    )
)

Puoi utilizzare jinja per convertire i tuoi ricordi strutturati in un prompt:

from jinja2 import Template

template = Template("""
<MEMORIES>
Here is some information about the user:
{% for retrieved_memory in data %}* {{ retrieved_memory.memory.fact }}
{% endfor %}</MEMORIES>
""")

prompt = template.render(data=retrieved_memories)

"""
Output:

<MEMORIES>
Here is some information about the user:
* This is a fact
</MEMORIES>
"""

Rimuovere i ricordi

Esistono diversi modi per eliminare i ricordi dall'istanza di Memory Bank, a seconda di come vuoi selezionare i ricordi da rimuovere.

Rimuovi per nome risorsa

Se sai esattamente quale risorsa di memoria vuoi rimuovere, puoi eliminare una memoria specifica utilizzando il nome della risorsa:

client.agent_engines.memories.delete(
    name=MEMORY_NAME,
    config={
        # Set to false (default) if you want to delete the memory asynchronously.
        "wait_for_completion": True
    }
)

Sostituisci quanto segue:

• MEMORY_NAME: il nome del ricordo da eliminare. Il nome deve essere nel seguente formato: projects/{your project}/locations/{your location}/reasoningEngine/{your reasoning engine}/memories/{your memory}. Puoi trovare il nome del ricordo recuperando i ricordi.

Rimuovere in base ai criteri

Puoi utilizzare l'eliminazione basata sui criteri per rimuovere uno o più ricordi. Verranno eliminate solo le memorie che corrispondono ai filtri forniti. Devi specificare almeno uno tra filter (applicato ai campi di sistema) o filter_groups (applicato ai campi dei metadati).

operation = client.agent_engines.memories.purge(
    name=agent_engine.api_resource.name,
    # Specify at least one of `filter` or `filter_groups`.
    filter="FILTER_STRING",
    filter_groups=FILTER_GROUPS,
    # Set to false (default) if you want to stage but not execute the purge operation.
    force=True,
    config={
        # Set to false (default) if you want to purge memories asynchronously.
        "wait_for_completion": True
    }
)

Sostituisci quanto segue:

• FILTER_STRING: una stringa che utilizza la sintassi EBNF per il filtro in base ai campi di sistema. I campi di sistema includono create_time, update_time, fact e topics. Per saperne di più sul filtraggio in base ai campi di sistema, consulta la sezione Filtra per campi di metadati nella pagina Recupera ricordi.
• FILTER_GROUPS: un elenco di dizionari o oggetti per il filtro in base ai metadati della memoria. Per saperne di più sul filtro in base ai campi dei metadati, consulta la sezione Filtra per campi di sistema nella pagina Recupera ricordi.

L'operazione restituirà un conteggio del numero di ricordi eliminati (se force=True) o che verrebbero eliminati se l'operazione venisse eseguita (se force=False).

print(operation.response.purge_count)

Ad esempio, puoi eliminare tutte le memorie che appartengono a un ambito per user_id "123":

operation = client.agent_engines.memories.purge(
    name=agent_engine.api_resource.name,
    filter="scope.user_id=\"123\""
    force=True
)

Rimuovere in base al significato semantico

Nota: il comportamento previsto può variare a seconda degli argomenti della memoria e degli esempi few-shot che hai configurato.

Durante la generazione dei ricordi, Memory Bank decide se creare, aggiornare o eliminare i ricordi in base ai contenuti delle informazioni appena estratte e ai ricordi esistenti. Un ricordo può essere eliminato se le nuove informazioni lo contraddicono o se i contenuti estratti indicano a Memory Bank di dimenticare un soggetto (nel caso dell'argomento EXPLICIT_INSTRUCTIONS).

Ad esempio, la seguente richiesta elimina i ricordi esistenti che contengono informazioni sulle preferenze alimentari, se esistono per il scope specificato:

from google import genai

client.agent_engines.memories.generate(
    name=agent_engine.api_resource.name,
    direct_contents_source={
      "events": [{
        "content": genai.types.Content(
          role="user",
          parts=[
            genai.types.Part.from_text(text="Forget my dietary preferences.")
          ]
        )
      }]
    },
    scope={...}
)

Esegui la pulizia

Per liberare spazio da tutte le risorse utilizzate in questo progetto, puoi eliminare il Google Cloud progetto utilizzato per la guida rapida.

In alternativa, puoi eliminare le singole risorse che hai creato in questo tutorial nel seguente modo:

1. Utilizza il seguente esempio di codice per eliminare l'istanza di Agent Platform, che elimina anche eventuali sessioni o ricordi associati all'istanza di Agent Platform.

   agent_engine.delete(force=True)
   

2. Elimina tutti i file creati localmente.

Passaggi successivi

Guida rapida

Guida rapida all'Agent Development Kit

Inizia a utilizzare l'Agent Development Kit (ADK).