メモリ:MemoryServiceによる長期的な知識¶
Session は単一の会話の履歴(events)と一時データ(state)を追跡しますが、エージェントが過去のやり取りから情報を思い出す必要がある場合があります。ここで、長期的な知識(Long-Term Knowledge)と MemoryService の概念が登場します。次のように考えてみてください:
Session/State: 特定の 1 つのチャット中の短期記憶です。- 長期的な知識(
MemoryService): エージェントが参照できる検索可能なアーカイブまたは知識ライブラリであり、過去の多くのチャットや他のソースからの情報が含まれている可能性があります。
MemoryService の役割¶
BaseMemoryService(Go では Service)は、この検索可能な長期知識ストアを管理するためのインターフェースを定義します。次の操作をサポートします:
- 情報の取り込み(Ingesting Information):
add_session_to_memory: 完了したSessionを受け取り、関連情報を長期知識ストアに追加します。このアプローチは、会話の要点を自動的にキャプチャするのに最適です。add_events_to_memory: セッション全体を再取り込みすることなく、イベントの差分(たとえば最新のターン)を追加します。長時間実行されるセッションの途中でメモリに書き込みたい場合に便利です。add_memory: 明示的なMemoryEntryオブジェクトをメモリに直接追加します。このメソッドはきめ細かな制御を提供し、他のソースから特定のファクトを注入するのに便利です。
- 情報の検索(
search_memory): エージェント(通常はToolを介して)が知識ストアにクエリを実行し、検索クエリに基づいて関連するスニペットやコンテキストを取得できるようにします。
add_events_to_memory と add_memory はオプションであり、すべてのサービスで実装されているわけではないため、利用する前に選択したサービスがそれらをサポートしているか確認してください。
適切なメモリサービスの選択¶
Python ADK には 3 つの MemoryService 実装が含まれています。以下の表を使用して、エージェントに最適なものを決定してください。
| 機能 | InMemoryMemoryService | VertexAiMemoryBankService | VertexAiRagMemoryService |
|---|---|---|---|
| 永続性 | なし(再起動時にデータは失われます) | あり(Agent Platform で管理) | あり(Knowledge Engine に保存) |
| 主なユースケース | プロトタイピング、ローカル開発、および簡単なテスト。 | ユーザーの会話から意味のある、進化するメモリを構築します。 | 会話コーパス全体、または他の RAG インデックス済みコンテンツと併せたベクトル検索による取得。 |
| メモリ抽出 | 会話全体を保存します | LLM を活用して会話から意味のある情報を抽出し、既存のメモリと統合します | Knowledge Engine でインデックス化された会話全体を保存します。 |
| 検索機能 | 基本的なキーワードマッチング。 | 高度なセマンティック検索。 | Knowledge Engine 上のベクトル類似度検索。 |
| セットアップの複雑さ | なし。デフォルトです。 | 低。Agent Platform 上の Agent Runtime インスタンスが必要です。 | 中。Knowledge Engine が必要です。 |
| 依存関係 | なし。 | Google Cloud プロジェクト、Agent Platform API | Google Cloud プロジェクト、Knowledge Engine、Agent Platform SDK(オプションのインストール)。 |
| 使用するタイミング | プロトタイピングのために複数のセッションのチャット履歴を横断して検索したい場合。 | エージェントに過去のやり取りを記憶させ、学習させたい場合。 | 既存の RAG インフラストラクチャがある場合、または生の会話トランスクリプトを検索したい場合。 |
google.adk.memory から VertexAiRagMemoryService を常にインポートできますが、pip install google-adk[gcp] で Agent Platform SDK がインストールされていない限り、構築時に ImportError が発生します。Memory Bank と RAG バックアップメモリについては、以下の Memory Bank と RAG メモリ で説明されています。
InMemoryMemoryService¶
InMemoryMemoryService は、アプリケーションのメモリにセッション情報を保存し、検索のために基本的なキーワードマッチングを実行します。セットアップは不要で、永続性が必要ないプロトタイピングや簡単なテストシナリオに最適です。
例:メモリの追加と検索
この例では、簡単にするために InMemoryMemoryService を使用した基本的なフローを示します。
import asyncio
from google.adk.agents import LlmAgent
from google.adk.sessions import InMemorySessionService, Session
from google.adk.memory import InMemoryMemoryService # Import MemoryService
from google.adk.runners import Runner
from google.adk.tools import load_memory # Tool to query memory
from google.genai.types import Content, Part
# --- Constants ---
APP_NAME = "memory_example_app"
USER_ID = "mem_user"
MODEL = "gemini-flash-latest" # Use a valid model
# --- Agent Definitions ---
# Agent 1: Simple agent to capture information
info_capture_agent = LlmAgent(
model=MODEL,
name="InfoCaptureAgent",
instruction="Acknowledge the user's statement.",
)
# Agent 2: Agent that can use memory
memory_recall_agent = LlmAgent(
model=MODEL,
name="MemoryRecallAgent",
instruction="Answer the user's question. Use the 'load_memory' tool "
"if the answer might be in past conversations.",
tools=[load_memory] # Give the agent the tool
)
# --- Services ---
# Services must be shared across runners to share state and memory
session_service = InMemorySessionService()
memory_service = InMemoryMemoryService() # Use in-memory for demo
async def run_scenario():
# --- Scenario ---
# Turn 1: Capture some information in a session
print("--- Turn 1: Capturing Information ---")
runner1 = Runner(
# Start with the info capture agent
agent=info_capture_agent,
app_name=APP_NAME,
session_service=session_service,
memory_service=memory_service # Provide the memory service to the Runner
)
session1_id = "session_info"
await runner1.session_service.create_session(app_name=APP_NAME, user_id=USER_ID, session_id=session1_id)
user_input1 = Content(parts=[Part(text="My favorite project is Project Alpha.")], role="user")
# Run the agent
final_response_text = "(No final response)"
async for event in runner1.run_async(user_id=USER_ID, session_id=session1_id, new_message=user_input1):
if event.is_final_response() and event.content and event.content.parts:
final_response_text = event.content.parts[0].text
print(f"Agent 1 Response: {final_response_text}")
# Get the completed session
completed_session1 = await runner1.session_service.get_session(app_name=APP_NAME, user_id=USER_ID, session_id=session1_id)
# Add this session's content to the Memory Service
print("\n--- Adding Session 1 to Memory ---")
await memory_service.add_session_to_memory(completed_session1)
print("Session added to memory.")
# Turn 2: Recall the information in a new session
print("\n--- Turn 2: Recalling Information ---")
runner2 = Runner(
# Use the second agent, which has the memory tool
agent=memory_recall_agent,
app_name=APP_NAME,
session_service=session_service, # Reuse the same service
memory_service=memory_service # Reuse the same service
)
session2_id = "session_recall"
await runner2.session_service.create_session(app_name=APP_NAME, user_id=USER_ID, session_id=session2_id)
user_input2 = Content(parts=[Part(text="What is my favorite project?")], role="user")
# Run the second agent
final_response_text_2 = "(No final response)"
async for event in runner2.run_async(user_id=USER_ID, session_id=session2_id, new_message=user_input2):
if event.is_final_response() and event.content and event.content.parts:
final_response_text_2 = event.content.parts[0].text
print(f"Agent 2 Response: {final_response_text_2}")
# To run this example, you can use the following snippet:
# asyncio.run(run_scenario())
# await run_scenario()
import {
InMemoryMemoryService,
InMemorySessionService,
LOAD_MEMORY,
LlmAgent,
Runner
} from '@google/adk';
import { createUserContent } from '@google/genai';
// --- Constants ---
const APP_NAME = "memory_example_app";
const USER_ID = "mem_user";
const MODEL = "gemini-2.5-flash";
// --- Agent Definitions ---
// Agent 1: Simple agent to capture information
const infoCaptureAgent = new LlmAgent({
model: MODEL,
name: "InfoCaptureAgent",
instruction: "Acknowledge the user's statement concisely.",
});
// Agent 2: Agent that can use memory
const memoryRecallAgent = new LlmAgent({
model: MODEL,
name: "MemoryRecallAgent",
instruction: "Answer the user's question. Use the 'load_memory' tool if the answer might be in past conversations.",
tools: [LOAD_MEMORY]
});
// Export for 'adk run' compatibility (to avoid 'No BaseAgent found' error)
export const root_agent = memoryRecallAgent;
// --- Services ---
const sessionService = new InMemorySessionService();
const memoryService = new InMemoryMemoryService();
async function runScenario() {
// --- Turn 1: Capture some information in a session ---
console.log("--- Turn 1: Capturing Information ---");
const runner1 = new Runner({
agent: infoCaptureAgent,
appName: APP_NAME,
sessionService,
memoryService
});
const session1Id = "session_info";
await sessionService.createSession({ appName: APP_NAME, userId: USER_ID, sessionId: session1Id });
const userInput1 = createUserContent("My favorite project is Project Alpha.");
let finalResponseText = "(No final response)";
for await (const event of runner1.runAsync({ userId: USER_ID, sessionId: session1Id, newMessage: userInput1 })) {
// Capture any text response from the agent
if (event.author === infoCaptureAgent.name && event.content?.parts) {
const text = event.content.parts.map(p => p.text || "").join("").trim();
if (text) finalResponseText = text;
}
}
console.log(`Agent 1 Response: ${finalResponseText}`);
// Get the completed session and add to Memory
const completedSession1 = await sessionService.getSession({ appName: APP_NAME, userId: USER_ID, sessionId: session1Id });
console.log("\n--- Adding Session 1 to Memory ---");
if (completedSession1) {
await memoryService.addSessionToMemory(completedSession1);
console.log("Session added to memory.");
}
// --- Turn 2: Recall the information in a new session ---
console.log("\n--- Turn 2: Recalling Information ---");
const runner2 = new Runner({
agent: memoryRecallAgent,
appName: APP_NAME,
sessionService,
memoryService
});
const session2Id = "session_recall";
await sessionService.createSession({ appName: APP_NAME, userId: USER_ID, sessionId: session2Id });
const userInput2 = createUserContent("What is my favorite project?");
let finalResponseText2 = "(No final response)";
for await (const event of runner2.runAsync({ userId: USER_ID, sessionId: session2Id, newMessage: userInput2 })) {
// Capture any text response from the agent
if (event.author === memoryRecallAgent.name && event.content?.parts) {
const text = event.content.parts.map(p => p.text || "").join("").trim();
if (text) finalResponseText2 = text;
}
}
console.log(`Agent 2 Response: ${finalResponseText2}`);
// Exit immediately to prevent the ADK CLI from starting an interactive loop
process.exit(0);
}
// Execute the scenario
runScenario().catch(err => {
console.error(err);
process.exit(1);
});
import (
"context"
"fmt"
"log"
"strings"
"google.golang.org/adk/v2/agent"
"google.golang.org/adk/v2/agent/llmagent"
"google.golang.org/adk/v2/memory"
"google.golang.org/adk/v2/model/gemini"
"google.golang.org/adk/v2/runner"
"google.golang.org/adk/v2/session"
"google.golang.org/adk/v2/tool"
"google.golang.org/adk/v2/tool/functiontool"
"google.golang.org/genai"
)
const (
appName = "go_memory_example_app"
userID = "go_mem_user"
modelID = "gemini-2.5-flash"
)
// Args defines the input structure for the memory search tool.
type Args struct {
Query string `json:"query" jsonschema:"The query to search for in the memory."`
}
// Result defines the output structure for the memory search tool.
type Result struct {
Results []string `json:"results"`
}
// memorySearchToolFunc is the implementation of the memory search tool.
// This function demonstrates accessing memory via agent.Context.
func memorySearchToolFunc(tctx agent.Context, args Args) (Result, error) {
fmt.Printf("Tool: Searching memory for query: '%s'\n", args.Query)
// The SearchMemory function is available on the context.
searchResults, err := tctx.SearchMemory(context.Background(), args.Query)
if err != nil {
log.Printf("Error searching memory: %v", err)
return Result{}, fmt.Errorf("failed memory search")
}
var results []string
for _, res := range searchResults.Memories {
if res.Content != nil {
results = append(results, textParts(res.Content)...)
}
}
return Result{Results: results}, nil
}
// Define a tool that can search memory.
var memorySearchTool = must(functiontool.New(
functiontool.Config{
Name: "search_past_conversations",
Description: "Searches past conversations for relevant information.",
},
memorySearchToolFunc,
))
// This example demonstrates how to use the MemoryService in the Go ADK.
// It covers two main scenarios:
// 1. Adding a completed session to memory and recalling it in a new session.
// 2. Searching memory from within a custom tool using the agent.Context.
func main() {
ctx := context.Background()
// --- Services ---
// Services must be shared across runners to share state and memory.
sessionService := session.InMemoryService()
memoryService := memory.InMemoryService() // Use in-memory for this demo.
// --- Scenario 1: Capture information in one session ---
fmt.Println("--- Turn 1: Capturing Information ---")
infoCaptureAgent := must(llmagent.New(llmagent.Config{
Name: "InfoCaptureAgent",
Model: must(gemini.NewModel(ctx, modelID, nil)),
Instruction: "Acknowledge the user's statement.",
}))
runner1 := must(runner.New(runner.Config{
AppName: appName,
Agent: infoCaptureAgent,
SessionService: sessionService,
MemoryService: memoryService, // Provide the memory service to the Runner
}))
session1ID := "session_info"
must(sessionService.Create(ctx, &session.CreateRequest{AppName: appName, UserID: userID, SessionID: session1ID}))
userInput1 := genai.NewContentFromText("My favorite project is Project Alpha.", "user")
var finalResponseText string
for event, err := range runner1.Run(ctx, userID, session1ID, userInput1, agent.RunConfig{}) {
if err != nil {
log.Printf("Agent 1 Error: %v", err)
continue
}
if event.LLMResponse.Content != nil && !event.LLMResponse.Partial {
finalResponseText = strings.Join(textParts(event.LLMResponse.Content), "")
}
}
fmt.Printf("Agent 1 Response: %s\n", finalResponseText)
// Add the completed session to the Memory Service
fmt.Println("\n--- Adding Session 1 to Memory ---")
resp, err := sessionService.Get(ctx, &session.GetRequest{AppName: appName, UserID: userID, SessionID: session1ID})
if err != nil {
log.Fatalf("Failed to get completed session: %v", err)
}
if err := memoryService.AddSessionToMemory(ctx, resp.Session); err != nil {
log.Fatalf("Failed to add session to memory: %v", err)
}
fmt.Println("Session added to memory.")
// --- Scenario 2: Recall the information in a new session using a tool ---
fmt.Println("\n--- Turn 2: Recalling Information ---")
memoryRecallAgent := must(llmagent.New(llmagent.Config{
Name: "MemoryRecallAgent",
Model: must(gemini.NewModel(ctx, modelID, nil)),
Instruction: "Answer the user's question. Use the 'search_past_conversations' tool if the answer might be in past conversations.",
Tools: []tool.Tool{memorySearchTool}, // Give the agent the tool
}))
runner2 := must(runner.New(runner.Config{
Agent: memoryRecallAgent,
AppName: appName,
SessionService: sessionService,
MemoryService: memoryService,
}))
session2ID := "session_recall"
must(sessionService.Create(ctx, &session.CreateRequest{AppName: appName, UserID: userID, SessionID: session2ID}))
userInput2 := genai.NewContentFromText("What is my favorite project?", "user")
var finalResponseText2 string
for event, err := range runner2.Run(ctx, userID, session2ID, userInput2, agent.RunConfig{}) {
if err != nil {
log.Printf("Agent 2 Error: %v", err)
continue
}
if event.LLMResponse.Content != nil && !event.LLMResponse.Partial {
finalResponseText2 = strings.Join(textParts(event.LLMResponse.Content), "")
}
}
fmt.Printf("Agent 2 Response: %s\n", finalResponseText2)
}
import com.google.adk.agents.LlmAgent;
import com.google.adk.agents.RunConfig;
import com.google.adk.events.Event;
import com.google.adk.runner.InMemoryRunner;
import com.google.adk.sessions.Session;
import com.google.adk.tools.LoadMemoryTool;
import com.google.genai.types.Content;
import com.google.genai.types.Part;
import java.util.Optional;
public class MemoryExample {
public static void main(String[] args) {
String appName = "memory_example_app";
String userId = "mem_user";
String model = "gemini-flash-latest";
// An agent that can recall past information using the load_memory tool.
LlmAgent agent =
LlmAgent.builder()
.model(model)
.name("MemoryAgent")
.instruction(
"Answer the user's question. Use the 'load_memory' tool "
+ "if the answer might be in past conversations.")
.tools(new LoadMemoryTool())
.build();
// InMemoryRunner bundles in-memory session and memory services and shares
// them across every session it creates.
InMemoryRunner runner = new InMemoryRunner(agent, appName);
// --- Turn 1: capture information in one session ---
Session captureSession =
runner.sessionService().createSession(appName, userId).blockingGet();
Content statement =
Content.fromParts(Part.fromText("My favorite project is Project Alpha."));
runner
.runAsync(userId, captureSession.id(), statement, RunConfig.builder().build())
.blockingSubscribe();
// Persist the finished session to memory.
Session completedSession =
runner
.sessionService()
.getSession(appName, userId, captureSession.id(), Optional.empty())
.blockingGet();
runner.memoryService().addSessionToMemory(completedSession).blockingAwait();
// --- Turn 2: recall the information in a new session ---
Session recallSession =
runner.sessionService().createSession(appName, userId).blockingGet();
Content question = Content.fromParts(Part.fromText("What is my favorite project?"));
runner
.runAsync(userId, recallSession.id(), question, RunConfig.builder().build())
.blockingForEach(
(Event event) -> {
if (event.finalResponse()) {
event
.content()
.flatMap(Content::parts)
.ifPresent(
parts ->
parts.forEach(part -> part.text().ifPresent(System.out::println)));
}
});
}
}
/**
* This example demonstrates the basic flow using the `InMemoryMemoryService` in Kotlin.
* It shows how to capture information in one session, add it to memory, and recall it in another.
*/
fun main() =
runBlocking {
// --- Constants ---
val appName = "memory_example_app"
val userId = "mem_user"
val model = Gemini(name = "gemini-flash-latest")
// --- Agent Definitions ---
// Agent 1: Simple agent to capture information
val infoCaptureAgent =
LlmAgent(
name = "InfoCaptureAgent",
model = model,
instruction = Instruction("Acknowledge the user's statement."),
)
// Agent 2: Agent that can use memory
val memoryRecallAgent =
LlmAgent(
name = "MemoryRecallAgent",
model = model,
instruction =
Instruction(
"Answer the user's question. Use the 'load_memory' tool " +
"if the answer might be in past conversations.",
),
// Give the agent the tool
tools = listOf(LoadMemoryTool()),
)
// --- Services ---
// Services must be shared across runners to share state and memory
val sessionService = InMemorySessionService()
val memoryService = InMemoryMemoryService()
// --- Turn 1: Capturing Information ---
println("--- Turn 1: Capturing Information ---")
val runner1 =
InMemoryRunner(
agent = infoCaptureAgent,
appName = appName,
sessionService = sessionService,
memoryService = memoryService,
)
val sessionId1 = "session_info"
val userInput1 = Content.fromText(Role.USER, "My favorite project is Project Alpha.")
// Run the agent
runner1
.runAsync(
userId = userId,
sessionId = sessionId1,
newMessage = userInput1,
).collect { event ->
event.content?.parts?.forEach { part ->
if (!part.text.isNullOrBlank()) {
println("Agent Response: ${part.text}")
}
}
}
// Get the completed session using SessionKey
val session1 = sessionService.getSession(SessionKey(appName, userId, sessionId1))
// Add this session's content to the Memory Service
println("\n--- Adding Session 1 to Memory ---")
if (session1 != null) {
memoryService.addSessionToMemory(session1)
println("Session added to memory.")
}
// --- Turn 2: Recalling Information ---
println("\n--- Turn 2: Recalling Information ---")
val runner2 =
InMemoryRunner(
agent = memoryRecallAgent,
appName = appName,
// Reuse the same service
sessionService = sessionService,
// Reuse the same service
memoryService = memoryService,
)
val sessionId2 = "session_recall"
val userInput2 = Content.fromText(Role.USER, "What is my favorite project?")
// Run the second agent
runner2
.runAsync(
userId = userId,
sessionId = sessionId2,
newMessage = userInput2,
).collect { event ->
event.content?.parts?.forEach { part ->
if (!part.text.isNullOrBlank()) {
println("Agent Response: ${part.text}")
}
}
}
}
ツール内でのメモリ検索¶
ツールコンテキストを使用して、カスタムツール内からメモリを検索することもできます。
// Within a tool implementation
async runAsync({ args, toolContext }: RunAsyncToolRequest) {
const query = args['query'] as string;
const response = await toolContext.searchMemory(query);
// process response
return {
memories: response.memories.map(m => m.content.parts?.map(p => p.text).join(' ')).join('\n')
};
}
// memorySearchToolFunc is the implementation of the memory search tool.
// This function demonstrates accessing memory via agent.Context.
func memorySearchToolFunc(tctx agent.Context, args Args) (Result, error) {
fmt.Printf("Tool: Searching memory for query: '%s'\n", args.Query)
// The SearchMemory function is available on the context.
searchResults, err := tctx.SearchMemory(context.Background(), args.Query)
if err != nil {
log.Printf("Error searching memory: %v", err)
return Result{}, fmt.Errorf("failed memory search")
}
var results []string
for _, res := range searchResults.Memories {
if res.Content != nil {
results = append(results, textParts(res.Content)...)
}
}
return Result{Results: results}, nil
}
// Define a tool that can search memory.
var memorySearchTool = must(functiontool.New(
functiontool.Config{
Name: "search_past_conversations",
Description: "Searches past conversations for relevant information.",
},
memorySearchToolFunc,
))
suspend fun searchWithinTool(
context: ToolContext,
args: Map<String, Any>,
): String {
val query = args["query"] as String
val response =
context.invocationContext.memoryService?.searchMemory(
appName = context.invocationContext.session.key.appName,
userId = context.invocationContext.session.key.userId,
query = query,
)
// process response
return response?.memories?.joinToString("\n") {
it.content.parts.joinToString(" ") { p -> p.text ?: "" }
} ?: ""
}
Memory Bank¶
VertexAiMemoryBankService は、会話型エージェントに高度で永続的なメモリ機能を提供するフルマネージドの Google Cloud サービスである Memory Bank にエージェントを接続します。
仕組み¶
このサービスは、2 つの主要な操作を処理します:
- メモリの生成: 会話の最後に、セッションのイベントを Memory Bank に送信できます。Memory Bank は情報をインテリジェントに処理し、「メモリ」として保存します。
- メモリの取得: エージェントコードは、Memory Bank に対して検索クエリを発行し、過去の会話から関連するメモリを取得できます。
add_memory による直接的なメモリ取り込み¶
セッション履歴からメモリを生成するだけでなく、VertexAiMemoryBankService は add_memory メソッドによる直接的なメモリ取り込みもサポートしています。このメソッドを使用すると、Memory Bank に保存されるファクトを正確に制御できます。
動作は enable_consolidation オプションによって異なります:
-
直接作成(デフォルト): デフォルトでは、
add_memoryは基盤となるmemories.createAPI を呼び出します。指定した各MemoryEntryは、個別の独立したメモリ項目として追加されます。from google.adk.memory import VertexAiMemoryBankService from google.adk.memory.memory_entry import MemoryEntry from google.genai.types import Content, Part memory_service = VertexAiMemoryBankService(...) await memory_service.add_memory( app_name="my-app", user_id="user-123", memories=[ MemoryEntry(content=Content(parts=[Part(text="The user's favorite color is blue.")])) ] ) -
統合を伴う作成(Creation with Consolidation):
custom_metadataでenable_consolidationをTrueに設定すると、サービスはmemories.generateAPI を使用します。この設定により、Memory Bank は新しいメモリ項目を既存の関連メモリとインテリジェントに統合し、重複を防いでより一貫性のあるナレッジベースを構築できます。
前提条件¶
この機能を使用する前に、次のものが必要です:
- Google Cloud プロジェクト: Agent Platform API が有効になっていること。
- Agent Runtime: Agent Platform 上で Agent Runtime を作成する必要があります。Memory Bank を使用するためにエージェントを Agent Runtime にデプロイする必要はありません。このセットアップにより、構成に必要な Agent Runtime ID が提供されます。
-
認証: ローカル環境が Google Cloud サービスにアクセスできるように認証されていることを確認します。最も簡単な方法は、次を実行することです:
-
環境変数: このサービスには、Google Cloud プロジェクト ID とロケーションが必要です。それらを環境変数として設定します:
ADK エージェントから Google Cloud に接続する方法の詳細については、Google Cloud と Agent Platform への接続を参照してください。
構成¶
エージェントを Memory Bank に接続するには、ADK サーバー(adk web または adk api_server)を起動するときに --memory_service_uri フラグを使用します。URI(Uniform Resource Identifier)は agentengine://<agent_engine_id> の形式である必要があります。
または、VertexAiMemoryBankService を手動でインスタンス化し、それを Runner に渡すことで、Memory Bank を使用するようにエージェントを構成できます。
/** Memory Bank keeps LLM-extracted memories in a Vertex AI Agent Engine. */
fun memoryBankRunner(agent: LlmAgent): InMemoryRunner {
val memoryService =
VertexAiMemoryBankService(
project = "PROJECT_ID",
location = "LOCATION",
agentEngineId = "AGENT_ENGINE_ID",
)
return InMemoryRunner(
agent = agent,
appName = "memory_bank_app",
memoryService = memoryService,
)
}
RAG メモリ¶
VertexAiRagMemoryService は、会話を Knowledge Engine に保存し、ベクトル類似度によって取得します。既存の RAG インフラストラクチャがある場合や、Memory Bank によって生成される LLM 抽出メモリではなく生のトランスクリプト取得を行いたい場合に使用します。Agent Platform SDK が必要です。
/**
* RAG memory stores whole transcripts in a Knowledge Engine corpus and retrieves them by vector
* similarity.
*/
fun ragMemoryRunner(agent: LlmAgent): InMemoryRunner {
val memoryService =
VertexAiRagMemoryService(
project = "PROJECT_ID",
location = "LOCATION",
// A bare corpus id, NOT a full resource name. Kotlin expands it to
// projects/{project}/locations/{location}/ragCorpora/{id} and rejects an
// already-expanded name -- unlike the Python tab above, which takes the full name.
ragCorpus = "CORPUS_ID",
similarityTopK = 5,
vectorDistanceThreshold = 0.6,
)
return InMemoryRunner(
agent = agent,
appName = "rag_memory_app",
memoryService = memoryService,
)
}
エージェントでのメモリの使用¶
メモリサービスが構成されている場合、エージェントはツールまたはコールバックを使用してメモリを取得できます。ADK には、メモリを取得するための 2 つの事前構築済みツールが含まれています:
- メモリの事前ロード(Preload memory): コールバックと同様に、各ターンの開始時にメモリを自動的に取得します。
- メモリのロード(Load memory): エージェントが役立つと判断したときにメモリを取得します。
例:
セッションからメモリを抽出するには、add_session_to_memory を呼び出す必要があります。たとえば、コールバックを使用してこのステップを自動化できます:
from google.adk.agents import Agent
from google.adk.tools import preload_memory
async def auto_save_session_to_memory_callback(callback_context):
await callback_context.add_session_to_memory()
agent = Agent(
model=MODEL,
name="Generic_QA_Agent",
instruction="Answer the user's questions",
tools=[preload_memory],
after_agent_callback=auto_save_session_to_memory_callback,
)
import { LlmAgent, PRELOAD_MEMORY, SingleAgentCallback } from '@google/adk';
const autoSaveSessionToMemoryCallback: SingleAgentCallback = async (callbackContext) => {
if (callbackContext.invocationContext.memoryService) {
await callbackContext.invocationContext.memoryService.addSessionToMemory(
callbackContext.invocationContext.session
);
}
};
const agent = new LlmAgent({
model: MODEL,
name: "Generic_QA_Agent",
instruction: "Answer the user's questions",
tools: [PRELOAD_MEMORY],
afterAgentCallback: autoSaveSessionToMemoryCallback,
});
ADK Go では、エージェントのコールバックからメモリサービスにアクセスできません。代わりにプラグインの AfterRunCallback からセッションを保存し、メモリサービスとともにそのプラグインをランナーに登録してください:
import (
"log"
"google.golang.org/adk/v2/agent"
"google.golang.org/adk/v2/agent/llmagent"
"google.golang.org/adk/v2/plugin"
"google.golang.org/adk/v2/runner"
"google.golang.org/adk/v2/tool"
"google.golang.org/adk/v2/tool/loadmemorytool"
)
autoSavePlugin, _ := plugin.New(plugin.Config{
Name: "auto_save_session_to_memory",
AfterRunCallback: func(ctx agent.InvocationContext) {
if m := ctx.Memory(); m != nil {
if err := m.AddSessionToMemory(ctx, ctx.Session()); err != nil {
log.Printf("failed to save session to memory: %v", err)
}
}
},
})
rootAgent, _ := llmagent.New(llmagent.Config{
Model: model,
Name: "Generic_QA_Agent",
Instruction: "Answer the user's questions",
Tools: []tool.Tool{loadmemorytool.New()},
})
r, _ := runner.New(runner.Config{
AppName: "my_app",
Agent: rootAgent,
SessionService: sessionService,
MemoryService: memoryService,
PluginConfig: runner.PluginConfig{
Plugins: []*plugin.Plugin{autoSavePlugin},
},
})
suspend fun autoSaveSessionToMemoryCallback(
context: CallbackContext,
): CallbackChoice<Unit, Content> {
context.addSessionToMemory()
return CallbackChoice.Continue(Unit)
}
fun agentWithCallback(model: Gemini) {
val agent =
LlmAgent(
model = model,
name = "Generic_QA_Agent",
instruction = Instruction("Answer the user's questions"),
tools = listOf(PreloadMemoryTool()),
afterAgentCallbacks = listOf(AfterAgentCallback(::autoSaveSessionToMemoryCallback)),
)
}
コールバックから特定のイベントまたはファクトを書き込む¶
CallbackContext.addSessionToMemory メソッドはメモリのデフォルトの動作であり、エージェントのセッション全体を保存します。より詳細な制御が必要な場合、CallbackContext は選択したイベントのサブセット用の addEventsToMemory と、自身で構築したファクト用の addMemory の 2 つの追加メソッドも提供します。どちらもオプションの customMetadata を受け入れ、現在の呼び出しからアプリ、ユーザー、セッションを自動的に補完します。
/**
* Saves a chosen set of events rather than the whole session, tagged so they can
* be filtered later. The events come from the caller: CallbackContext does not
* expose the session.
*/
suspend fun saveEventsToMemory(
context: CallbackContext,
events: List<Event>,
) {
// appName, userId and sessionId are taken from the invocation. Throws
// IllegalStateException if the runner has no memory service configured.
context.addEventsToMemory(events, customMetadata = mapOf("source" to "turn_callback"))
}
/** Writes an explicit fact, instead of letting the service derive one from events. */
suspend fun rememberPreferenceCallback(context: CallbackContext): CallbackChoice<Unit, Content> {
val preference = MemoryEntry(content = Content.fromText(Role.USER, "Prefers window seats."))
context.addMemory(listOf(preference))
return CallbackChoice.Continue(Unit)
}
3 つのメソッドはすべて、ランナーにメモリ サービスが構成されていない場合に IllegalStateException をスローするため、コンパイル時ではなく実行時に失敗します。
メモリ機能の拡張¶
BaseMemoryService を拡張したメモリ サービスは、カスタム メタデータを含め、エージェント メモリにセッションやイベントを追加することをサポートします。以下のコード例に示すように、InMemoryMemoryService などのメモリ サービスの add_session_to_memory および add_events_to_memory メソッドを使用してメモリ データを修正できます。
import asyncio
from google.adk.memory import InMemoryMemoryService
# Assume my_memory_service is an instance of InMemoryMemoryService
# and my_latest_events is a list of new adk.Event objects from the latest turn.
my_latest_events = [...]
async def update_incremental_memory(my_memory_service, my_latest_events):
# Example 1: Basic incremental update
await my_memory_service.add_events_to_memory(
app_name="my-app",
user_id="my-user",
events=my_latest_events,
session_id="my-optional-session-id"
)
# Example 2: Incremental update with Custom Metadata
await my_memory_service.add_events_to_memory(
app_name="my-app",
user_id="my-user",
events=my_latest_events,
session_id="my-optional-session-id",
custom_metadata={
"my_custom_key": "my_custom_value"
}
)
async def update_session_memory(my_memory_service, my_completed_session):
# Example 3: Applying custom metadata to a full session
await my_memory_service.add_session_to_memory(
session=my_completed_session,
custom_metadata={
"category": "user_preference"
}
)
高度な概念¶
実務におけるメモリの仕組み¶
メモリワークフローには、次のステップが含まれます:
- セッションの対話: ユーザーは
SessionServiceによって管理されるSessionを介してエージェントと対話します。この対話の間、イベントが記録され、セッション状態が更新される場合があります。 - メモリへの取り込み: セッションが終了するか、重要な情報が収集されると、アプリケーションは
memory_service.add_session_to_memory(session)を呼び出します。このアクションにより、重要なデータが抽出され、Agent Runtime Memory Bank などの長期的な知識ストアに永続化されます。 - 後のクエリ: 異なるセッション、または同じセッションで、過去のコンテキストを必要とする質問をする場合があります(例:「先週、プロジェクト X について何を話し合いましたか?」)。
- エージェントがメモリツールを使用: 組み込みの
load_memoryツールなど、メモリ取得ツールを備えたエージェントは、過去のコンテキストの必要性を認識します。ツールを呼び出し、検索クエリ(例:「discussion project X last week」)を提供します。 - 検索の実行: ツールは内部的に
memory_service.search_memory(app_name=..., user_id=..., query=...)を呼び出します。 - 結果の返却:
MemoryServiceは、キーワードマッチングまたはセマンティック検索を使用してストアを検索し、一致するスニペットを、contentとすべてのオプション項目(id、author、timestamp、custom_metadata)を保持するMemoryEntryオブジェクトのリストを含むSearchMemoryResponseとして返します。 - エージェントが結果を使用: ツールはこれらの結果をエージェントに返し、通常はコンテキストまたは関数応答の一部として返します。その後、エージェントはこの取得した情報を使用して、ユーザーへの最終的な回答を作成できます。
エージェントは複数のメモリサービスにアクセスできますか?¶
- 標準構成を介して:いいえ。 フレームワーク(
adk web、adk api_server)は、--memory_service_uriフラグを介して一度に 1 つのメモリサービスで構成するように設計されています。その単一のサービスはランナーに組み込まれ、tool_context.search_memory()およびcallback_context.search_memory()を介して公開されます。 - エージェントのコード内:はい。 2 番目の
BaseMemoryServiceをインスタンス化し、フレームワークで構成されたサービス用のToolContextをすでに持っているカスタムツールからそれを参照できます。
たとえば、エージェントは会話履歴用にフレームワークで構成された InMemoryMemoryService を使用し、別のナレッジベース用に VertexAiMemoryBankService や、ドキュメントコーパスに対する VertexAiRagMemoryService、またはその他の BaseMemoryService 実装などの 2 番目のサービスを手動でインスタンス化できます。
例:2 つのメモリサービスの使用¶
from google.adk.agents import Agent
from google.adk.memory import InMemoryMemoryService
from google.adk.tools import ToolContext
# Second memory service for docs lookup; could be any BaseMemoryService.
docs_memory = InMemoryMemoryService()
async def search_all_memory(query: str, tool_context: ToolContext) -> dict:
"""Search both the conversational memory and the docs corpus."""
conversational = await tool_context.search_memory(query)
docs = await docs_memory.search_memory(
app_name="docs", user_id="shared", query=query
)
return {
"from_conversations": [
part.text
for entry in conversational.memories
for part in (entry.content.parts or [])
if part.text
],
"from_docs": [
part.text
for entry in docs.memories
for part in (entry.content.parts or [])
if part.text
],
}
agent = Agent(
model="gemini-flash-latest",
name="multi_memory_agent",
instruction=(
"Answer questions using both your conversation history and the "
"docs knowledge base. Use the search_all_memory tool."
),
tools=[search_all_memory],
)
/**
* Example of using two memory services in Kotlin.
*/
suspend fun searchAllMemory(
toolContext: ToolContext,
query: String,
docsMemory: InMemoryMemoryService,
): Map<String, List<String>> {
// Search the conversational memory (configured in the runner)
val conversational =
toolContext.invocationContext.memoryService?.searchMemory(
appName = toolContext.invocationContext.session.key.appName,
userId = toolContext.invocationContext.session.key.userId,
query = query,
)
// Search a separate docs knowledge base
val docs =
docsMemory.searchMemory(
appName = "docs",
userId = "shared",
query = query,
)
return mapOf(
"from_conversations" to
(
conversational?.memories?.map {
it.content.parts.joinToString(" ") { p -> p.text ?: "" }
} ?: emptyList()
),
"from_docs" to
docs.memories.map {
it.content.parts.joinToString(" ") { p -> p.text ?: "" }
},
)
}
fun multiMemoryAgent(model: Gemini) {
// docs_memory could be any MemoryService implementation
val docsMemory = InMemoryMemoryService()
val agent =
LlmAgent(
model = model,
name = "multi_memory_agent",
instruction =
Instruction(
"Answer questions using both your conversation history and the " +
"docs knowledge base. Use the search_all_memory tool.",
),
// In a real app, you'd wrap searchAllMemory in a @Tool annotated class
// and pass docsMemory to its constructor.
)
}