Overview / CheshireCat

CheshireCat

Accessors

agentManager

get agentManager(): AgentManager

Returns

AgentManager

---

currentEmbedder

get currentEmbedder(): Embeddings

Returns

Embeddings

---

currentLLM

get currentLLM(): BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>

Returns

BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>

---

embedderSize

get embedderSize(): number

Returns

number

---

rabbitHole

get rabbitHole(): RabbitHole

Returns

RabbitHole

---

vectorMemory

get vectorMemory(): VectorMemory

Returns

VectorMemory

---

whiteRabbit

get whiteRabbit(): WhiteRabbit

Returns

WhiteRabbit

Methods

addStray()

addStray(userId, ws?): StrayCat

Add a StrayCat with the given userId to the collection of strays.

Parameters

Parameter	Type	Description
userId	string	The unique identifier of the stray cat.
ws?	WS	-

Returns

StrayCat

The StrayCat instance associated with the given userId.

---

embedProcedures()

embedProcedures(): Promise<void>

Embed tools and forms into the memory.

Returns

Promise<void>

---

getStray()

getStray(userId): undefined | StrayCat

Get the StrayCat instance associated with the given userId.

Parameters

Parameter	Type	Description
userId	string	The unique identifier of the stray cat.

Returns

undefined | StrayCat

The StrayCat instance associated with the given userId.

---

loadMemory()

loadMemory(): Promise<void>

Loads the long term memory from the database.

Returns

Promise<void>

---

loadNaturalLanguage()

loadNaturalLanguage(): void

Load the Large Language Model (LLM) and the Embedder from the database. If the selected LLM or Embedder is not found, it falls back to the default one.

Returns

void

---

removeStray()

removeStray(userId): boolean

Removes a stray instance for the specified user from the collection.

Parameters

Parameter	Type	Description
userId	string	The ID of the user to remove.

Returns

boolean

True if the user was successfully removed, false otherwise.

---

getInstance()

static getInstance(): Promise<CheshireCat>

Get the Cheshire Cat instance

Returns

Promise<CheshireCat>

The Cheshire Cat class as a singleton