Class VertexAiRagMemoryService

A memory service that uses Vertex AI RAG for storage and retrieval.

Implements

BaseMemoryService

Index

Constructors

Methods

addSessionToMemory searchMemory

Constructors

constructor

new VertexAiRagMemoryService(ragCorpus?, similarityTopK?, vectorDistanceThreshold?): VertexAiRagMemoryService
Initializes a VertexAiRagMemoryService.
Parameters
- OptionalragCorpus: string
  The name of the Vertex AI RAG corpus to use. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id} or {rag_corpus_id}
- OptionalsimilarityTopK: number
  The number of contexts to retrieve.
- vectorDistanceThreshold: number = 10
  Only returns contexts with vector distance smaller than the threshold.
Returns VertexAiRagMemoryService
- Defined in packages/adk/src/memory/vertex-ai-rag-memory-service.ts:126

Methods

addSessionToMemory

addSessionToMemory(session): Promise<void>
Adds a session to the memory service
Parameters
- session: Session
Returns Promise<void>
Implementation of BaseMemoryService.addSessionToMemory
- Defined in packages/adk/src/memory/vertex-ai-rag-memory-service.ts:141

searchMemory

searchMemory(options): Promise<SearchMemoryResponse>
Searches for sessions that match the query using rag.retrieval_query
Parameters
- options: {
      appName: string;
      userId: string;
      query: string;
  }
  - appName: string
  - userId: string
  - query: string
Returns Promise<SearchMemoryResponse>
Implementation of BaseMemoryService.searchMemory
- Defined in packages/adk/src/memory/vertex-ai-rag-memory-service.ts:201