Overview / HookTypes

HookTypes

Properties

Property	Type
afterBootstrap	(db: Readonly<objectOutputType<{ activeForms: ZodDefault<ZodSet<ZodString>>; activePlugins: ZodDefault<ZodSet<ZodString>>; activeTools: ZodDefault<ZodSet<ZodString>>; chunkOverlap: ZodDefault<ZodNumber>; chunkSize: ZodDefault<ZodNumber>; embedders: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; instantTool: ZodDefault<ZodBoolean>; llms: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; rateLimiter: ZodObject<{ checkInterval: ZodDefault<ZodNumber>; enabled: ZodDefault<ZodBoolean>; maxBucketSize: ZodDefault<ZodNumber>; tokensPerSecond: ZodDefault<ZodNumber>; }, "strip", { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }, { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }>; selectedEmbedder: ZodDefault<ZodString>; selectedLLM: ZodDefault<ZodString>; }, ZodTypeAny, "passthrough">>, cat: CheshireCat) => objectOutputType<{ activeForms: ZodDefault<ZodSet<ZodString>>; activePlugins: ZodDefault<ZodSet<ZodString>>; activeTools: ZodDefault<ZodSet<ZodString>>; chunkOverlap: ZodDefault<ZodNumber>; chunkSize: ZodDefault<ZodNumber>; embedders: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; instantTool: ZodDefault<ZodBoolean>; llms: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; rateLimiter: ZodObject<{ checkInterval: ZodDefault<ZodNumber>; enabled: ZodDefault<ZodBoolean>; maxBucketSize: ZodDefault<ZodNumber>; tokensPerSecond: ZodDefault<ZodNumber>; }, "strip", { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }, { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }>; selectedEmbedder: ZodDefault<ZodString>; selectedLLM: ZodDefault<ZodString>; }, ZodTypeAny, "passthrough">
afterInsertInMemory	(doc: Document, interaction: EmbedderInteraction, stray: StrayCat) => MaybePromise<Document>
afterMemoryChain	(output: AgentFastReply, stray: StrayCat) => MaybePromise<AgentFastReply>
afterModelInteraction	(interaction: ModelInteraction, stray: StrayCat) => ModelInteraction
afterProceduresChain	(output: AgentFastReply, stray: StrayCat) => MaybePromise<AgentFastReply>
afterRecallMemories	(memory: BetterReadonly<WorkingMemory, true>, stray: StrayCat) => MaybePromise<BetterReadonly<WorkingMemory, true>>
afterSendMessage	(msg: WSMessage, stray: StrayCat) => MaybePromise<WSMessage>
afterSplitDocs	(docs: Document[], stray: StrayCat) => MaybePromise<Document[]>
afterStoreDocuments	(docs: Document[], stray: StrayCat) => MaybePromise<Document[]>
agentFastReply	(reply: Nullable<AgentFastReply>, stray: StrayCat) => MaybePromise<Nullable<AgentFastReply>>
agentPromptInstructions	(prompt: string, stray: StrayCat) => MaybePromise<string>
agentPromptPrefix	(prefix: string, stray: StrayCat) => MaybePromise<string>
agentPromptSuffix	(suffix: string, stray: StrayCat) => MaybePromise<string>
allowedEmbedders	(embedders: EmbedderConfig[], addEmbedder: <Config>(settings) => EmbedderConfig<Config>) => EmbedderConfig<any>[]
allowedLLMs	(llms: ChatModelConfig[], addModel: <Config>(settings) => ChatModelConfig<Config>) => ChatModelConfig<any>[]
allowedTools	(tools: string[], stray: StrayCat) => MaybePromise<string[]>
beforeAgentStarts	(input: ContextInput, stray: StrayCat) => MaybePromise<ContextInput>
beforeBootstrap	(db: Readonly<objectOutputType<{ activeForms: ZodDefault<ZodSet<ZodString>>; activePlugins: ZodDefault<ZodSet<ZodString>>; activeTools: ZodDefault<ZodSet<ZodString>>; chunkOverlap: ZodDefault<ZodNumber>; chunkSize: ZodDefault<ZodNumber>; embedders: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; instantTool: ZodDefault<ZodBoolean>; llms: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; rateLimiter: ZodObject<{ checkInterval: ZodDefault<ZodNumber>; enabled: ZodDefault<ZodBoolean>; maxBucketSize: ZodDefault<ZodNumber>; tokensPerSecond: ZodDefault<ZodNumber>; }, "strip", { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }, { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }>; selectedEmbedder: ZodDefault<ZodString>; selectedLLM: ZodDefault<ZodString>; }, ZodTypeAny, "passthrough">>) => objectOutputType<{ activeForms: ZodDefault<ZodSet<ZodString>>; activePlugins: ZodDefault<ZodSet<ZodString>>; activeTools: ZodDefault<ZodSet<ZodString>>; chunkOverlap: ZodDefault<ZodNumber>; chunkSize: ZodDefault<ZodNumber>; embedders: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; instantTool: ZodDefault<ZodBoolean>; llms: ZodDefault<ZodArray<ZodObject<{ name: ZodString; value: ZodRecord<ZodAny>; }, "strip", { name: string; value: Record<string, any>; }, { name: string; value: Record<string, any>; }>>>; rateLimiter: ZodObject<{ checkInterval: ZodDefault<ZodNumber>; enabled: ZodDefault<ZodBoolean>; maxBucketSize: ZodDefault<ZodNumber>; tokensPerSecond: ZodDefault<ZodNumber>; }, "strip", { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }, { checkInterval: number; enabled: boolean; maxBucketSize: number; tokensPerSecond: number; }>; selectedEmbedder: ZodDefault<ZodString>; selectedLLM: ZodDefault<ZodString>; }, ZodTypeAny, "passthrough">
beforeInsertInMemory	(doc: Document, stray: StrayCat) => MaybePromise<Document>
beforeReadMessage	(msg: Message, stray: StrayCat) => MaybePromise<Message>
beforeRecallMemories	(configs: MemoryRecallConfigs, stray: StrayCat) => MaybePromise<MemoryRecallConfigs>
beforeSendMessage	(msg: MemoryMessage, stray: StrayCat) => MaybePromise<MemoryMessage>
beforeSplitDocs	(texts: Document[], stray: StrayCat) => MaybePromise<Document[]>
beforeStoreDocuments	(docs: Document[], stray: StrayCat) => MaybePromise<Document[]>
beforeStoreEpisodicMemory	(doc: Document, stray: StrayCat) => MaybePromise<Document>
fileParsers	(loaders: FileParsers) => FileParsers
instantToolTrigger	(input: Nullable<`${string}{name}${string}`>, stray: StrayCat) => MaybePromise<Nullable<`${string}{name}${string}`>>
memoryCollections	(collections: Record<string, VectorMemoryCollection>) => MaybePromise<Record<string, VectorMemoryCollection>>
recallQuery	(query: string, stray: StrayCat) => MaybePromise<string>
textSplitter	(splitter: TextSplitter) => TextSplitter
webParsers	(loaders: WebParser[]) => WebParser[]