Skip to content

Main Navigation Home Docs API Contributors

Appearance

Sidebar Navigation

Documentation

Introduction

Getting Started

API Reference

Overview

Namespaces

NodeJS

Interfaces

ProcessEnv

Enumerations

FormState

Classes

AgentManager

ChatModelConfig

CheshireCat

CustomChat

CustomChatOllama

CustomChatOpenAI

CustomOpenAIEmbeddings

Database

EmbedderConfig

FakeChat

FastEmbedEmbeddings

Form

HttpError

MadHatter

ModelInteractionHandler

NewTokenHandler

Plugin

ProceduresOutputParser

RabbitHole

RateLimitHandler

StrayCat

Tool

ToolPromptTemplate

VectorMemory

VectorMemoryCollection

WhiteRabbit

Interfaces

AgentFastReply

ContextInput

HookTypes

Interaction

IntermediateStep

MemoryJson

MemoryMessage

MemoryRecallConfig

MemoryRecallConfigs

Message

VectorMemoryCollections

VectorMemoryConfig

WorkingMemory

Type Aliases

BetterReadonly

DatabaseConfig

EmbeddedVector

EmbedderInteraction

FileParsers

Filter

FilterCondition

FilterMatch

Hook

HookNames

Hooks

InstantToolTrigger

Json

LLMInteraction

MaybePromise

MemoryDocument

ModelInteraction

Nullable

PointData

Primitive

TODO

WebParser

WS

WSMessage

Variables

app

CatForm

CatHook

catPaths

CatPlugin

CatTool

chatMessage

cheshireCat

db

embedderRoutes

generalRoutes

httpError

httpLogger

llmRoutes

log

LogLevel

madHatter

memoryMessage

memoryRecall

memoryRoutes

messageInput

modelInfo

parsedEnv

pluginInfo

pluginManifest

pluginSettings

pluginsRoutes

rabbitHole

rabbitHoleRoutes

serverContext

settingsRoutes

swaggerTags

vectorDb

whiteRabbit

zodBoolean

zodJson

zodPrimitive

Functions

addChatModel

addEmbeddings

catchError

compareStrings

deepDefaults

embedderCache

existsDir

getAllowedEmbedders

getAllowedLLMs

getEmbedder

getEmbedderSettings

getLLM

getLLMSettings

getVectorMemory

getZodDefaults

isForm

isHook

isTool

llmCache

logWelcome

normalizeMessageChunks

parseJson

Contributors

On this page

Introduction

Welcome to the Cheshire Cat AI documentation.

This is the TypeScript version of the Cheshire Cat AI framework.

Documentation Coverage

Last updated:

Pager

Next pageGetting Started

Released under the GPL-3.0 License.

Copyright © 2024-present Daniele Nicosia & Contributors