Skip to main content

Function: getLore

getLore(params): Promise<Memory[]>

Retrieves lore from the lore database based on a search query. This function uses embedding to find similar lore entries.

Parameters

NameTypeDefault valueDescription
paramsObjectundefinedThe parameters for retrieving lore.
params.count?numberundefinedThe maximum number of lore entries to retrieve.
params.match_threshold?numberundefinedThe similarity threshold for matching lore entries, lower values mean more strict matching.
params.messagestringundefinedThe search query message to find relevant lore.
params.room_id?`${string}-${string}-${string}-${string}-${string}`zeroUuid-
params.runtimeBgentRuntimeundefinedThe runtime environment of the agent.

Returns

Promise<Memory[]>

A promise that resolves to an array of lore entries that match the search query.