API Reference
Namespaces
| Namespace | Description |
|---|---|
| NodeJS | - |
Enumerations
| Enumeration | Description |
|---|---|
| FormState | - |
Classes
| Class | Description |
|---|---|
| AgentManager | Manager of Langchain Agent. This class manages the Agent that uses the LLM. It takes care of formatting the prompt and filtering the tools before feeding them to the Agent. It also instantiates the Langchain Agent. |
| ChatModelConfig | - |
| CheshireCat | - |
| CustomChat | - |
| CustomChatOllama | - |
| CustomChatOpenAI | - |
| CustomOpenAIEmbeddings | - |
| Database | - |
| EmbedderConfig | - |
| FakeChat | - |
| FastEmbedEmbeddings | - |
| Form | - |
| HttpError | - |
| MadHatter | - |
| ModelInteractionHandler | - |
| NewTokenHandler | - |
| Plugin | - |
| ProceduresOutputParser | - |
| RabbitHole | - |
| RateLimitHandler | - |
| StrayCat | The stray cat goes around tools and hook, making troubles |
| Tool | - |
| ToolPromptTemplate | - |
| VectorMemory | - |
| VectorMemoryCollection | - |
| WhiteRabbit | - |
Interfaces
| Interface | Description |
|---|---|
| AgentFastReply | The agent reply configuration. |
| ContextInput | The context input for the agent. |
| HookTypes | - |
| Interaction | - |
| IntermediateStep | The intermediate step of the agent. |
| MemoryJson | The accepted JSON format for an imported memory. |
| MemoryMessage | The content of a memory message. |
| MemoryRecallConfig | The configuration for memory recall. |
| MemoryRecallConfigs | The configurations for each memory recall. |
| Message | A message object sent by the user. |
| VectorMemoryCollections | The configurations for each vector memory. |
| VectorMemoryConfig | The configuration of a vector memory. |
| WorkingMemory | The working memory of the cat. |
Type Aliases
| Type alias | Description |
|---|---|
| BetterReadonly | - |
| DatabaseConfig | - |
| EmbeddedVector | - |
| EmbedderInteraction | - |
| FileParsers | - |
| Filter | - |
| FilterCondition | - |
| FilterMatch | - |
| Hook | - |
| HookNames | - |
| Hooks | - |
| InstantToolTrigger | - |
| Json | - |
| LLMInteraction | - |
| MaybePromise | - |
| MemoryDocument | A memory document. |
| ModelInteraction | - |
| Nullable | - |
| PointData | - |
| Primitive | - |
| TODO | - |
| WebParser | - |
| WS | - |
| WSMessage | A message object sent by the websocket. |
Variables
| Variable | Description |
|---|---|
| app | - |
| CatForm | - |
| CatHook | - |
| catPaths | It contains various paths and URLs used in the application. |
| CatPlugin | - |
| CatTool | - |
| chatMessage | - |
| cheshireCat | - |
| db | - |
| embedderRoutes | - |
| generalRoutes | - |
| httpError | - |
| httpLogger | - |
| llmRoutes | - |
| log | The logger module provides various logging functions. |
| LogLevel | - |
| madHatter | - |
| memoryMessage | - |
| memoryRecall | - |
| memoryRoutes | - |
| messageInput | - |
| modelInfo | - |
| parsedEnv | The parsed environment variables. |
| pluginInfo | - |
| pluginManifest | - |
| pluginSettings | - |
| pluginsRoutes | - |
| rabbitHole | Manages content ingestion. I'm late... I'm late! |
| rabbitHoleRoutes | - |
| serverContext | - |
| settingsRoutes | - |
| swaggerTags | - |
| vectorDb | - |
| whiteRabbit | I'm late, I'm late, for a very important date! |
| zodBoolean | A Zod schema for fixing coercion of boolean value. |
| zodJson | A Zod schema for JSON objects. |
| zodPrimitive | A Zod schema for primitive values. |
Functions
| Function | Description |
|---|---|
| addChatModel | - |
| addEmbeddings | - |
| catchError | Catches errors from a promise. |
| compareStrings | Compares two strings using an evaluator. |
| deepDefaults | Merges the properties of the source objects into the target object, recursively applying defaults. |
| embedderCache | - |
| existsDir | Checks if a directory exists. |
| getAllowedEmbedders | - |
| getAllowedLLMs | - |
| getEmbedder | - |
| getEmbedderSettings | - |
| getLLM | - |
| getLLMSettings | - |
| getVectorMemory | - |
| getZodDefaults | Retrieves the default values for a given Zod schema. |
| isForm | - |
| isHook | - |
| isTool | - |
| llmCache | - |
| logWelcome | Logs a welcome message and prints important URLs. |
| normalizeMessageChunks | Normalizes the content of a message chunk. |
| parseJson | Parses a JSON string using the specified Zod schema. It also cleans a few common issues with generated JSON strings. |