Skip to content

Latest commit

 

History

History
312 lines (157 loc) · 7.29 KB

RAGKnowledgeManager.md

File metadata and controls

312 lines (157 loc) · 7.29 KB

@elizaos/core v0.25.8 / RAGKnowledgeManager

Class: RAGKnowledgeManager

Manage knowledge in the database.

Implements

Constructors

new RAGKnowledgeManager()

new RAGKnowledgeManager(opts): RAGKnowledgeManager

Constructs a new KnowledgeManager instance.

Parameters

• opts

Options for the manager.

• opts.tableName: string

The name of the table this manager will operate on.

• opts.runtime: IAgentRuntime

The AgentRuntime instance associated with this manager.

• opts.knowledgeRoot: string

Returns

RAGKnowledgeManager

Defined in

packages/core/src/ragknowledge.ts:40

Properties

runtime

runtime: IAgentRuntime

The AgentRuntime instance associated with this manager.

Implementation of

IRAGKnowledgeManager.runtime

Defined in

packages/core/src/ragknowledge.ts:22

tableName

tableName: string

The name of the database table this manager operates on.

Implementation of

IRAGKnowledgeManager.tableName

Defined in

packages/core/src/ragknowledge.ts:27

knowledgeRoot

knowledgeRoot: string

The root directory where RAG knowledge files are located (internal)

Defined in

packages/core/src/ragknowledge.ts:32

Methods

getKnowledge()

getKnowledge(params): Promise<RAGKnowledgeItem[]>

Parameters

• params

• params.query?: string

• params.id?: `${string}-${string}-${string}-${string}-${string}`

• params.conversationContext?: string

• params.limit?: number

• params.agentId?: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<RAGKnowledgeItem[]>

Implementation of

IRAGKnowledgeManager.getKnowledge

Defined in

packages/core/src/ragknowledge.ts:180

createKnowledge()

createKnowledge(item): Promise<void>

Parameters

• item: RAGKnowledgeItem

Returns

Promise<void>

Implementation of

IRAGKnowledgeManager.createKnowledge

Defined in

packages/core/src/ragknowledge.ts:289

searchKnowledge()

searchKnowledge(params): Promise<RAGKnowledgeItem[]>

Parameters

• params

• params.agentId: `${string}-${string}-${string}-${string}-${string}`

• params.embedding: number[] | Float32Array

• params.match_threshold?: number

• params.match_count?: number

• params.searchText?: string

Returns

Promise<RAGKnowledgeItem[]>

Implementation of

IRAGKnowledgeManager.searchKnowledge

Defined in

packages/core/src/ragknowledge.ts:350

removeKnowledge()

removeKnowledge(id): Promise<void>

Parameters

• id: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<void>

Implementation of

IRAGKnowledgeManager.removeKnowledge

Defined in

packages/core/src/ragknowledge.ts:377

clearKnowledge()

clearKnowledge(shared?): Promise<void>

Parameters

• shared?: boolean

Returns

Promise<void>

Implementation of

IRAGKnowledgeManager.clearKnowledge

Defined in

packages/core/src/ragknowledge.ts:381

listAllKnowledge()

listAllKnowledge(agentId): Promise<RAGKnowledgeItem[]>

Lists all knowledge entries for an agent without semantic search or reranking. Used primarily for administrative tasks like cleanup.

Parameters

• agentId: `${string}-${string}-${string}-${string}-${string}`

The agent ID to fetch knowledge entries for

Returns

Promise<RAGKnowledgeItem[]>

Array of RAGKnowledgeItem entries

Defined in

packages/core/src/ragknowledge.ts:395

cleanupDeletedKnowledgeFiles()

cleanupDeletedKnowledgeFiles(): Promise<void>

Returns

Promise<void>

Implementation of

IRAGKnowledgeManager.cleanupDeletedKnowledgeFiles

Defined in

packages/core/src/ragknowledge.ts:419

generateScopedId()

generateScopedId(path, isShared): `${string}-${string}-${string}-${string}-${string}`

Parameters

• path: string

• isShared: boolean

Returns

`${string}-${string}-${string}-${string}-${string}`

Implementation of

IRAGKnowledgeManager.generateScopedId

Defined in

packages/core/src/ragknowledge.ts:501

processFile()

processFile(file): Promise<void>

Parameters

• file

• file.path: string

• file.content: string

• file.type: "pdf" | "md" | "txt"

• file.isShared?: boolean

Returns

Promise<void>

Implementation of

IRAGKnowledgeManager.processFile

Defined in

packages/core/src/ragknowledge.ts:508