MemoryEngineEmbeddingOptions

Defined in: src/lib/memoryEngine/types.ts:63 

Options for embedding generation

Supports two auth methods:

• getToken: For Privy identity tokens (uses Authorization: Bearer header)
• apiKey: For direct API keys (uses X-API-Key header)

At least one of getToken or apiKey must be provided.

Properties

apiKey?

optional apiKey: string

Defined in: src/lib/memoryEngine/types.ts:67 

Direct API key for server-side usage. Uses X-API-Key header.

baseUrl?

optional baseUrl: string

Defined in: src/lib/memoryEngine/types.ts:69 

Base URL for the API

batchSize?

optional batchSize: number

Defined in: src/lib/memoryEngine/types.ts:73 

Max texts per API call for batch embeddings (default: 100). Larger arrays are split into chunks.

cache?

optional cache: Map<string, number[]>

Defined in: src/lib/memoryEngine/types.ts:80 

Optional in-memory cache for embedding vectors. When provided, texts are looked up in this map before calling the API, and new embeddings are stored after generation. Useful when the same texts are embedded repeatedly (e.g., across eval iterations or re-indexing runs).

getToken()?

optional getToken: () => Promise<string | null>

Defined in: src/lib/memoryEngine/types.ts:65 

Function to get auth token (e.g., Privy’s getIdentityToken). Uses Authorization: Bearer header.

Returns

Promise<string | null>

model?

optional model: string

Defined in: src/lib/memoryEngine/types.ts:71 

Embedding model to use

onUsage()?

optional onUsage: (usage: object) => void

Defined in: src/lib/memoryEngine/types.ts:82 

Called after each embedding API call with the token usage from the response.

Parameters

Returns

void