@langchain/core 1.0.0-alpha.2 → 1.0.0-alpha.4

package/dist/callbacks/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","names":["ChainValues","BaseMessage","AgentAction","AgentFinish","ChatGenerationChunk","GenerationChunk","LLMResult","Serializable","Serialized","SerializedNotImplemented","SerializedFields","DocumentInterface","Error","BaseCallbackHandlerInput","NewTokenIndices","HandleLLMNewTokenCallbackFields","BaseCallbackHandlerMethodsClass","Record","Promise","CallbackHandlerMethods","CallbackHandlerPrefersStreaming","callbackHandlerPrefersStreaming","BaseCallbackHandler","isBaseCallbackHandler"],"sources":["../../src/callbacks/base.d.ts"],"sourcesContent":["import type { ChainValues } from \"../utils/types/index.js\";\nimport type { BaseMessage } from \"../messages/base.js\";\nimport type { AgentAction, AgentFinish } from \"../agents.js\";\nimport type { ChatGenerationChunk, GenerationChunk, LLMResult } from \"../outputs.js\";\nimport { Serializable, Serialized, SerializedNotImplemented } from \"../load/serializable.js\";\nimport type { SerializedFields } from \"../load/map_keys.js\";\nimport type { DocumentInterface } from \"../documents/document.js\";\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Error = any;\n/**\n * Interface for the input parameters of the BaseCallbackHandler class. It\n * allows to specify which types of events should be ignored by the\n * callback handler.\n */\nexport interface BaseCallbackHandlerInput {\n    ignoreLLM?: boolean;\n    ignoreChain?: boolean;\n    ignoreAgent?: boolean;\n    ignoreRetriever?: boolean;\n    ignoreCustomEvent?: boolean;\n    _awaitHandler?: boolean;\n    raiseError?: boolean;\n}\n/**\n * Interface for the indices of a new token produced by an LLM or Chat\n * Model in streaming mode.\n */\nexport interface NewTokenIndices {\n    prompt: number;\n    completion: number;\n}\n// TODO: Add all additional callback fields here\nexport type HandleLLMNewTokenCallbackFields = {\n    chunk?: GenerationChunk | ChatGenerationChunk;\n};\n/**\n * Abstract class that provides a set of optional methods that can be\n * overridden in derived classes to handle various events during the\n * execution of a LangChain application.\n */\ndeclare abstract class BaseCallbackHandlerMethodsClass {\n    /**\n     * Called at the start of an LLM or Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called when an LLM/ChatModel in `streaming` mode produces a new token\n     */\n    handleLLMNewToken?(token: string, \n    /**\n     * idx.prompt is the index of the prompt that produced the token\n     *   (if there are multiple prompts)\n     * idx.completion is the index of the completion that produced the token\n     *   (if multiple completions per prompt are requested)\n     */\n    idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if an LLM/ChatModel run encounters an error\n     */\n    handleLLMError?(err: Error, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n     */\n    handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chain run, with the chain name and inputs\n     * and the run ID.\n     */\n    handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Chain run encounters an error\n     */\n    handleChainError?(err: Error, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Chain run, with the outputs and the run ID.\n     */\n    handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Tool run, with the tool name and input\n     * and the run ID.\n     */\n    handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Tool run encounters an error\n     */\n    handleToolError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Tool run, with the tool output and the run ID.\n     */\n    handleToolEnd?(\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    output: any, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent is about to execute an action,\n     * with the action and the run ID.\n     */\n    handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent finishes execution, before it exits.\n     * with the final output and the run ID.\n     */\n    handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverEnd?(documents: DocumentInterface[], runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleCustomEvent?(eventName: string, \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    data: any, runId: string, tags?: string[], \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    metadata?: Record<string, any>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n}\n/**\n * Base interface for callbacks. All methods are optional. If a method is not\n * implemented, it will be ignored. If a method is implemented, it will be\n * called at the appropriate time. All methods are called with the run ID of\n * the LLM/ChatModel/Chain that is running, which is generated by the\n * CallbackManager.\n *\n * @interface\n */\nexport type CallbackHandlerMethods = BaseCallbackHandlerMethodsClass;\n/**\n * Interface for handlers that can indicate a preference for streaming responses.\n * When implemented, this allows the handler to signal whether it prefers to receive\n * streaming responses from language models rather than complete responses.\n */\nexport interface CallbackHandlerPrefersStreaming {\n    readonly lc_prefer_streaming: boolean;\n}\nexport declare function callbackHandlerPrefersStreaming(x: BaseCallbackHandler): unknown;\n/**\n * Abstract base class for creating callback handlers in the LangChain\n * framework. It provides a set of optional methods that can be overridden\n * in derived classes to handle various events during the execution of a\n * LangChain application.\n */\nexport declare abstract class BaseCallbackHandler extends BaseCallbackHandlerMethodsClass implements BaseCallbackHandlerInput, Serializable {\n    lc_serializable: boolean;\n    get lc_namespace(): [\"langchain_core\", \"callbacks\", string];\n    get lc_secrets(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_attributes(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_aliases(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_serializable_keys(): string[] | undefined;\n    /**\n     * The name of the serializable. Override to provide an alias or\n     * to preserve the serialized module name in minified environments.\n     *\n     * Implemented as a static method to support loading logic.\n     */\n    static lc_name(): string;\n    /**\n     * The final serialized identifier for the module.\n     */\n    get lc_id(): string[];\n    lc_kwargs: SerializedFields;\n    abstract name: string;\n    ignoreLLM: boolean;\n    ignoreChain: boolean;\n    ignoreAgent: boolean;\n    ignoreRetriever: boolean;\n    ignoreCustomEvent: boolean;\n    raiseError: boolean;\n    awaitHandlers: boolean;\n    constructor(input?: BaseCallbackHandlerInput);\n    copy(): BaseCallbackHandler;\n    toJSON(): Serialized;\n    toJSONNotImplemented(): SerializedNotImplemented;\n    static fromMethods(methods: CallbackHandlerMethods): {\n        /**\n         * Called at the start of an LLM or Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called when an LLM/ChatModel in `streaming` mode produces a new token\n         */\n        handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, fields?: HandleLLMNewTokenCallbackFields | undefined): any;\n        /**\n         * Called if an LLM/ChatModel run encounters an error\n         */\n        handleLLMError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n         */\n        handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the start of a Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called at the start of a Chain run, with the chain name and inputs\n         * and the run ID.\n         */\n        handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runType?: string | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Chain run encounters an error\n         */\n        handleChainError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the end of a Chain run, with the outputs and the run ID.\n         */\n        handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the start of a Tool run, with the tool name and input\n         * and the run ID.\n         */\n        handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Tool run encounters an error\n         */\n        handleToolError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        /**\n         * Called at the end of a Tool run, with the tool output and the run ID.\n         */\n        handleToolEnd?(output: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleText?(text: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent is about to execute an action,\n         * with the action and the run ID.\n         */\n        handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent finishes execution, before it exits.\n         * with the final output and the run ID.\n         */\n        handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, name?: string | undefined): any;\n        handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleRetrieverError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[] | undefined, metadata?: Record<string, any> | undefined): any;\n        lc_serializable: boolean;\n        readonly lc_namespace: [\"langchain_core\", \"callbacks\", string];\n        readonly lc_secrets: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_attributes: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_aliases: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_serializable_keys: string[] | undefined;\n        /**\n         * The final serialized identifier for the module.\n         */\n        readonly lc_id: string[];\n        lc_kwargs: SerializedFields;\n        ignoreLLM: boolean;\n        ignoreChain: boolean;\n        ignoreAgent: boolean;\n        ignoreRetriever: boolean;\n        ignoreCustomEvent: boolean;\n        raiseError: boolean;\n        awaitHandlers: boolean;\n        copy(): BaseCallbackHandler;\n        toJSON(): Serialized;\n        toJSONNotImplemented(): SerializedNotImplemented;\n        name: string;\n    };\n}\nexport declare const isBaseCallbackHandler: (x: unknown) => boolean;\nexport {};\n"],"mappings":";;;;;;;;;;KAQKY,KAAAA;AAF6D;AAQlE;AAaA;AAKA;;AACYP,UAnBKQ,wBAAAA,CAmBLR;EAAe,SAAGD,CAAAA,EAAAA,OAAAA;EAAmB,WAAA,CAAA,EAAA,OAAA;EAO1BY,WAAAA,CAAAA,EAAAA,OAAAA;EAA+B,eAAA,CAAA,EAAA,OAAA;EAAA,iBAK7BR,CAAAA,EAAAA,OAAAA;EAAU,aAAwES,CAAAA,EAAAA,OAAAA;EAAM,UAA+CA,CAAAA,EAAAA,OAAAA;;;;;;AAiB5DA,UAnCnFH,eAAAA,CAmCmFG;EAAM,MACtGC,EAAAA,MAAAA;EAAO,UAIeZ,EAAAA,MAAAA;;;AAMKE,KAzCnBO,+BAAAA,GAyCmBP;EAAU,KAAYP,CAAAA,EAxCzCI,eAwCyCJ,GAxCvBG,mBAwCuBH;CAAW;;;;;;uBAjCzCe,+BAAAA,CAwCnBE;EAAO;;;;EAW6B,cACvBD,CAAAA,CAAAA,GAAAA,EA/CQT,UA+CRS,EAAAA,OAAAA,EAAAA,MAAAA,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EA/C0FA,MA+C1FA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA/C+IA,MA+C/IA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EA9CbC,OAgDAA,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAO;;;EAMA,iBAIeN,CAAAA,CAAAA,KAAAA,EAAAA,MAAAA;EAAK;;;;;;EAmBQ,GAAyDM,EAlEvFJ,eAkEuFI,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAAA,CAAAA,EAlEPH,+BAkEOG,CAAAA;EAAAA;EAjE5FA,OAkEiCV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAEK,cAChDU,CAAAA,CAAAA,GAAAA,EAjEqBN,KAiErBM,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,WAAAA,CAAAA,EAjEgGD,MAiEhGC,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;EAAAA;EAhEAA,OAiE2BN,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAK;;;EAOzB,YAAA,CAAA,CAAA,MAAA,EApEeN,SAoEf,EAAA,KAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EAAA,MAAA,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,EAAA,WAAA,CAAA,EApE8FW,MAoE9F,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;EAAA;EAnEPC,OA8EQC,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAMKC;AAGjB;AAOA;;EAAiD,oBAwBlCV,CAAAA,CAAAA,GAAAA,EAjHgBF,UAiHhBE,EAAAA,QAAAA,EAjHsCT,WAiHtCS,EAAAA,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAjH0GO,MAiH1GP,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAjH+JO,MAiH/JP,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAhHXQ,OAyHoBL,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAwB;;;;EAIM,gBAKzBL,CAAAA,CAAAA,KAAAA,EA7HAA,UA6HAA,EAAAA,MAAAA,EA7HoBR,WA6HpBQ,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA7HkGS,MA6HlGT,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EA5HzBU,OA4HuHD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAIqD,gBAIxDA,CAAAA,CAAAA,GAAAA,EAhInGL,KAgImGK,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAIvF,CAJuFA,EAAAA;IAIhGX,MAAAA,CAAAA,EAnIbW,MAmIaX,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAS,CAAA,CAAA;EAA8FW;EAjIjIC,OAsI+BV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAA+K,cAK3LA,CAAAA,CAAAA,OAAAA,EAvIJR,WAuIIQ,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAA+B,CAA/BA,EAAAA;IAAoBR,MAAAA,CAAAA,EAtIpCiB,MAsIoCjB,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAW,CAAA,CAAA;EAA2FiB;EApIvJC,OAyIiBD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;;EAY8H,eASjCC,CAAAA,CAAAA,IAAAA,EAzJ7FV,UAyJ6FU,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAzJDD,MAyJCC,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAxJpHA,OA6J+BhB,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAW;;;EAK4F,eACjGM,CAAAA,CAAAA,GAAAA,EA/JfI,KA+JeJ,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EA9JrCU,OA8JyJD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAG7C,aAiBnGP,CAAAA;EAAgB;EAQA,MACjBF,EAAAA,GAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EApLdU,OAqL4BT,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAwB,UAnIEO,CAAAA,CAAAA,IAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAjD2BE,OAiD3BF,CAAAA,IAAAA,CAAAA,GAAAA,IAAAA;EAA+B;;AAAkD;AAuI3I;6BAnL+Bd,oEAAoEgB;;;;;0BAKvEf,oEAAoEe;mCAC3DV,4FAA4FS;;EAC7HC;iCAC+BP;;EAC/BO;6BAC2BN;;EAC3BM;;;;;aAKWD;;EACXC;;;;;;;;;;;KAWQC,sBAAAA,GAAyBH;;;;;;UAMpBI,+BAAAA;;;iBAGOC,+BAAAA,IAAmCC;;;;;;;uBAO7BA,mBAAAA,SAA4BN,+BAAAA,YAA2CH,0BAA0BN;;;;;;;;;;;;;;;;;;;;;;;;aAwBhHG;;;;;;;;;sBASSG;UACZS;YACEd;0BACcC;8BACIU;;;;;yBAKHX,8FAA8FS,6EAA6EA;;;;2CAIzJH,wGAAwGC;;;;0HAIzBE;;;;0BAIhGX,uGAAuGW;;;;;+BAKlGT,sBAAsBP,gFAAgFgB,6EAA6EA;;;;;6BAKrLT,oBAAoBR,sGAAsGiB;;;;;eAKtIA;;;;;6BAKYjB;eACZiB;;;;;;2BAMUT,oHAAoHS;;;;;;;;;oHAS3BC;;;;;+BAKrFhB,mGAAmGgB;;;;;4BAKtGf,mGAAmGe;qCAC1FV,oHAAoHS;mCACtHN,kBAAkBM;;4GAEuDA;;;;;;;;;;;;;;;;;eAiB7FP;;;;;;;;YAQHY;cACEd;4BACcC;;;;cAIXc"}
+{"version":3,"file":"base.d.ts","names":["ChainValues","BaseMessage","AgentAction","AgentFinish","ChatGenerationChunk","GenerationChunk","LLMResult","Serializable","Serialized","SerializedNotImplemented","SerializedFields","DocumentInterface","Error","BaseCallbackHandlerInput","NewTokenIndices","HandleLLMNewTokenCallbackFields","BaseCallbackHandlerMethodsClass","Record","Promise","CallbackHandlerMethods","CallbackHandlerPrefersStreaming","callbackHandlerPrefersStreaming","BaseCallbackHandler","___messages_message_js7","MessageStructure","MessageType","isBaseCallbackHandler"],"sources":["../../src/callbacks/base.d.ts"],"sourcesContent":["import type { ChainValues } from \"../utils/types/index.js\";\nimport type { BaseMessage } from \"../messages/base.js\";\nimport type { AgentAction, AgentFinish } from \"../agents.js\";\nimport type { ChatGenerationChunk, GenerationChunk, LLMResult } from \"../outputs.js\";\nimport { Serializable, Serialized, SerializedNotImplemented } from \"../load/serializable.js\";\nimport type { SerializedFields } from \"../load/map_keys.js\";\nimport type { DocumentInterface } from \"../documents/document.js\";\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Error = any;\n/**\n * Interface for the input parameters of the BaseCallbackHandler class. It\n * allows to specify which types of events should be ignored by the\n * callback handler.\n */\nexport interface BaseCallbackHandlerInput {\n    ignoreLLM?: boolean;\n    ignoreChain?: boolean;\n    ignoreAgent?: boolean;\n    ignoreRetriever?: boolean;\n    ignoreCustomEvent?: boolean;\n    _awaitHandler?: boolean;\n    raiseError?: boolean;\n}\n/**\n * Interface for the indices of a new token produced by an LLM or Chat\n * Model in streaming mode.\n */\nexport interface NewTokenIndices {\n    prompt: number;\n    completion: number;\n}\n// TODO: Add all additional callback fields here\nexport type HandleLLMNewTokenCallbackFields = {\n    chunk?: GenerationChunk | ChatGenerationChunk;\n};\n/**\n * Abstract class that provides a set of optional methods that can be\n * overridden in derived classes to handle various events during the\n * execution of a LangChain application.\n */\ndeclare abstract class BaseCallbackHandlerMethodsClass {\n    /**\n     * Called at the start of an LLM or Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called when an LLM/ChatModel in `streaming` mode produces a new token\n     */\n    handleLLMNewToken?(token: string, \n    /**\n     * idx.prompt is the index of the prompt that produced the token\n     *   (if there are multiple prompts)\n     * idx.completion is the index of the completion that produced the token\n     *   (if multiple completions per prompt are requested)\n     */\n    idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if an LLM/ChatModel run encounters an error\n     */\n    handleLLMError?(err: Error, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n     */\n    handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chain run, with the chain name and inputs\n     * and the run ID.\n     */\n    handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Chain run encounters an error\n     */\n    handleChainError?(err: Error, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Chain run, with the outputs and the run ID.\n     */\n    handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Tool run, with the tool name and input\n     * and the run ID.\n     */\n    handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Tool run encounters an error\n     */\n    handleToolError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Tool run, with the tool output and the run ID.\n     */\n    handleToolEnd?(\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    output: any, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent is about to execute an action,\n     * with the action and the run ID.\n     */\n    handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent finishes execution, before it exits.\n     * with the final output and the run ID.\n     */\n    handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverEnd?(documents: DocumentInterface[], runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleCustomEvent?(eventName: string, \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    data: any, runId: string, tags?: string[], \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    metadata?: Record<string, any>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n}\n/**\n * Base interface for callbacks. All methods are optional. If a method is not\n * implemented, it will be ignored. If a method is implemented, it will be\n * called at the appropriate time. All methods are called with the run ID of\n * the LLM/ChatModel/Chain that is running, which is generated by the\n * CallbackManager.\n *\n * @interface\n */\nexport type CallbackHandlerMethods = BaseCallbackHandlerMethodsClass;\n/**\n * Interface for handlers that can indicate a preference for streaming responses.\n * When implemented, this allows the handler to signal whether it prefers to receive\n * streaming responses from language models rather than complete responses.\n */\nexport interface CallbackHandlerPrefersStreaming {\n    readonly lc_prefer_streaming: boolean;\n}\nexport declare function callbackHandlerPrefersStreaming(x: BaseCallbackHandler): unknown;\n/**\n * Abstract base class for creating callback handlers in the LangChain\n * framework. It provides a set of optional methods that can be overridden\n * in derived classes to handle various events during the execution of a\n * LangChain application.\n */\nexport declare abstract class BaseCallbackHandler extends BaseCallbackHandlerMethodsClass implements BaseCallbackHandlerInput, Serializable {\n    lc_serializable: boolean;\n    get lc_namespace(): [\"langchain_core\", \"callbacks\", string];\n    get lc_secrets(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_attributes(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_aliases(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_serializable_keys(): string[] | undefined;\n    /**\n     * The name of the serializable. Override to provide an alias or\n     * to preserve the serialized module name in minified environments.\n     *\n     * Implemented as a static method to support loading logic.\n     */\n    static lc_name(): string;\n    /**\n     * The final serialized identifier for the module.\n     */\n    get lc_id(): string[];\n    lc_kwargs: SerializedFields;\n    abstract name: string;\n    ignoreLLM: boolean;\n    ignoreChain: boolean;\n    ignoreAgent: boolean;\n    ignoreRetriever: boolean;\n    ignoreCustomEvent: boolean;\n    raiseError: boolean;\n    awaitHandlers: boolean;\n    constructor(input?: BaseCallbackHandlerInput);\n    copy(): BaseCallbackHandler;\n    toJSON(): Serialized;\n    toJSONNotImplemented(): SerializedNotImplemented;\n    static fromMethods(methods: CallbackHandlerMethods): {\n        /**\n         * Called at the start of an LLM or Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called when an LLM/ChatModel in `streaming` mode produces a new token\n         */\n        handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, fields?: HandleLLMNewTokenCallbackFields | undefined): any;\n        /**\n         * Called if an LLM/ChatModel run encounters an error\n         */\n        handleLLMError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n         */\n        handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the start of a Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleChatModelStart?(llm: Serialized, messages: BaseMessage<import(\"../messages/message.js\").MessageStructure, import(\"../messages/message.js\").MessageType>[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called at the start of a Chain run, with the chain name and inputs\n         * and the run ID.\n         */\n        handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runType?: string | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Chain run encounters an error\n         */\n        handleChainError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the end of a Chain run, with the outputs and the run ID.\n         */\n        handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the start of a Tool run, with the tool name and input\n         * and the run ID.\n         */\n        handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Tool run encounters an error\n         */\n        handleToolError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        /**\n         * Called at the end of a Tool run, with the tool output and the run ID.\n         */\n        handleToolEnd?(output: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleText?(text: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent is about to execute an action,\n         * with the action and the run ID.\n         */\n        handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent finishes execution, before it exits.\n         * with the final output and the run ID.\n         */\n        handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, name?: string | undefined): any;\n        handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleRetrieverError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[] | undefined, metadata?: Record<string, any> | undefined): any;\n        lc_serializable: boolean;\n        readonly lc_namespace: [\"langchain_core\", \"callbacks\", string];\n        readonly lc_secrets: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_attributes: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_aliases: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_serializable_keys: string[] | undefined;\n        /**\n         * The final serialized identifier for the module.\n         */\n        readonly lc_id: string[];\n        lc_kwargs: SerializedFields;\n        ignoreLLM: boolean;\n        ignoreChain: boolean;\n        ignoreAgent: boolean;\n        ignoreRetriever: boolean;\n        ignoreCustomEvent: boolean;\n        raiseError: boolean;\n        awaitHandlers: boolean;\n        copy(): BaseCallbackHandler;\n        toJSON(): Serialized;\n        toJSONNotImplemented(): SerializedNotImplemented;\n        name: string;\n    };\n}\nexport declare const isBaseCallbackHandler: (x: unknown) => boolean;\nexport {};\n"],"mappings":";;;;;;;;;;;KAQKY,KAAAA;;AAF6D;AAQlE;AAaA;AAKA;AAA2C,UAlB1BC,wBAAAA,CAkB0B;EAAA,SAC/BR,CAAAA,EAAAA,OAAAA;EAAe,WAAGD,CAAAA,EAAAA,OAAAA;EAAmB,WAAA,CAAA,EAAA,OAAA;EAO1BY,eAAAA,CAAAA,EAAAA,OAAAA;EAA+B,iBAAA,CAAA,EAAA,OAAA;EAAA,aAK7BR,CAAAA,EAAAA,OAAAA;EAAU,UAAwES,CAAAA,EAAAA,OAAAA;;;;;;AAiBlFL,UAnCRE,eAAAA,CAmCQF;EAAK,MAAsEK,EAAAA,MAAAA;EAAM,UACtGC,EAAAA,MAAAA;;;AAKAA,KApCQH,+BAAAA,GAoCRG;EAAO,KAKoBV,CAAAA,EAxCnBH,eAwCmBG,GAxCDJ,mBAwCCI;CAAU;;;;;;uBAjClBQ,+BAAAA,CAuCwGC;EAAM;;;;EAQ1H,cAIkBjB,CAAAA,CAAAA,GAAAA,EA9CJQ,UA8CIR,EAAAA,OAAAA,EAAAA,MAAAA,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EA9C8EiB,MA8C9EjB,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA9CmIiB,MA8CnIjB,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EA7CzBkB,OA8CaD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAOsG,iBACzHC,CAAAA,CAAAA,KAAAA,EAAAA,MAAAA;EAAO;;;;;;EAkB+F,GAK9Ef,EAlEnBW,eAkEmBX,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAAA,CAAAA,EAlE6DY,+BAkE7DZ,CAAAA;EAAAA;EAjExBe,OAiE4FA,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAO;;;EAE5F,cACwBP,CAAAA,CAAAA,GAAAA,EAhEVC,KAgEUD,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,WAAAA,CAAAA,EAhEiEM,MAgEjEN,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;EAAAA;EA/D/BO,OAgEAA,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAO;;;EAOU,YACjBA,CAAAA,CAAAA,MAAAA,EApEsBZ,SAoEtBY,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,WAAAA,CAAAA,EApEqGD,MAoErGC,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;EAAAA;EAnEAA,OAmEO,CAAA,GAAA,CAAA,GAAA,GAAA;EAWCC;AAMZ;AAGA;AAOA;EAAiD,oBAAA,CAAA,CAAA,GAAA,EAzFlBX,UAyFkB,EAAA,QAAA,EAzFIP,WAyFJ,EAAA,EAAA,EAAA,KAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EAzFwEgB,MAyFxE,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,EAAA,QAAA,CAAA,EAzF6HA,MAyF7H,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,OAAA,CAAA,EAAA,MAAA,CAAA;EAAA;EAxF7CC,OAgHWR,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAgB;;;;EAYqB,gBACpBS,CAAAA,CAAAA,KAAAA,EAxHHX,UAwHGW,EAAAA,MAAAA,EAxHiBnB,WAwHjBmB,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAxH+FF,MAwH/FE,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAvH5BD,OA4HyBV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAIuB,gBAAyFO,CAAAA,CAAAA,GAAAA,EA5H5HH,KA4H4HG,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAInB,CAJmBA,EAAAA;IAIzBE,MAAAA,CAAAA,EA/H7GA,MA+H6GA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAM,CAAA,CAAA;EAItGX;EAjI1BY,OAiIiID,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAKyB,cAA3GhB,CAAAA,CAAAA,OAAAA,EAlI5BD,WAkI4BC,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAuL,CAAvLA,EAAAA;IAAiLgB,MAAAA,CAAAA,EAjIzNA,MAiIyNA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAM,CAAA,CAAA;EAAuEA;EA/HnTC,OAoI6BV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;;EAUC,eACvBS,CAAAA,CAAAA,IAAAA,EA1IMT,UA0INS,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA1IkGA,MA0IlGA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAzIjBC,OA+I2BV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAcK,eAAwFU,CAAAA,CAAAA,GAAAA,EAzJ5GN,KAyJ4GM,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EAxJlIA,OA6J4Bf,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAW;;;EACwH,aAC1Gc,CAAAA;EAAM;EAAP,MAEwDA,EAAAA,GAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EA1J5GC,OA2KeR,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAgB,UAQnBY,CAAAA,CAAAA,IAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAlLqEJ,OAkLrEI,CAAAA,IAAAA,CAAAA,GAAAA,IAAAA;EAAmB;;;;EAjI0F,iBAAEf,CAAAA,CAAAA,MAAAA,EA5ChGL,WA4CgGK,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EA5C5BW,OA4C4BX,CAAAA,IAAAA,CAAAA,GAAAA,IAAAA;EAAY;AAuI3I;;;0BA9K4BJ,oEAAoEe;mCAC3DV,4FAA4FS;;EAC7HC;iCAC+BP;;EAC/BO;6BAC2BN;;EAC3BM;;;;;aAKWD;;EACXC;;;;;;;;;;;KAWQC,sBAAAA,GAAyBH;;;;;;UAMpBI,+BAAAA;;;iBAGOC,+BAAAA,IAAmCC;;;;;;;uBAO7BA,mBAAAA,SAA4BN,+BAAAA,YAA2CH,0BAA0BN;;;;;;;;;;;;;;;;;;;;;;;;aAwBhHG;;;;;;;;;sBASSG;UACZS;YACEd;0BACcC;8BACIU;;;;;yBAKHX,8FAA8FS,6EAA6EA;;;;2CAIzJH,wGAAwGC;;;;0HAIzBE;;;;0BAIhGX,uGAAuGW;;;;;+BAKlGT,sBAAsBP,YAAZ,gBAAA,EAAyE,WAAA,sEAAoHgB,6EAA6EA;;;;;6BAKtRT,oBAAoBR,sGAAsGiB;;;;;eAKtIA;;;;;6BAKYjB;eACZiB;;;;;;2BAMUT,oHAAoHS;;;;;;;;;oHAS3BC;;;;;+BAKrFhB,mGAAmGgB;;;;;4BAKtGf,mGAAmGe;qCAC1FV,oHAAoHS;mCACtHN,kBAAkBM;;4GAEuDA;;;;;;;;;;;;;;;;;eAiB7FP;;;;;;;;YAQHY;cACEd;4BACcC;;;;cAIXiB"}

package/dist/callbacks/manager.d.cts

@@ -1,8 +1,8 @@
 import { AgentAction, AgentFinish } from "../agents.cjs";
 import { Serialized } from "../load/serializable.cjs";
-import { ChainValues } from "../utils/types/index.cjs";
 import { BaseMessage } from "../messages/base.cjs";
 import { LLMResult } from "../outputs.cjs";
+import { ChainValues } from "../utils/types/index.cjs";
 import { DocumentInterface } from "../documents/document.cjs";
 import { BaseCallbackHandler, CallbackHandlerMethods, HandleLLMNewTokenCallbackFields, NewTokenIndices } from "./base.cjs";
 import { LangChainTracerFields } from "../tracers/tracer_langchain.cjs";

package/dist/callbacks/manager.d.ts

@@ -1,8 +1,8 @@
 import { AgentAction, AgentFinish } from "../agents.js";
 import { Serialized } from "../load/serializable.js";
-import { ChainValues } from "../utils/types/index.js";
 import { BaseMessage } from "../messages/base.js";
 import { LLMResult } from "../outputs.js";
+import { ChainValues } from "../utils/types/index.js";
 import { DocumentInterface } from "../documents/document.js";
 import { BaseCallbackHandler, CallbackHandlerMethods, HandleLLMNewTokenCallbackFields, NewTokenIndices } from "./base.js";
 import { LangChainTracerFields } from "../tracers/tracer_langchain.js";

package/dist/document_loaders/langsmith.cjs

@@ -115,7 +115,7 @@ function _stringify(x) {
 	if (typeof x === "string") return x;
 	else try {
 		return JSON.stringify(x, null, 2);
-	} catch (error) {
+	} catch {
 		return String(x);
 	}
 }

package/dist/document_loaders/langsmith.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"langsmith.cjs","names":["BaseDocumentLoader","fields: LangSmithLoaderFields","Client","documents: DocumentInterface[]","metadata: KVMap","x: string | KVMap"],"sources":["../../src/document_loaders/langsmith.ts"],"sourcesContent":["import { KVMap } from \"langsmith/schemas\";\nimport { Client } from \"langsmith\";\nimport { Document, DocumentInterface } from \"../documents/document.js\";\nimport { AsyncCallerParams } from \"../utils/async_caller.js\";\nimport { BaseDocumentLoader } from \"./base.js\";\n\n// TODO: Replace with import from `langsmith` once exposed.\ninterface ClientConfig {\n  apiUrl?: string;\n  apiKey?: string;\n  callerOptions?: AsyncCallerParams;\n  timeout_ms?: number;\n  webUrl?: string;\n  anonymizer?: (values: KVMap) => KVMap;\n  hideInputs?: boolean | ((inputs: KVMap) => KVMap);\n  hideOutputs?: boolean | ((outputs: KVMap) => KVMap);\n  autoBatchTracing?: boolean;\n  pendingAutoBatchedRunLimit?: number;\n  fetchOptions?: RequestInit;\n}\n\nexport interface LangSmithLoaderFields {\n  datasetId?: string;\n  datasetName?: string;\n  exampleIds?: Array<string>;\n  asOf?: Date | string;\n  splits?: string[];\n  inlineS3Urls?: boolean;\n  offset?: number;\n  limit?: number;\n  metadata?: KVMap;\n  filter?: string;\n  contentKey?: string;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent?: (content: any) => string;\n  client?: Client;\n  clientConfig?: ClientConfig;\n}\n\n/**\n * Document loader integration with LangSmith.\n *\n * ## [Constructor args](https://api.js.langchain.com/interfaces/_langchain_core.document_loaders_langsmith.LangSmithLoaderFields.html)\n *\n * <details open>\n * <summary><strong>Load</strong></summary>\n *\n * ```typescript\n * import { LangSmithLoader } from '@langchain/core/document_loaders/langsmith';\n * import { Client } from 'langsmith';\n *\n * const langSmithClient = new Client({\n *   apiKey: process.env.LANGSMITH_API_KEY,\n * })\n *\n * const loader = new LangSmithLoader({\n *   datasetId: \"9a3b36f7-b308-40a5-9b46-6613853b6330\",\n *   limit: 1,\n * });\n *\n * const docs = await loader.load();\n * ```\n *\n * ```txt\n * [\n *   {\n *     pageContent: '{\\n  \"input_key_str\": \"string\",\\n  \"input_key_bool\": true\\n}',\n *     metadata: {\n *       id: '8523d9e9-c123-4b23-9b46-21021nds289e',\n *       created_at: '2024-08-19T17:09:14.806441+00:00',\n *       modified_at: '2024-08-19T17:09:14.806441+00:00',\n *       name: '#8517 @ brace-test-dataset',\n *       dataset_id: '9a3b36f7-b308-40a5-9b46-6613853b6330',\n *       source_run_id: null,\n *       metadata: [Object],\n *       inputs: [Object],\n *       outputs: [Object]\n *     }\n *   }\n * ]\n * ```\n * </details>\n */\nexport class LangSmithLoader extends BaseDocumentLoader {\n  datasetId?: string;\n\n  datasetName?: string;\n\n  exampleIds?: Array<string>;\n\n  asOf?: Date | string;\n\n  splits?: string[];\n\n  inlineS3Urls?: boolean;\n\n  offset?: number;\n\n  limit?: number;\n\n  metadata?: KVMap;\n\n  filter?: string;\n\n  contentKey: string[];\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent: (content: any) => string;\n\n  client: Client;\n\n  constructor(fields: LangSmithLoaderFields) {\n    super();\n\n    if (fields.client && fields.clientConfig) {\n      throw new Error(\"client and clientConfig cannot both be provided.\");\n    }\n    this.client = fields.client ?? new Client(fields?.clientConfig);\n    this.contentKey = fields.contentKey ? fields.contentKey.split(\".\") : [];\n    this.formatContent = fields.formatContent ?? _stringify;\n    this.datasetId = fields.datasetId;\n    this.datasetName = fields.datasetName;\n    this.exampleIds = fields.exampleIds;\n    this.asOf = fields.asOf;\n    this.splits = fields.splits;\n    this.inlineS3Urls = fields.inlineS3Urls;\n    this.offset = fields.offset;\n    this.limit = fields.limit;\n    this.metadata = fields.metadata;\n    this.filter = fields.filter;\n  }\n\n  async load(): Promise<Document[]> {\n    const documents: DocumentInterface[] = [];\n    for await (const example of this.client.listExamples({\n      datasetId: this.datasetId,\n      datasetName: this.datasetName,\n      exampleIds: this.exampleIds,\n      asOf: this.asOf,\n      splits: this.splits,\n      inlineS3Urls: this.inlineS3Urls,\n      offset: this.offset,\n      limit: this.limit,\n      metadata: this.metadata,\n      filter: this.filter,\n    })) {\n      let content = example.inputs;\n      for (const key of this.contentKey) {\n        content = content[key];\n      }\n      const contentStr = this.formatContent(content);\n\n      const metadata: KVMap = example;\n      [\"created_at\", \"modified_at\"].forEach((k) => {\n        if (k in metadata) {\n          if (typeof metadata[k] === \"object\") {\n            // Dates are of type `object`, we want to convert them to strings.\n            metadata[k] = metadata[k].toString();\n          }\n        }\n      });\n\n      documents.push({\n        pageContent: contentStr,\n        metadata,\n      });\n    }\n    return documents;\n  }\n}\n\nfunction _stringify(x: string | KVMap): string {\n  if (typeof x === \"string\") {\n    return x;\n  } else {\n    try {\n      return JSON.stringify(x, null, 2);\n    } catch (error) {\n      return String(x);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmFA,IAAa,kBAAb,cAAqCA,iDAAmB;CACtD;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAGA;CAEA;CAEA,YAAYC,QAA+B;EACzC,OAAO;AAEP,MAAI,OAAO,UAAU,OAAO,aAC1B,OAAM,IAAI,MAAM;EAElB,KAAK,SAAS,OAAO,UAAU,IAAIC,iBAAO,QAAQ;EAClD,KAAK,aAAa,OAAO,aAAa,OAAO,WAAW,MAAM,IAAI,GAAG,CAAE;EACvE,KAAK,gBAAgB,OAAO,iBAAiB;EAC7C,KAAK,YAAY,OAAO;EACxB,KAAK,cAAc,OAAO;EAC1B,KAAK,aAAa,OAAO;EACzB,KAAK,OAAO,OAAO;EACnB,KAAK,SAAS,OAAO;EACrB,KAAK,eAAe,OAAO;EAC3B,KAAK,SAAS,OAAO;EACrB,KAAK,QAAQ,OAAO;EACpB,KAAK,WAAW,OAAO;EACvB,KAAK,SAAS,OAAO;CACtB;CAED,MAAM,OAA4B;EAChC,MAAMC,YAAiC,CAAE;AACzC,aAAW,MAAM,WAAW,KAAK,OAAO,aAAa;GACnD,WAAW,KAAK;GAChB,aAAa,KAAK;GAClB,YAAY,KAAK;GACjB,MAAM,KAAK;GACX,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,QAAQ,KAAK;GACb,OAAO,KAAK;GACZ,UAAU,KAAK;GACf,QAAQ,KAAK;EACd,EAAC,EAAE;GACF,IAAI,UAAU,QAAQ;AACtB,QAAK,MAAM,OAAO,KAAK,YACrB,UAAU,QAAQ;GAEpB,MAAM,aAAa,KAAK,cAAc,QAAQ;GAE9C,MAAMC,WAAkB;GACxB,CAAC,cAAc,aAAc,EAAC,QAAQ,CAAC,MAAM;AAC3C,QAAI,KAAK,UACP;SAAI,OAAO,SAAS,OAAO,UAEzB,SAAS,KAAK,SAAS,GAAG,UAAU;IACrC;GAEJ,EAAC;GAEF,UAAU,KAAK;IACb,aAAa;IACb;GACD,EAAC;EACH;AACD,SAAO;CACR;AACF;AAED,SAAS,WAAWC,GAA2B;AAC7C,KAAI,OAAO,MAAM,SACf,QAAO;KAEP,KAAI;AACF,SAAO,KAAK,UAAU,GAAG,MAAM,EAAE;CAClC,SAAQ,OAAO;AACd,SAAO,OAAO,EAAE;CACjB;AAEJ"}
+{"version":3,"file":"langsmith.cjs","names":["BaseDocumentLoader","fields: LangSmithLoaderFields","Client","documents: DocumentInterface[]","metadata: KVMap","x: string | KVMap"],"sources":["../../src/document_loaders/langsmith.ts"],"sourcesContent":["import { KVMap } from \"langsmith/schemas\";\nimport { Client } from \"langsmith\";\nimport { Document, DocumentInterface } from \"../documents/document.js\";\nimport { AsyncCallerParams } from \"../utils/async_caller.js\";\nimport { BaseDocumentLoader } from \"./base.js\";\n\n// TODO: Replace with import from `langsmith` once exposed.\ninterface ClientConfig {\n  apiUrl?: string;\n  apiKey?: string;\n  callerOptions?: AsyncCallerParams;\n  timeout_ms?: number;\n  webUrl?: string;\n  anonymizer?: (values: KVMap) => KVMap;\n  hideInputs?: boolean | ((inputs: KVMap) => KVMap);\n  hideOutputs?: boolean | ((outputs: KVMap) => KVMap);\n  autoBatchTracing?: boolean;\n  pendingAutoBatchedRunLimit?: number;\n  fetchOptions?: RequestInit;\n}\n\nexport interface LangSmithLoaderFields {\n  datasetId?: string;\n  datasetName?: string;\n  exampleIds?: Array<string>;\n  asOf?: Date | string;\n  splits?: string[];\n  inlineS3Urls?: boolean;\n  offset?: number;\n  limit?: number;\n  metadata?: KVMap;\n  filter?: string;\n  contentKey?: string;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent?: (content: any) => string;\n  client?: Client;\n  clientConfig?: ClientConfig;\n}\n\n/**\n * Document loader integration with LangSmith.\n *\n * ## [Constructor args](https://api.js.langchain.com/interfaces/_langchain_core.document_loaders_langsmith.LangSmithLoaderFields.html)\n *\n * <details open>\n * <summary><strong>Load</strong></summary>\n *\n * ```typescript\n * import { LangSmithLoader } from '@langchain/core/document_loaders/langsmith';\n * import { Client } from 'langsmith';\n *\n * const langSmithClient = new Client({\n *   apiKey: process.env.LANGSMITH_API_KEY,\n * })\n *\n * const loader = new LangSmithLoader({\n *   datasetId: \"9a3b36f7-b308-40a5-9b46-6613853b6330\",\n *   limit: 1,\n * });\n *\n * const docs = await loader.load();\n * ```\n *\n * ```txt\n * [\n *   {\n *     pageContent: '{\\n  \"input_key_str\": \"string\",\\n  \"input_key_bool\": true\\n}',\n *     metadata: {\n *       id: '8523d9e9-c123-4b23-9b46-21021nds289e',\n *       created_at: '2024-08-19T17:09:14.806441+00:00',\n *       modified_at: '2024-08-19T17:09:14.806441+00:00',\n *       name: '#8517 @ brace-test-dataset',\n *       dataset_id: '9a3b36f7-b308-40a5-9b46-6613853b6330',\n *       source_run_id: null,\n *       metadata: [Object],\n *       inputs: [Object],\n *       outputs: [Object]\n *     }\n *   }\n * ]\n * ```\n * </details>\n */\nexport class LangSmithLoader extends BaseDocumentLoader {\n  datasetId?: string;\n\n  datasetName?: string;\n\n  exampleIds?: Array<string>;\n\n  asOf?: Date | string;\n\n  splits?: string[];\n\n  inlineS3Urls?: boolean;\n\n  offset?: number;\n\n  limit?: number;\n\n  metadata?: KVMap;\n\n  filter?: string;\n\n  contentKey: string[];\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent: (content: any) => string;\n\n  client: Client;\n\n  constructor(fields: LangSmithLoaderFields) {\n    super();\n\n    if (fields.client && fields.clientConfig) {\n      throw new Error(\"client and clientConfig cannot both be provided.\");\n    }\n    this.client = fields.client ?? new Client(fields?.clientConfig);\n    this.contentKey = fields.contentKey ? fields.contentKey.split(\".\") : [];\n    this.formatContent = fields.formatContent ?? _stringify;\n    this.datasetId = fields.datasetId;\n    this.datasetName = fields.datasetName;\n    this.exampleIds = fields.exampleIds;\n    this.asOf = fields.asOf;\n    this.splits = fields.splits;\n    this.inlineS3Urls = fields.inlineS3Urls;\n    this.offset = fields.offset;\n    this.limit = fields.limit;\n    this.metadata = fields.metadata;\n    this.filter = fields.filter;\n  }\n\n  async load(): Promise<Document[]> {\n    const documents: DocumentInterface[] = [];\n    for await (const example of this.client.listExamples({\n      datasetId: this.datasetId,\n      datasetName: this.datasetName,\n      exampleIds: this.exampleIds,\n      asOf: this.asOf,\n      splits: this.splits,\n      inlineS3Urls: this.inlineS3Urls,\n      offset: this.offset,\n      limit: this.limit,\n      metadata: this.metadata,\n      filter: this.filter,\n    })) {\n      let content = example.inputs;\n      for (const key of this.contentKey) {\n        content = content[key];\n      }\n      const contentStr = this.formatContent(content);\n\n      const metadata: KVMap = example;\n      [\"created_at\", \"modified_at\"].forEach((k) => {\n        if (k in metadata) {\n          if (typeof metadata[k] === \"object\") {\n            // Dates are of type `object`, we want to convert them to strings.\n            metadata[k] = metadata[k].toString();\n          }\n        }\n      });\n\n      documents.push({\n        pageContent: contentStr,\n        metadata,\n      });\n    }\n    return documents;\n  }\n}\n\nfunction _stringify(x: string | KVMap): string {\n  if (typeof x === \"string\") {\n    return x;\n  } else {\n    try {\n      return JSON.stringify(x, null, 2);\n    } catch {\n      return String(x);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmFA,IAAa,kBAAb,cAAqCA,iDAAmB;CACtD;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAGA;CAEA;CAEA,YAAYC,QAA+B;EACzC,OAAO;AAEP,MAAI,OAAO,UAAU,OAAO,aAC1B,OAAM,IAAI,MAAM;EAElB,KAAK,SAAS,OAAO,UAAU,IAAIC,iBAAO,QAAQ;EAClD,KAAK,aAAa,OAAO,aAAa,OAAO,WAAW,MAAM,IAAI,GAAG,CAAE;EACvE,KAAK,gBAAgB,OAAO,iBAAiB;EAC7C,KAAK,YAAY,OAAO;EACxB,KAAK,cAAc,OAAO;EAC1B,KAAK,aAAa,OAAO;EACzB,KAAK,OAAO,OAAO;EACnB,KAAK,SAAS,OAAO;EACrB,KAAK,eAAe,OAAO;EAC3B,KAAK,SAAS,OAAO;EACrB,KAAK,QAAQ,OAAO;EACpB,KAAK,WAAW,OAAO;EACvB,KAAK,SAAS,OAAO;CACtB;CAED,MAAM,OAA4B;EAChC,MAAMC,YAAiC,CAAE;AACzC,aAAW,MAAM,WAAW,KAAK,OAAO,aAAa;GACnD,WAAW,KAAK;GAChB,aAAa,KAAK;GAClB,YAAY,KAAK;GACjB,MAAM,KAAK;GACX,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,QAAQ,KAAK;GACb,OAAO,KAAK;GACZ,UAAU,KAAK;GACf,QAAQ,KAAK;EACd,EAAC,EAAE;GACF,IAAI,UAAU,QAAQ;AACtB,QAAK,MAAM,OAAO,KAAK,YACrB,UAAU,QAAQ;GAEpB,MAAM,aAAa,KAAK,cAAc,QAAQ;GAE9C,MAAMC,WAAkB;GACxB,CAAC,cAAc,aAAc,EAAC,QAAQ,CAAC,MAAM;AAC3C,QAAI,KAAK,UACP;SAAI,OAAO,SAAS,OAAO,UAEzB,SAAS,KAAK,SAAS,GAAG,UAAU;IACrC;GAEJ,EAAC;GAEF,UAAU,KAAK;IACb,aAAa;IACb;GACD,EAAC;EACH;AACD,SAAO;CACR;AACF;AAED,SAAS,WAAWC,GAA2B;AAC7C,KAAI,OAAO,MAAM,SACf,QAAO;KAEP,KAAI;AACF,SAAO,KAAK,UAAU,GAAG,MAAM,EAAE;CAClC,QAAO;AACN,SAAO,OAAO,EAAE;CACjB;AAEJ"}

package/dist/document_loaders/langsmith.js

@@ -115,7 +115,7 @@ function _stringify(x) {
 	if (typeof x === "string") return x;
 	else try {
 		return JSON.stringify(x, null, 2);
-	} catch (error) {
+	} catch {
 		return String(x);
 	}
 }

package/dist/document_loaders/langsmith.js.map

@@ -1 +1 @@
-{"version":3,"file":"langsmith.js","names":["fields: LangSmithLoaderFields","documents: DocumentInterface[]","metadata: KVMap","x: string | KVMap"],"sources":["../../src/document_loaders/langsmith.ts"],"sourcesContent":["import { KVMap } from \"langsmith/schemas\";\nimport { Client } from \"langsmith\";\nimport { Document, DocumentInterface } from \"../documents/document.js\";\nimport { AsyncCallerParams } from \"../utils/async_caller.js\";\nimport { BaseDocumentLoader } from \"./base.js\";\n\n// TODO: Replace with import from `langsmith` once exposed.\ninterface ClientConfig {\n  apiUrl?: string;\n  apiKey?: string;\n  callerOptions?: AsyncCallerParams;\n  timeout_ms?: number;\n  webUrl?: string;\n  anonymizer?: (values: KVMap) => KVMap;\n  hideInputs?: boolean | ((inputs: KVMap) => KVMap);\n  hideOutputs?: boolean | ((outputs: KVMap) => KVMap);\n  autoBatchTracing?: boolean;\n  pendingAutoBatchedRunLimit?: number;\n  fetchOptions?: RequestInit;\n}\n\nexport interface LangSmithLoaderFields {\n  datasetId?: string;\n  datasetName?: string;\n  exampleIds?: Array<string>;\n  asOf?: Date | string;\n  splits?: string[];\n  inlineS3Urls?: boolean;\n  offset?: number;\n  limit?: number;\n  metadata?: KVMap;\n  filter?: string;\n  contentKey?: string;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent?: (content: any) => string;\n  client?: Client;\n  clientConfig?: ClientConfig;\n}\n\n/**\n * Document loader integration with LangSmith.\n *\n * ## [Constructor args](https://api.js.langchain.com/interfaces/_langchain_core.document_loaders_langsmith.LangSmithLoaderFields.html)\n *\n * <details open>\n * <summary><strong>Load</strong></summary>\n *\n * ```typescript\n * import { LangSmithLoader } from '@langchain/core/document_loaders/langsmith';\n * import { Client } from 'langsmith';\n *\n * const langSmithClient = new Client({\n *   apiKey: process.env.LANGSMITH_API_KEY,\n * })\n *\n * const loader = new LangSmithLoader({\n *   datasetId: \"9a3b36f7-b308-40a5-9b46-6613853b6330\",\n *   limit: 1,\n * });\n *\n * const docs = await loader.load();\n * ```\n *\n * ```txt\n * [\n *   {\n *     pageContent: '{\\n  \"input_key_str\": \"string\",\\n  \"input_key_bool\": true\\n}',\n *     metadata: {\n *       id: '8523d9e9-c123-4b23-9b46-21021nds289e',\n *       created_at: '2024-08-19T17:09:14.806441+00:00',\n *       modified_at: '2024-08-19T17:09:14.806441+00:00',\n *       name: '#8517 @ brace-test-dataset',\n *       dataset_id: '9a3b36f7-b308-40a5-9b46-6613853b6330',\n *       source_run_id: null,\n *       metadata: [Object],\n *       inputs: [Object],\n *       outputs: [Object]\n *     }\n *   }\n * ]\n * ```\n * </details>\n */\nexport class LangSmithLoader extends BaseDocumentLoader {\n  datasetId?: string;\n\n  datasetName?: string;\n\n  exampleIds?: Array<string>;\n\n  asOf?: Date | string;\n\n  splits?: string[];\n\n  inlineS3Urls?: boolean;\n\n  offset?: number;\n\n  limit?: number;\n\n  metadata?: KVMap;\n\n  filter?: string;\n\n  contentKey: string[];\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent: (content: any) => string;\n\n  client: Client;\n\n  constructor(fields: LangSmithLoaderFields) {\n    super();\n\n    if (fields.client && fields.clientConfig) {\n      throw new Error(\"client and clientConfig cannot both be provided.\");\n    }\n    this.client = fields.client ?? new Client(fields?.clientConfig);\n    this.contentKey = fields.contentKey ? fields.contentKey.split(\".\") : [];\n    this.formatContent = fields.formatContent ?? _stringify;\n    this.datasetId = fields.datasetId;\n    this.datasetName = fields.datasetName;\n    this.exampleIds = fields.exampleIds;\n    this.asOf = fields.asOf;\n    this.splits = fields.splits;\n    this.inlineS3Urls = fields.inlineS3Urls;\n    this.offset = fields.offset;\n    this.limit = fields.limit;\n    this.metadata = fields.metadata;\n    this.filter = fields.filter;\n  }\n\n  async load(): Promise<Document[]> {\n    const documents: DocumentInterface[] = [];\n    for await (const example of this.client.listExamples({\n      datasetId: this.datasetId,\n      datasetName: this.datasetName,\n      exampleIds: this.exampleIds,\n      asOf: this.asOf,\n      splits: this.splits,\n      inlineS3Urls: this.inlineS3Urls,\n      offset: this.offset,\n      limit: this.limit,\n      metadata: this.metadata,\n      filter: this.filter,\n    })) {\n      let content = example.inputs;\n      for (const key of this.contentKey) {\n        content = content[key];\n      }\n      const contentStr = this.formatContent(content);\n\n      const metadata: KVMap = example;\n      [\"created_at\", \"modified_at\"].forEach((k) => {\n        if (k in metadata) {\n          if (typeof metadata[k] === \"object\") {\n            // Dates are of type `object`, we want to convert them to strings.\n            metadata[k] = metadata[k].toString();\n          }\n        }\n      });\n\n      documents.push({\n        pageContent: contentStr,\n        metadata,\n      });\n    }\n    return documents;\n  }\n}\n\nfunction _stringify(x: string | KVMap): string {\n  if (typeof x === \"string\") {\n    return x;\n  } else {\n    try {\n      return JSON.stringify(x, null, 2);\n    } catch (error) {\n      return String(x);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmFA,IAAa,kBAAb,cAAqC,mBAAmB;CACtD;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAGA;CAEA;CAEA,YAAYA,QAA+B;EACzC,OAAO;AAEP,MAAI,OAAO,UAAU,OAAO,aAC1B,OAAM,IAAI,MAAM;EAElB,KAAK,SAAS,OAAO,UAAU,IAAI,OAAO,QAAQ;EAClD,KAAK,aAAa,OAAO,aAAa,OAAO,WAAW,MAAM,IAAI,GAAG,CAAE;EACvE,KAAK,gBAAgB,OAAO,iBAAiB;EAC7C,KAAK,YAAY,OAAO;EACxB,KAAK,cAAc,OAAO;EAC1B,KAAK,aAAa,OAAO;EACzB,KAAK,OAAO,OAAO;EACnB,KAAK,SAAS,OAAO;EACrB,KAAK,eAAe,OAAO;EAC3B,KAAK,SAAS,OAAO;EACrB,KAAK,QAAQ,OAAO;EACpB,KAAK,WAAW,OAAO;EACvB,KAAK,SAAS,OAAO;CACtB;CAED,MAAM,OAA4B;EAChC,MAAMC,YAAiC,CAAE;AACzC,aAAW,MAAM,WAAW,KAAK,OAAO,aAAa;GACnD,WAAW,KAAK;GAChB,aAAa,KAAK;GAClB,YAAY,KAAK;GACjB,MAAM,KAAK;GACX,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,QAAQ,KAAK;GACb,OAAO,KAAK;GACZ,UAAU,KAAK;GACf,QAAQ,KAAK;EACd,EAAC,EAAE;GACF,IAAI,UAAU,QAAQ;AACtB,QAAK,MAAM,OAAO,KAAK,YACrB,UAAU,QAAQ;GAEpB,MAAM,aAAa,KAAK,cAAc,QAAQ;GAE9C,MAAMC,WAAkB;GACxB,CAAC,cAAc,aAAc,EAAC,QAAQ,CAAC,MAAM;AAC3C,QAAI,KAAK,UACP;SAAI,OAAO,SAAS,OAAO,UAEzB,SAAS,KAAK,SAAS,GAAG,UAAU;IACrC;GAEJ,EAAC;GAEF,UAAU,KAAK;IACb,aAAa;IACb;GACD,EAAC;EACH;AACD,SAAO;CACR;AACF;AAED,SAAS,WAAWC,GAA2B;AAC7C,KAAI,OAAO,MAAM,SACf,QAAO;KAEP,KAAI;AACF,SAAO,KAAK,UAAU,GAAG,MAAM,EAAE;CAClC,SAAQ,OAAO;AACd,SAAO,OAAO,EAAE;CACjB;AAEJ"}
+{"version":3,"file":"langsmith.js","names":["fields: LangSmithLoaderFields","documents: DocumentInterface[]","metadata: KVMap","x: string | KVMap"],"sources":["../../src/document_loaders/langsmith.ts"],"sourcesContent":["import { KVMap } from \"langsmith/schemas\";\nimport { Client } from \"langsmith\";\nimport { Document, DocumentInterface } from \"../documents/document.js\";\nimport { AsyncCallerParams } from \"../utils/async_caller.js\";\nimport { BaseDocumentLoader } from \"./base.js\";\n\n// TODO: Replace with import from `langsmith` once exposed.\ninterface ClientConfig {\n  apiUrl?: string;\n  apiKey?: string;\n  callerOptions?: AsyncCallerParams;\n  timeout_ms?: number;\n  webUrl?: string;\n  anonymizer?: (values: KVMap) => KVMap;\n  hideInputs?: boolean | ((inputs: KVMap) => KVMap);\n  hideOutputs?: boolean | ((outputs: KVMap) => KVMap);\n  autoBatchTracing?: boolean;\n  pendingAutoBatchedRunLimit?: number;\n  fetchOptions?: RequestInit;\n}\n\nexport interface LangSmithLoaderFields {\n  datasetId?: string;\n  datasetName?: string;\n  exampleIds?: Array<string>;\n  asOf?: Date | string;\n  splits?: string[];\n  inlineS3Urls?: boolean;\n  offset?: number;\n  limit?: number;\n  metadata?: KVMap;\n  filter?: string;\n  contentKey?: string;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent?: (content: any) => string;\n  client?: Client;\n  clientConfig?: ClientConfig;\n}\n\n/**\n * Document loader integration with LangSmith.\n *\n * ## [Constructor args](https://api.js.langchain.com/interfaces/_langchain_core.document_loaders_langsmith.LangSmithLoaderFields.html)\n *\n * <details open>\n * <summary><strong>Load</strong></summary>\n *\n * ```typescript\n * import { LangSmithLoader } from '@langchain/core/document_loaders/langsmith';\n * import { Client } from 'langsmith';\n *\n * const langSmithClient = new Client({\n *   apiKey: process.env.LANGSMITH_API_KEY,\n * })\n *\n * const loader = new LangSmithLoader({\n *   datasetId: \"9a3b36f7-b308-40a5-9b46-6613853b6330\",\n *   limit: 1,\n * });\n *\n * const docs = await loader.load();\n * ```\n *\n * ```txt\n * [\n *   {\n *     pageContent: '{\\n  \"input_key_str\": \"string\",\\n  \"input_key_bool\": true\\n}',\n *     metadata: {\n *       id: '8523d9e9-c123-4b23-9b46-21021nds289e',\n *       created_at: '2024-08-19T17:09:14.806441+00:00',\n *       modified_at: '2024-08-19T17:09:14.806441+00:00',\n *       name: '#8517 @ brace-test-dataset',\n *       dataset_id: '9a3b36f7-b308-40a5-9b46-6613853b6330',\n *       source_run_id: null,\n *       metadata: [Object],\n *       inputs: [Object],\n *       outputs: [Object]\n *     }\n *   }\n * ]\n * ```\n * </details>\n */\nexport class LangSmithLoader extends BaseDocumentLoader {\n  datasetId?: string;\n\n  datasetName?: string;\n\n  exampleIds?: Array<string>;\n\n  asOf?: Date | string;\n\n  splits?: string[];\n\n  inlineS3Urls?: boolean;\n\n  offset?: number;\n\n  limit?: number;\n\n  metadata?: KVMap;\n\n  filter?: string;\n\n  contentKey: string[];\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  formatContent: (content: any) => string;\n\n  client: Client;\n\n  constructor(fields: LangSmithLoaderFields) {\n    super();\n\n    if (fields.client && fields.clientConfig) {\n      throw new Error(\"client and clientConfig cannot both be provided.\");\n    }\n    this.client = fields.client ?? new Client(fields?.clientConfig);\n    this.contentKey = fields.contentKey ? fields.contentKey.split(\".\") : [];\n    this.formatContent = fields.formatContent ?? _stringify;\n    this.datasetId = fields.datasetId;\n    this.datasetName = fields.datasetName;\n    this.exampleIds = fields.exampleIds;\n    this.asOf = fields.asOf;\n    this.splits = fields.splits;\n    this.inlineS3Urls = fields.inlineS3Urls;\n    this.offset = fields.offset;\n    this.limit = fields.limit;\n    this.metadata = fields.metadata;\n    this.filter = fields.filter;\n  }\n\n  async load(): Promise<Document[]> {\n    const documents: DocumentInterface[] = [];\n    for await (const example of this.client.listExamples({\n      datasetId: this.datasetId,\n      datasetName: this.datasetName,\n      exampleIds: this.exampleIds,\n      asOf: this.asOf,\n      splits: this.splits,\n      inlineS3Urls: this.inlineS3Urls,\n      offset: this.offset,\n      limit: this.limit,\n      metadata: this.metadata,\n      filter: this.filter,\n    })) {\n      let content = example.inputs;\n      for (const key of this.contentKey) {\n        content = content[key];\n      }\n      const contentStr = this.formatContent(content);\n\n      const metadata: KVMap = example;\n      [\"created_at\", \"modified_at\"].forEach((k) => {\n        if (k in metadata) {\n          if (typeof metadata[k] === \"object\") {\n            // Dates are of type `object`, we want to convert them to strings.\n            metadata[k] = metadata[k].toString();\n          }\n        }\n      });\n\n      documents.push({\n        pageContent: contentStr,\n        metadata,\n      });\n    }\n    return documents;\n  }\n}\n\nfunction _stringify(x: string | KVMap): string {\n  if (typeof x === \"string\") {\n    return x;\n  } else {\n    try {\n      return JSON.stringify(x, null, 2);\n    } catch {\n      return String(x);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmFA,IAAa,kBAAb,cAAqC,mBAAmB;CACtD;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA;CAGA;CAEA;CAEA,YAAYA,QAA+B;EACzC,OAAO;AAEP,MAAI,OAAO,UAAU,OAAO,aAC1B,OAAM,IAAI,MAAM;EAElB,KAAK,SAAS,OAAO,UAAU,IAAI,OAAO,QAAQ;EAClD,KAAK,aAAa,OAAO,aAAa,OAAO,WAAW,MAAM,IAAI,GAAG,CAAE;EACvE,KAAK,gBAAgB,OAAO,iBAAiB;EAC7C,KAAK,YAAY,OAAO;EACxB,KAAK,cAAc,OAAO;EAC1B,KAAK,aAAa,OAAO;EACzB,KAAK,OAAO,OAAO;EACnB,KAAK,SAAS,OAAO;EACrB,KAAK,eAAe,OAAO;EAC3B,KAAK,SAAS,OAAO;EACrB,KAAK,QAAQ,OAAO;EACpB,KAAK,WAAW,OAAO;EACvB,KAAK,SAAS,OAAO;CACtB;CAED,MAAM,OAA4B;EAChC,MAAMC,YAAiC,CAAE;AACzC,aAAW,MAAM,WAAW,KAAK,OAAO,aAAa;GACnD,WAAW,KAAK;GAChB,aAAa,KAAK;GAClB,YAAY,KAAK;GACjB,MAAM,KAAK;GACX,QAAQ,KAAK;GACb,cAAc,KAAK;GACnB,QAAQ,KAAK;GACb,OAAO,KAAK;GACZ,UAAU,KAAK;GACf,QAAQ,KAAK;EACd,EAAC,EAAE;GACF,IAAI,UAAU,QAAQ;AACtB,QAAK,MAAM,OAAO,KAAK,YACrB,UAAU,QAAQ;GAEpB,MAAM,aAAa,KAAK,cAAc,QAAQ;GAE9C,MAAMC,WAAkB;GACxB,CAAC,cAAc,aAAc,EAAC,QAAQ,CAAC,MAAM;AAC3C,QAAI,KAAK,UACP;SAAI,OAAO,SAAS,OAAO,UAEzB,SAAS,KAAK,SAAS,GAAG,UAAU;IACrC;GAEJ,EAAC;GAEF,UAAU,KAAK;IACb,aAAa;IACb;GACD,EAAC;EACH;AACD,SAAO;CACR;AACF;AAED,SAAS,WAAWC,GAA2B;AAC7C,KAAI,OAAO,MAAM,SACf,QAAO;KAEP,KAAI;AACF,SAAO,KAAK,UAAU,GAAG,MAAM,EAAE;CAClC,QAAO;AACN,SAAO,OAAO,EAAE;CACjB;AAEJ"}

package/dist/embeddings.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"embeddings.cjs","names":["params: EmbeddingsParams","AsyncCaller"],"sources":["../src/embeddings.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\n\nexport interface EmbeddingsInterface {\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  embedDocuments(documents: string[]): Promise<number[][]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  embedQuery(document: string): Promise<number[]>;\n}\n\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport abstract class Embeddings implements EmbeddingsInterface {\n  /**\n   * The async caller should be used by subclasses to make any async calls,\n   * which will thus benefit from the concurrency and retry logic.\n   */\n  caller: AsyncCaller;\n\n  constructor(params: EmbeddingsParams) {\n    this.caller = new AsyncCaller(params ?? {});\n  }\n\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  abstract embedDocuments(documents: string[]): Promise<number[][]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  abstract embedQuery(document: string): Promise<number[]>;\n}\n"],"mappings":";;;;;;;;;;AA+BA,IAAsB,aAAtB,MAAgE;;;;;CAK9D;CAEA,YAAYA,QAA0B;EACpC,KAAK,SAAS,IAAIC,uCAAY,UAAU,CAAE;CAC3C;AAkBF"}
+{"version":3,"file":"embeddings.cjs","names":["params: EmbeddingsParams","AsyncCaller"],"sources":["../src/embeddings.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\n\nexport interface EmbeddingsInterface<TOutput = number[]> {\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  embedDocuments(documents: string[]): Promise<TOutput[]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  embedQuery(document: string): Promise<TOutput>;\n}\n\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport abstract class Embeddings<TOutput = number[]>\n  implements EmbeddingsInterface<TOutput>\n{\n  /**\n   * The async caller should be used by subclasses to make any async calls,\n   * which will thus benefit from the concurrency and retry logic.\n   */\n  caller: AsyncCaller;\n\n  constructor(params: EmbeddingsParams) {\n    this.caller = new AsyncCaller(params ?? {});\n  }\n\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  abstract embedDocuments(documents: string[]): Promise<TOutput[]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  abstract embedQuery(document: string): Promise<TOutput>;\n}\n"],"mappings":";;;;;;;;;;AA+BA,IAAsB,aAAtB,MAEA;;;;;CAKE;CAEA,YAAYA,QAA0B;EACpC,KAAK,SAAS,IAAIC,uCAAY,UAAU,CAAE;CAC3C;AAkBF"}

package/dist/embeddings.d.cts

@@ -7,7 +7,7 @@ import { AsyncCaller, AsyncCallerParams } from "./utils/async_caller.cjs";
  * class.
  */
 type EmbeddingsParams = AsyncCallerParams;
-interface EmbeddingsInterface {
+interface EmbeddingsInterface<TOutput = number[]> {
   /**
    * An abstract method that takes an array of documents as input and
    * returns a promise that resolves to an array of vectors for each
@@ -15,20 +15,20 @@ interface EmbeddingsInterface {
    * @param documents An array of documents to be embedded.
    * @returns A promise that resolves to an array of vectors for each document.
    */
-  embedDocuments(documents: string[]): Promise<number[][]>;
+  embedDocuments(documents: string[]): Promise<TOutput[]>;
   /**
    * An abstract method that takes a single document as input and returns a
    * promise that resolves to a vector for the query document.
    * @param document A single document to be embedded.
    * @returns A promise that resolves to a vector for the query document.
    */
-  embedQuery(document: string): Promise<number[]>;
+  embedQuery(document: string): Promise<TOutput>;
 }
 /**
  * An abstract class that provides methods for embedding documents and
  * queries using LangChain.
  */
-declare abstract class Embeddings implements EmbeddingsInterface {
+declare abstract class Embeddings<TOutput = number[]> implements EmbeddingsInterface<TOutput> {
   /**
    * The async caller should be used by subclasses to make any async calls,
    * which will thus benefit from the concurrency and retry logic.
@@ -42,14 +42,14 @@ declare abstract class Embeddings implements EmbeddingsInterface {
    * @param documents An array of documents to be embedded.
    * @returns A promise that resolves to an array of vectors for each document.
    */
-  abstract embedDocuments(documents: string[]): Promise<number[][]>;
+  abstract embedDocuments(documents: string[]): Promise<TOutput[]>;
   /**
    * An abstract method that takes a single document as input and returns a
    * promise that resolves to a vector for the query document.
    * @param document A single document to be embedded.
    * @returns A promise that resolves to a vector for the query document.
    */
-  abstract embedQuery(document: string): Promise<number[]>;
+  abstract embedQuery(document: string): Promise<TOutput>;
 }
 //#endregion
 export { Embeddings, EmbeddingsInterface, EmbeddingsParams };

package/dist/embeddings.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"embeddings.d.cts","names":["AsyncCaller","AsyncCallerParams","EmbeddingsParams","EmbeddingsInterface","Promise","Embeddings"],"sources":["../src/embeddings.d.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\nexport interface EmbeddingsInterface {\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    embedDocuments(documents: string[]): Promise<number[][]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    embedQuery(document: string): Promise<number[]>;\n}\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport declare abstract class Embeddings implements EmbeddingsInterface {\n    /**\n     * The async caller should be used by subclasses to make any async calls,\n     * which will thus benefit from the concurrency and retry logic.\n     */\n    caller: AsyncCaller;\n    constructor(params: EmbeddingsParams);\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    abstract embedDocuments(documents: string[]): Promise<number[][]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    abstract embedQuery(document: string): Promise<number[]>;\n}\n"],"mappings":";;;;;;AAKA;AACA;AAAoC,KADxBE,gBAAAA,GAAmBD,iBACK;AAQKG,UARxBD,mBAAAA,CAQwBC;EAAO;AAOP;AAMzC;;;;;EAcyD,cAOdA,CAAAA,SAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAlCFA,OAkCEA,CAAAA,MAAAA,EAAAA,EAAAA,CAAAA;EAAO;AArBqB;;;;;gCANrCA;;;;;;uBAMJC,UAAAA,YAAsBF;;;;;UAKxCH;sBACYE;;;;;;;;gDAQ0BE;;;;;;;yCAOPA"}
+{"version":3,"file":"embeddings.d.cts","names":["AsyncCaller","AsyncCallerParams","EmbeddingsParams","EmbeddingsInterface","TOutput","Promise","Embeddings"],"sources":["../src/embeddings.d.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\nexport interface EmbeddingsInterface<TOutput = number[]> {\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    embedDocuments(documents: string[]): Promise<TOutput[]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    embedQuery(document: string): Promise<TOutput>;\n}\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport declare abstract class Embeddings<TOutput = number[]> implements EmbeddingsInterface<TOutput> {\n    /**\n     * The async caller should be used by subclasses to make any async calls,\n     * which will thus benefit from the concurrency and retry logic.\n     */\n    caller: AsyncCaller;\n    constructor(params: EmbeddingsParams);\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    abstract embedDocuments(documents: string[]): Promise<TOutput[]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    abstract embedQuery(document: string): Promise<TOutput>;\n}\n"],"mappings":";;;;;;AAKA;AACA;AAAoC,KADxBE,gBAAAA,GAAmBD,iBACK;AAQaG,UARhCD,mBAQgCC,CAAAA,UAAAA,MAAAA,EAAAA,CAAAA,CAAAA;EAAO;;;AAOf;AAMzC;;;EAAmG,cAKvFJ,CAAAA,SAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAlB6BK,OAkB7BL,CAlBqCI,OAkBrCJ,EAAAA,CAAAA;EAAW;;;;;;EALoE,UAAA,CAAA,QAAA,EAAA,MAAA,CAAA,EANzDK,OAMyD,CANjDD,OAMiD,CAAA;;;;;;uBAA7DE,0CAA0CH,oBAAoBC;;;;;UAKhFJ;sBACYE;;;;;;;;gDAQ0BG,QAAQD;;;;;;;yCAOfC,QAAQD"}

package/dist/embeddings.d.ts

@@ -7,7 +7,7 @@ import { AsyncCaller, AsyncCallerParams } from "./utils/async_caller.js";
  * class.
  */
 type EmbeddingsParams = AsyncCallerParams;
-interface EmbeddingsInterface {
+interface EmbeddingsInterface<TOutput = number[]> {
   /**
    * An abstract method that takes an array of documents as input and
    * returns a promise that resolves to an array of vectors for each
@@ -15,20 +15,20 @@ interface EmbeddingsInterface {
    * @param documents An array of documents to be embedded.
    * @returns A promise that resolves to an array of vectors for each document.
    */
-  embedDocuments(documents: string[]): Promise<number[][]>;
+  embedDocuments(documents: string[]): Promise<TOutput[]>;
   /**
    * An abstract method that takes a single document as input and returns a
    * promise that resolves to a vector for the query document.
    * @param document A single document to be embedded.
    * @returns A promise that resolves to a vector for the query document.
    */
-  embedQuery(document: string): Promise<number[]>;
+  embedQuery(document: string): Promise<TOutput>;
 }
 /**
  * An abstract class that provides methods for embedding documents and
  * queries using LangChain.
  */
-declare abstract class Embeddings implements EmbeddingsInterface {
+declare abstract class Embeddings<TOutput = number[]> implements EmbeddingsInterface<TOutput> {
   /**
    * The async caller should be used by subclasses to make any async calls,
    * which will thus benefit from the concurrency and retry logic.
@@ -42,14 +42,14 @@ declare abstract class Embeddings implements EmbeddingsInterface {
    * @param documents An array of documents to be embedded.
    * @returns A promise that resolves to an array of vectors for each document.
    */
-  abstract embedDocuments(documents: string[]): Promise<number[][]>;
+  abstract embedDocuments(documents: string[]): Promise<TOutput[]>;
   /**
    * An abstract method that takes a single document as input and returns a
    * promise that resolves to a vector for the query document.
    * @param document A single document to be embedded.
    * @returns A promise that resolves to a vector for the query document.
    */
-  abstract embedQuery(document: string): Promise<number[]>;
+  abstract embedQuery(document: string): Promise<TOutput>;
 }
 //#endregion
 export { Embeddings, EmbeddingsInterface, EmbeddingsParams };

package/dist/embeddings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"embeddings.d.ts","names":["AsyncCaller","AsyncCallerParams","EmbeddingsParams","EmbeddingsInterface","Promise","Embeddings"],"sources":["../src/embeddings.d.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\nexport interface EmbeddingsInterface {\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    embedDocuments(documents: string[]): Promise<number[][]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    embedQuery(document: string): Promise<number[]>;\n}\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport declare abstract class Embeddings implements EmbeddingsInterface {\n    /**\n     * The async caller should be used by subclasses to make any async calls,\n     * which will thus benefit from the concurrency and retry logic.\n     */\n    caller: AsyncCaller;\n    constructor(params: EmbeddingsParams);\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    abstract embedDocuments(documents: string[]): Promise<number[][]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    abstract embedQuery(document: string): Promise<number[]>;\n}\n"],"mappings":";;;;;;AAKA;AACA;AAAoC,KADxBE,gBAAAA,GAAmBD,iBACK;AAQKG,UARxBD,mBAAAA,CAQwBC;EAAO;AAOP;AAMzC;;;;;EAcyD,cAOdA,CAAAA,SAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAlCFA,OAkCEA,CAAAA,MAAAA,EAAAA,EAAAA,CAAAA;EAAO;AArBqB;;;;;gCANrCA;;;;;;uBAMJC,UAAAA,YAAsBF;;;;;UAKxCH;sBACYE;;;;;;;;gDAQ0BE;;;;;;;yCAOPA"}
+{"version":3,"file":"embeddings.d.ts","names":["AsyncCaller","AsyncCallerParams","EmbeddingsParams","EmbeddingsInterface","TOutput","Promise","Embeddings"],"sources":["../src/embeddings.d.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\nexport interface EmbeddingsInterface<TOutput = number[]> {\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    embedDocuments(documents: string[]): Promise<TOutput[]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    embedQuery(document: string): Promise<TOutput>;\n}\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport declare abstract class Embeddings<TOutput = number[]> implements EmbeddingsInterface<TOutput> {\n    /**\n     * The async caller should be used by subclasses to make any async calls,\n     * which will thus benefit from the concurrency and retry logic.\n     */\n    caller: AsyncCaller;\n    constructor(params: EmbeddingsParams);\n    /**\n     * An abstract method that takes an array of documents as input and\n     * returns a promise that resolves to an array of vectors for each\n     * document.\n     * @param documents An array of documents to be embedded.\n     * @returns A promise that resolves to an array of vectors for each document.\n     */\n    abstract embedDocuments(documents: string[]): Promise<TOutput[]>;\n    /**\n     * An abstract method that takes a single document as input and returns a\n     * promise that resolves to a vector for the query document.\n     * @param document A single document to be embedded.\n     * @returns A promise that resolves to a vector for the query document.\n     */\n    abstract embedQuery(document: string): Promise<TOutput>;\n}\n"],"mappings":";;;;;;AAKA;AACA;AAAoC,KADxBE,gBAAAA,GAAmBD,iBACK;AAQaG,UARhCD,mBAQgCC,CAAAA,UAAAA,MAAAA,EAAAA,CAAAA,CAAAA;EAAO;;;AAOf;AAMzC;;;EAAmG,cAKvFJ,CAAAA,SAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAlB6BK,OAkB7BL,CAlBqCI,OAkBrCJ,EAAAA,CAAAA;EAAW;;;;;;EALoE,UAAA,CAAA,QAAA,EAAA,MAAA,CAAA,EANzDK,OAMyD,CANjDD,OAMiD,CAAA;;;;;;uBAA7DE,0CAA0CH,oBAAoBC;;;;;UAKhFJ;sBACYE;;;;;;;;gDAQ0BG,QAAQD;;;;;;;yCAOfC,QAAQD"}

package/dist/embeddings.js.map

@@ -1 +1 @@
-{"version":3,"file":"embeddings.js","names":["params: EmbeddingsParams"],"sources":["../src/embeddings.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\n\nexport interface EmbeddingsInterface {\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  embedDocuments(documents: string[]): Promise<number[][]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  embedQuery(document: string): Promise<number[]>;\n}\n\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport abstract class Embeddings implements EmbeddingsInterface {\n  /**\n   * The async caller should be used by subclasses to make any async calls,\n   * which will thus benefit from the concurrency and retry logic.\n   */\n  caller: AsyncCaller;\n\n  constructor(params: EmbeddingsParams) {\n    this.caller = new AsyncCaller(params ?? {});\n  }\n\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  abstract embedDocuments(documents: string[]): Promise<number[][]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  abstract embedQuery(document: string): Promise<number[]>;\n}\n"],"mappings":";;;;;;;;;;AA+BA,IAAsB,aAAtB,MAAgE;;;;;CAK9D;CAEA,YAAYA,QAA0B;EACpC,KAAK,SAAS,IAAI,YAAY,UAAU,CAAE;CAC3C;AAkBF"}
+{"version":3,"file":"embeddings.js","names":["params: EmbeddingsParams"],"sources":["../src/embeddings.ts"],"sourcesContent":["import { AsyncCaller, AsyncCallerParams } from \"./utils/async_caller.js\";\n\n/**\n * The parameters required to initialize an instance of the Embeddings\n * class.\n */\nexport type EmbeddingsParams = AsyncCallerParams;\n\nexport interface EmbeddingsInterface<TOutput = number[]> {\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  embedDocuments(documents: string[]): Promise<TOutput[]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  embedQuery(document: string): Promise<TOutput>;\n}\n\n/**\n * An abstract class that provides methods for embedding documents and\n * queries using LangChain.\n */\nexport abstract class Embeddings<TOutput = number[]>\n  implements EmbeddingsInterface<TOutput>\n{\n  /**\n   * The async caller should be used by subclasses to make any async calls,\n   * which will thus benefit from the concurrency and retry logic.\n   */\n  caller: AsyncCaller;\n\n  constructor(params: EmbeddingsParams) {\n    this.caller = new AsyncCaller(params ?? {});\n  }\n\n  /**\n   * An abstract method that takes an array of documents as input and\n   * returns a promise that resolves to an array of vectors for each\n   * document.\n   * @param documents An array of documents to be embedded.\n   * @returns A promise that resolves to an array of vectors for each document.\n   */\n  abstract embedDocuments(documents: string[]): Promise<TOutput[]>;\n\n  /**\n   * An abstract method that takes a single document as input and returns a\n   * promise that resolves to a vector for the query document.\n   * @param document A single document to be embedded.\n   * @returns A promise that resolves to a vector for the query document.\n   */\n  abstract embedQuery(document: string): Promise<TOutput>;\n}\n"],"mappings":";;;;;;;;;;AA+BA,IAAsB,aAAtB,MAEA;;;;;CAKE;CAEA,YAAYA,QAA0B;EACpC,KAAK,SAAS,IAAI,YAAY,UAAU,CAAE;CAC3C;AAkBF"}

package/dist/errors/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["error: any","lc_error_code: LangChainErrorCodes"],"sources":["../../src/errors/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n/* eslint-disable no-param-reassign */\n\nexport type LangChainErrorCodes =\n  | \"INVALID_PROMPT_INPUT\"\n  | \"INVALID_TOOL_RESULTS\"\n  | \"MESSAGE_COERCION_FAILURE\"\n  | \"MODEL_AUTHENTICATION\"\n  | \"MODEL_NOT_FOUND\"\n  | \"MODEL_RATE_LIMIT\"\n  | \"OUTPUT_PARSING_FAILURE\";\n\nexport function addLangChainErrorFields(\n  error: any,\n  lc_error_code: LangChainErrorCodes\n) {\n  (error as any).lc_error_code = lc_error_code;\n  error.message = `${error.message}\\n\\nTroubleshooting URL: https://js.langchain.com/docs/troubleshooting/errors/${lc_error_code}/\\n`;\n  return error;\n}\n"],"mappings":";;AAYA,SAAgB,wBACdA,OACAC,eACA;CACC,MAAc,gBAAgB;CAC/B,MAAM,UAAU,GAAG,MAAM,QAAQ,8EAA8E,EAAE,cAAc,GAAG,CAAC;AACnI,QAAO;AACR"}
+{"version":3,"file":"index.cjs","names":["error: any","lc_error_code: LangChainErrorCodes"],"sources":["../../src/errors/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n\nexport type LangChainErrorCodes =\n  | \"INVALID_PROMPT_INPUT\"\n  | \"INVALID_TOOL_RESULTS\"\n  | \"MESSAGE_COERCION_FAILURE\"\n  | \"MODEL_AUTHENTICATION\"\n  | \"MODEL_NOT_FOUND\"\n  | \"MODEL_RATE_LIMIT\"\n  | \"OUTPUT_PARSING_FAILURE\";\n\nexport function addLangChainErrorFields(\n  error: any,\n  lc_error_code: LangChainErrorCodes\n) {\n  (error as any).lc_error_code = lc_error_code;\n  error.message = `${error.message}\\n\\nTroubleshooting URL: https://js.langchain.com/docs/troubleshooting/errors/${lc_error_code}/\\n`;\n  return error;\n}\n"],"mappings":";;AAWA,SAAgB,wBACdA,OACAC,eACA;CACC,MAAc,gBAAgB;CAC/B,MAAM,UAAU,GAAG,MAAM,QAAQ,8EAA8E,EAAE,cAAc,GAAG,CAAC;AACnI,QAAO;AACR"}

package/dist/errors/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["error: any","lc_error_code: LangChainErrorCodes"],"sources":["../../src/errors/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n/* eslint-disable no-param-reassign */\n\nexport type LangChainErrorCodes =\n  | \"INVALID_PROMPT_INPUT\"\n  | \"INVALID_TOOL_RESULTS\"\n  | \"MESSAGE_COERCION_FAILURE\"\n  | \"MODEL_AUTHENTICATION\"\n  | \"MODEL_NOT_FOUND\"\n  | \"MODEL_RATE_LIMIT\"\n  | \"OUTPUT_PARSING_FAILURE\";\n\nexport function addLangChainErrorFields(\n  error: any,\n  lc_error_code: LangChainErrorCodes\n) {\n  (error as any).lc_error_code = lc_error_code;\n  error.message = `${error.message}\\n\\nTroubleshooting URL: https://js.langchain.com/docs/troubleshooting/errors/${lc_error_code}/\\n`;\n  return error;\n}\n"],"mappings":";AAYA,SAAgB,wBACdA,OACAC,eACA;CACC,MAAc,gBAAgB;CAC/B,MAAM,UAAU,GAAG,MAAM,QAAQ,8EAA8E,EAAE,cAAc,GAAG,CAAC;AACnI,QAAO;AACR"}
+{"version":3,"file":"index.js","names":["error: any","lc_error_code: LangChainErrorCodes"],"sources":["../../src/errors/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n\nexport type LangChainErrorCodes =\n  | \"INVALID_PROMPT_INPUT\"\n  | \"INVALID_TOOL_RESULTS\"\n  | \"MESSAGE_COERCION_FAILURE\"\n  | \"MODEL_AUTHENTICATION\"\n  | \"MODEL_NOT_FOUND\"\n  | \"MODEL_RATE_LIMIT\"\n  | \"OUTPUT_PARSING_FAILURE\";\n\nexport function addLangChainErrorFields(\n  error: any,\n  lc_error_code: LangChainErrorCodes\n) {\n  (error as any).lc_error_code = lc_error_code;\n  error.message = `${error.message}\\n\\nTroubleshooting URL: https://js.langchain.com/docs/troubleshooting/errors/${lc_error_code}/\\n`;\n  return error;\n}\n"],"mappings":";AAWA,SAAgB,wBACdA,OACAC,eACA;CACC,MAAc,gBAAgB;CAC/B,MAAM,UAAU,GAAG,MAAM,QAAQ,8EAA8E,EAAE,cAAc,GAAG,CAAC;AACnI,QAAO;AACR"}

package/dist/indexing/base.cjs

@@ -1,5 +1,5 @@
 const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
-const require_utils_js_sha1_hash = require('../utils/js-sha1/hash.cjs');
+const require_hash = require('../utils/js-sha256/hash.cjs');
 require('../utils/hash.cjs');
 const require_document = require('../documents/document.cjs');
 const require_record_manager = require('./record_manager.cjs');
@@ -18,7 +18,7 @@ var _HashedDocument = class {
 	metadataHash;
 	pageContent;
 	metadata;
-	keyEncoder = require_utils_js_sha1_hash.insecureHash;
+	keyEncoder = require_hash.sha256;
 	constructor(fields) {
 		this.uid = fields.uid;
 		this.pageContent = fields.pageContent;

package/dist/indexing/base.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"base.cjs","names":["insecureHash","fields: HashedDocumentArgs","keyEncoderFn: HashKeyEncoder","Document","document: DocumentInterface","uid?: string","inputString: string","UUIDV5_NAMESPACE","data: Record<string, unknown>","size: number","iterable: T[]","batches: T[][]","currentBatch: T[]","hashedDocuments: HashedDocumentInterface[]","deduplicated: HashedDocumentInterface[]","sourceIdKey: StringOrDocFunc | null","_doc: DocumentInterface","doc: DocumentInterface","arg: any","args: IndexArgs","index","uids: string[]","docsToIndex: DocumentInterface[]","docsToUpdate: string[]"],"sources":["../../src/indexing/base.ts"],"sourcesContent":["import { v5 as uuidv5 } from \"uuid\";\nimport { VectorStore } from \"../vectorstores.js\";\nimport { RecordManagerInterface, UUIDV5_NAMESPACE } from \"./record_manager.js\";\nimport { insecureHash, type HashKeyEncoder } from \"../utils/hash.js\";\nimport { DocumentInterface, Document } from \"../documents/document.js\";\nimport { BaseDocumentLoader } from \"../document_loaders/base.js\";\n\ntype Metadata = Record<string, unknown>;\n\ntype IndexingResult = {\n  numAdded: number;\n  numDeleted: number;\n  numUpdated: number;\n  numSkipped: number;\n};\n\ntype StringOrDocFunc = string | ((doc: DocumentInterface) => string);\n\nexport interface HashedDocumentInterface extends DocumentInterface {\n  uid: string;\n  hash_?: string;\n  contentHash?: string;\n  metadataHash?: string;\n  pageContent: string;\n  metadata: Metadata;\n  calculateHashes(): void;\n  toDocument(): DocumentInterface;\n}\n\ninterface HashedDocumentArgs {\n  pageContent: string;\n  metadata: Metadata;\n  uid: string;\n}\n\n/**\n * HashedDocument is a Document with hashes calculated.\n * Hashes are calculated based on page content and metadata.\n * It is used for indexing.\n */\nexport class _HashedDocument implements HashedDocumentInterface {\n  uid: string;\n\n  hash_?: string;\n\n  contentHash?: string;\n\n  metadataHash?: string;\n\n  pageContent: string;\n\n  metadata: Metadata;\n\n  // For backwards compatibility, we use a default key encoder\n  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning\n  // about the security implications of using SHA-1 as a key encoder.\n  private keyEncoder: HashKeyEncoder = insecureHash;\n\n  constructor(fields: HashedDocumentArgs) {\n    this.uid = fields.uid;\n    this.pageContent = fields.pageContent;\n    this.metadata = fields.metadata;\n  }\n\n  makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void {\n    this.keyEncoder = keyEncoderFn;\n  }\n\n  calculateHashes(): void {\n    const forbiddenKeys = [\"hash_\", \"content_hash\", \"metadata_hash\"];\n\n    for (const key of forbiddenKeys) {\n      if (key in this.metadata) {\n        throw new Error(\n          `Metadata cannot contain key ${key} as it is reserved for internal use. Restricted keys: [${forbiddenKeys.join(\n            \", \"\n          )}]`\n        );\n      }\n    }\n\n    const contentHash = this._hashStringToUUID(this.pageContent);\n\n    try {\n      const metadataHash = this._hashNestedDictToUUID(this.metadata);\n      this.contentHash = contentHash;\n      this.metadataHash = metadataHash;\n    } catch (e) {\n      throw new Error(\n        `Failed to hash metadata: ${e}. Please use a dict that can be serialized using json.`\n      );\n    }\n\n    this.hash_ = this._hashStringToUUID(this.contentHash + this.metadataHash);\n\n    if (!this.uid) {\n      this.uid = this.hash_;\n    }\n  }\n\n  toDocument(): DocumentInterface {\n    return new Document({\n      pageContent: this.pageContent,\n      metadata: this.metadata,\n    });\n  }\n\n  static fromDocument(\n    document: DocumentInterface,\n    uid?: string\n  ): _HashedDocument {\n    const doc = new this({\n      pageContent: document.pageContent,\n      metadata: document.metadata,\n      uid: uid || (document as DocumentInterface & { uid: string }).uid,\n    });\n    doc.calculateHashes();\n    return doc;\n  }\n\n  private _hashStringToUUID(inputString: string): string {\n    const hash_value = this.keyEncoder(inputString);\n    return uuidv5(hash_value, UUIDV5_NAMESPACE);\n  }\n\n  private _hashNestedDictToUUID(data: Record<string, unknown>): string {\n    const serialized_data = JSON.stringify(data, Object.keys(data).sort());\n    const hash_value = this.keyEncoder(serialized_data);\n    return uuidv5(hash_value, UUIDV5_NAMESPACE);\n  }\n}\n\nexport type CleanupMode = \"full\" | \"incremental\";\n\nexport type IndexOptions = {\n  /**\n   * The number of documents to index in one batch.\n   */\n  batchSize?: number;\n  /**\n   * The cleanup mode to use. Can be \"full\", \"incremental\" or undefined.\n   * - **Incremental**: Cleans up all documents that haven't been updated AND\n   *   that are associated with source ids that were seen\n   *   during indexing.\n   *   Clean up is done continuously during indexing helping\n   *   to minimize the probability of users seeing duplicated\n   *   content.\n   * - **Full**: Delete all documents that haven to been returned by the loader.\n   *   Clean up runs after all documents have been indexed.\n   *   This means that users may see duplicated content during indexing.\n   * - **undefined**: Do not delete any documents.\n   */\n  cleanup?: CleanupMode;\n  /**\n   * Optional key that helps identify the original source of the document.\n   * Must either be a string representing the key of the source in the metadata\n   * or a function that takes a document and returns a string representing the source.\n   * **Required when cleanup is incremental**.\n   */\n  sourceIdKey?: StringOrDocFunc;\n  /**\n   * Batch size to use when cleaning up documents.\n   */\n  cleanupBatchSize?: number;\n  /**\n   * Force update documents even if they are present in the\n   * record manager. Useful if you are re-indexing with updated embeddings.\n   */\n  forceUpdate?: boolean;\n};\n\nexport function _batch<T>(size: number, iterable: T[]): T[][] {\n  const batches: T[][] = [];\n  let currentBatch: T[] = [];\n\n  iterable.forEach((item) => {\n    currentBatch.push(item);\n\n    if (currentBatch.length >= size) {\n      batches.push(currentBatch);\n      currentBatch = [];\n    }\n  });\n\n  if (currentBatch.length > 0) {\n    batches.push(currentBatch);\n  }\n\n  return batches;\n}\n\nexport function _deduplicateInOrder(\n  hashedDocuments: HashedDocumentInterface[]\n): HashedDocumentInterface[] {\n  const seen = new Set<string>();\n  const deduplicated: HashedDocumentInterface[] = [];\n\n  for (const hashedDoc of hashedDocuments) {\n    if (!hashedDoc.hash_) {\n      throw new Error(\"Hashed document does not have a hash\");\n    }\n\n    if (!seen.has(hashedDoc.hash_)) {\n      seen.add(hashedDoc.hash_);\n      deduplicated.push(hashedDoc);\n    }\n  }\n  return deduplicated;\n}\n\nexport function _getSourceIdAssigner(\n  sourceIdKey: StringOrDocFunc | null\n): (doc: DocumentInterface) => string | null {\n  if (sourceIdKey === null) {\n    return (_doc: DocumentInterface) => null;\n  } else if (typeof sourceIdKey === \"string\") {\n    return (doc: DocumentInterface) => doc.metadata[sourceIdKey];\n  } else if (typeof sourceIdKey === \"function\") {\n    return sourceIdKey;\n  } else {\n    throw new Error(\n      `sourceIdKey should be null, a string or a function, got ${typeof sourceIdKey}`\n    );\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const _isBaseDocumentLoader = (arg: any): arg is BaseDocumentLoader => {\n  if (\n    \"load\" in arg &&\n    typeof arg.load === \"function\" &&\n    \"loadAndSplit\" in arg &&\n    typeof arg.loadAndSplit === \"function\"\n  ) {\n    return true;\n  }\n  return false;\n};\n\ninterface IndexArgs {\n  docsSource: BaseDocumentLoader | DocumentInterface[];\n  recordManager: RecordManagerInterface;\n  vectorStore: VectorStore;\n  options?: IndexOptions;\n}\n\n/**\n * Index data from the doc source into the vector store.\n *\n * Indexing functionality uses a manager to keep track of which documents\n * are in the vector store.\n *\n * This allows us to keep track of which documents were updated, and which\n * documents were deleted, which documents should be skipped.\n *\n * For the time being, documents are indexed using their hashes, and users\n *  are not able to specify the uid of the document.\n *\n * @param {IndexArgs} args\n * @param {BaseDocumentLoader | DocumentInterface[]} args.docsSource The source of documents to index. Can be a DocumentLoader or a list of Documents.\n * @param {RecordManagerInterface} args.recordManager The record manager to use for keeping track of indexed documents.\n * @param {VectorStore} args.vectorStore The vector store to use for storing the documents.\n * @param {IndexOptions | undefined} args.options Options for indexing.\n * @returns {Promise<IndexingResult>}\n */\nexport async function index(args: IndexArgs): Promise<IndexingResult> {\n  const { docsSource, recordManager, vectorStore, options } = args;\n  const {\n    batchSize = 100,\n    cleanup,\n    sourceIdKey,\n    cleanupBatchSize = 1000,\n    forceUpdate = false,\n  } = options ?? {};\n\n  if (cleanup === \"incremental\" && !sourceIdKey) {\n    throw new Error(\n      \"sourceIdKey is required when cleanup mode is incremental. Please provide through 'options.sourceIdKey'.\"\n    );\n  }\n\n  const docs = _isBaseDocumentLoader(docsSource)\n    ? await docsSource.load()\n    : docsSource;\n\n  const sourceIdAssigner = _getSourceIdAssigner(sourceIdKey ?? null);\n\n  const indexStartDt = await recordManager.getTime();\n  let numAdded = 0;\n  let numDeleted = 0;\n  let numUpdated = 0;\n  let numSkipped = 0;\n\n  const batches = _batch<DocumentInterface>(batchSize ?? 100, docs);\n\n  for (const batch of batches) {\n    const hashedDocs = _deduplicateInOrder(\n      batch.map((doc) => _HashedDocument.fromDocument(doc))\n    );\n\n    const sourceIds = hashedDocs.map((doc) => sourceIdAssigner(doc));\n\n    if (cleanup === \"incremental\") {\n      hashedDocs.forEach((_hashedDoc, index) => {\n        const source = sourceIds[index];\n        if (source === null) {\n          throw new Error(\n            \"sourceIdKey must be provided when cleanup is incremental\"\n          );\n        }\n      });\n    }\n\n    const batchExists = await recordManager.exists(\n      hashedDocs.map((doc) => doc.uid)\n    );\n\n    const uids: string[] = [];\n    const docsToIndex: DocumentInterface[] = [];\n    const docsToUpdate: string[] = [];\n    const seenDocs = new Set<string>();\n    hashedDocs.forEach((hashedDoc, i) => {\n      const docExists = batchExists[i];\n      if (docExists) {\n        if (forceUpdate) {\n          seenDocs.add(hashedDoc.uid);\n        } else {\n          docsToUpdate.push(hashedDoc.uid);\n          return;\n        }\n      }\n      uids.push(hashedDoc.uid);\n      docsToIndex.push(hashedDoc.toDocument());\n    });\n\n    if (docsToUpdate.length > 0) {\n      await recordManager.update(docsToUpdate, { timeAtLeast: indexStartDt });\n      numSkipped += docsToUpdate.length;\n    }\n\n    if (docsToIndex.length > 0) {\n      await vectorStore.addDocuments(docsToIndex, { ids: uids });\n      numAdded += docsToIndex.length - seenDocs.size;\n      numUpdated += seenDocs.size;\n    }\n\n    await recordManager.update(\n      hashedDocs.map((doc) => doc.uid),\n      { timeAtLeast: indexStartDt, groupIds: sourceIds }\n    );\n\n    if (cleanup === \"incremental\") {\n      sourceIds.forEach((sourceId) => {\n        if (!sourceId) throw new Error(\"Source id cannot be null\");\n      });\n      const uidsToDelete = await recordManager.listKeys({\n        before: indexStartDt,\n        groupIds: sourceIds,\n      });\n\n      if (uidsToDelete.length > 0) {\n        await vectorStore.delete({ ids: uidsToDelete });\n        await recordManager.deleteKeys(uidsToDelete);\n        numDeleted += uidsToDelete.length;\n      }\n    }\n  }\n\n  if (cleanup === \"full\") {\n    let uidsToDelete = await recordManager.listKeys({\n      before: indexStartDt,\n      limit: cleanupBatchSize,\n    });\n    while (uidsToDelete.length > 0) {\n      await vectorStore.delete({ ids: uidsToDelete });\n      await recordManager.deleteKeys(uidsToDelete);\n      numDeleted += uidsToDelete.length;\n      uidsToDelete = await recordManager.listKeys({\n        before: indexStartDt,\n        limit: cleanupBatchSize,\n      });\n    }\n  }\n\n  return {\n    numAdded,\n    numDeleted,\n    numUpdated,\n    numSkipped,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;AAwCA,IAAa,kBAAb,MAAgE;CAC9D;CAEA;CAEA;CAEA;CAEA;CAEA;CAKA,AAAQ,aAA6BA;CAErC,YAAYC,QAA4B;EACtC,KAAK,MAAM,OAAO;EAClB,KAAK,cAAc,OAAO;EAC1B,KAAK,WAAW,OAAO;CACxB;CAED,sBAAsBC,cAAoC;EACxD,KAAK,aAAa;CACnB;CAED,kBAAwB;EACtB,MAAM,gBAAgB;GAAC;GAAS;GAAgB;EAAgB;AAEhE,OAAK,MAAM,OAAO,cAChB,KAAI,OAAO,KAAK,SACd,OAAM,IAAI,MACR,CAAC,4BAA4B,EAAE,IAAI,uDAAuD,EAAE,cAAc,KACxG,KACD,CAAC,CAAC,CAAC;EAKV,MAAM,cAAc,KAAK,kBAAkB,KAAK,YAAY;AAE5D,MAAI;GACF,MAAM,eAAe,KAAK,sBAAsB,KAAK,SAAS;GAC9D,KAAK,cAAc;GACnB,KAAK,eAAe;EACrB,SAAQ,GAAG;AACV,SAAM,IAAI,MACR,CAAC,yBAAyB,EAAE,EAAE,sDAAsD,CAAC;EAExF;EAED,KAAK,QAAQ,KAAK,kBAAkB,KAAK,cAAc,KAAK,aAAa;AAEzE,MAAI,CAAC,KAAK,KACR,KAAK,MAAM,KAAK;CAEnB;CAED,aAAgC;AAC9B,SAAO,IAAIC,0BAAS;GAClB,aAAa,KAAK;GAClB,UAAU,KAAK;EAChB;CACF;CAED,OAAO,aACLC,UACAC,KACiB;EACjB,MAAM,MAAM,IAAI,KAAK;GACnB,aAAa,SAAS;GACtB,UAAU,SAAS;GACnB,KAAK,OAAQ,SAAiD;EAC/D;EACD,IAAI,iBAAiB;AACrB,SAAO;CACR;CAED,AAAQ,kBAAkBC,aAA6B;EACrD,MAAM,aAAa,KAAK,WAAW,YAAY;AAC/C,sBAAc,YAAYC,wCAAiB;CAC5C;CAED,AAAQ,sBAAsBC,MAAuC;EACnE,MAAM,kBAAkB,KAAK,UAAU,MAAM,OAAO,KAAK,KAAK,CAAC,MAAM,CAAC;EACtE,MAAM,aAAa,KAAK,WAAW,gBAAgB;AACnD,sBAAc,YAAYD,wCAAiB;CAC5C;AACF;AAyCD,SAAgB,OAAUE,MAAcC,UAAsB;CAC5D,MAAMC,UAAiB,CAAE;CACzB,IAAIC,eAAoB,CAAE;CAE1B,SAAS,QAAQ,CAAC,SAAS;EACzB,aAAa,KAAK,KAAK;AAEvB,MAAI,aAAa,UAAU,MAAM;GAC/B,QAAQ,KAAK,aAAa;GAC1B,eAAe,CAAE;EAClB;CACF,EAAC;AAEF,KAAI,aAAa,SAAS,GACxB,QAAQ,KAAK,aAAa;AAG5B,QAAO;AACR;AAED,SAAgB,oBACdC,iBAC2B;CAC3B,MAAM,uBAAO,IAAI;CACjB,MAAMC,eAA0C,CAAE;AAElD,MAAK,MAAM,aAAa,iBAAiB;AACvC,MAAI,CAAC,UAAU,MACb,OAAM,IAAI,MAAM;AAGlB,MAAI,CAAC,KAAK,IAAI,UAAU,MAAM,EAAE;GAC9B,KAAK,IAAI,UAAU,MAAM;GACzB,aAAa,KAAK,UAAU;EAC7B;CACF;AACD,QAAO;AACR;AAED,SAAgB,qBACdC,aAC2C;AAC3C,KAAI,gBAAgB,KAClB,QAAO,CAACC,SAA4B;UAC3B,OAAO,gBAAgB,SAChC,QAAO,CAACC,QAA2B,IAAI,SAAS;UACvC,OAAO,gBAAgB,WAChC,QAAO;KAEP,OAAM,IAAI,MACR,CAAC,wDAAwD,EAAE,OAAO,aAAa;AAGpF;AAGD,MAAa,wBAAwB,CAACC,QAAwC;AAC5E,KACE,UAAU,OACV,OAAO,IAAI,SAAS,cACpB,kBAAkB,OAClB,OAAO,IAAI,iBAAiB,WAE5B,QAAO;AAET,QAAO;AACR;;;;;;;;;;;;;;;;;;;;AA4BD,eAAsB,MAAMC,MAA0C;CACpE,MAAM,EAAE,YAAY,eAAe,aAAa,SAAS,GAAG;CAC5D,MAAM,EACJ,YAAY,KACZ,SACA,aACA,mBAAmB,KACnB,cAAc,OACf,GAAG,WAAW,CAAE;AAEjB,KAAI,YAAY,iBAAiB,CAAC,YAChC,OAAM,IAAI,MACR;CAIJ,MAAM,OAAO,sBAAsB,WAAW,GAC1C,MAAM,WAAW,MAAM,GACvB;CAEJ,MAAM,mBAAmB,qBAAqB,eAAe,KAAK;CAElE,MAAM,eAAe,MAAM,cAAc,SAAS;CAClD,IAAI,WAAW;CACf,IAAI,aAAa;CACjB,IAAI,aAAa;CACjB,IAAI,aAAa;CAEjB,MAAM,UAAU,OAA0B,aAAa,KAAK,KAAK;AAEjE,MAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,aAAa,oBACjB,MAAM,IAAI,CAAC,QAAQ,gBAAgB,aAAa,IAAI,CAAC,CACtD;EAED,MAAM,YAAY,WAAW,IAAI,CAAC,QAAQ,iBAAiB,IAAI,CAAC;AAEhE,MAAI,YAAY,eACd,WAAW,QAAQ,CAAC,YAAYC,YAAU;GACxC,MAAM,SAAS,UAAUA;AACzB,OAAI,WAAW,KACb,OAAM,IAAI,MACR;EAGL,EAAC;EAGJ,MAAM,cAAc,MAAM,cAAc,OACtC,WAAW,IAAI,CAAC,QAAQ,IAAI,IAAI,CACjC;EAED,MAAMC,OAAiB,CAAE;EACzB,MAAMC,cAAmC,CAAE;EAC3C,MAAMC,eAAyB,CAAE;EACjC,MAAM,2BAAW,IAAI;EACrB,WAAW,QAAQ,CAAC,WAAW,MAAM;GACnC,MAAM,YAAY,YAAY;AAC9B,OAAI,UACF,KAAI,aACF,SAAS,IAAI,UAAU,IAAI;QACtB;IACL,aAAa,KAAK,UAAU,IAAI;AAChC;GACD;GAEH,KAAK,KAAK,UAAU,IAAI;GACxB,YAAY,KAAK,UAAU,YAAY,CAAC;EACzC,EAAC;AAEF,MAAI,aAAa,SAAS,GAAG;GAC3B,MAAM,cAAc,OAAO,cAAc,EAAE,aAAa,aAAc,EAAC;GACvE,cAAc,aAAa;EAC5B;AAED,MAAI,YAAY,SAAS,GAAG;GAC1B,MAAM,YAAY,aAAa,aAAa,EAAE,KAAK,KAAM,EAAC;GAC1D,YAAY,YAAY,SAAS,SAAS;GAC1C,cAAc,SAAS;EACxB;EAED,MAAM,cAAc,OAClB,WAAW,IAAI,CAAC,QAAQ,IAAI,IAAI,EAChC;GAAE,aAAa;GAAc,UAAU;EAAW,EACnD;AAED,MAAI,YAAY,eAAe;GAC7B,UAAU,QAAQ,CAAC,aAAa;AAC9B,QAAI,CAAC,SAAU,OAAM,IAAI,MAAM;GAChC,EAAC;GACF,MAAM,eAAe,MAAM,cAAc,SAAS;IAChD,QAAQ;IACR,UAAU;GACX,EAAC;AAEF,OAAI,aAAa,SAAS,GAAG;IAC3B,MAAM,YAAY,OAAO,EAAE,KAAK,aAAc,EAAC;IAC/C,MAAM,cAAc,WAAW,aAAa;IAC5C,cAAc,aAAa;GAC5B;EACF;CACF;AAED,KAAI,YAAY,QAAQ;EACtB,IAAI,eAAe,MAAM,cAAc,SAAS;GAC9C,QAAQ;GACR,OAAO;EACR,EAAC;AACF,SAAO,aAAa,SAAS,GAAG;GAC9B,MAAM,YAAY,OAAO,EAAE,KAAK,aAAc,EAAC;GAC/C,MAAM,cAAc,WAAW,aAAa;GAC5C,cAAc,aAAa;GAC3B,eAAe,MAAM,cAAc,SAAS;IAC1C,QAAQ;IACR,OAAO;GACR,EAAC;EACH;CACF;AAED,QAAO;EACL;EACA;EACA;EACA;CACD;AACF"}
+{"version":3,"file":"base.cjs","names":["sha256","fields: HashedDocumentArgs","keyEncoderFn: HashKeyEncoder","Document","document: DocumentInterface","uid?: string","inputString: string","UUIDV5_NAMESPACE","data: Record<string, unknown>","size: number","iterable: T[]","batches: T[][]","currentBatch: T[]","hashedDocuments: HashedDocumentInterface[]","deduplicated: HashedDocumentInterface[]","sourceIdKey: StringOrDocFunc | null","_doc: DocumentInterface","doc: DocumentInterface","arg: any","args: IndexArgs","index","uids: string[]","docsToIndex: DocumentInterface[]","docsToUpdate: string[]"],"sources":["../../src/indexing/base.ts"],"sourcesContent":["import { v5 as uuidv5 } from \"uuid\";\nimport { VectorStore } from \"../vectorstores.js\";\nimport { RecordManagerInterface, UUIDV5_NAMESPACE } from \"./record_manager.js\";\nimport { sha256, type HashKeyEncoder } from \"../utils/hash.js\";\nimport { DocumentInterface, Document } from \"../documents/document.js\";\nimport { BaseDocumentLoader } from \"../document_loaders/base.js\";\n\ntype Metadata = Record<string, unknown>;\n\ntype IndexingResult = {\n  numAdded: number;\n  numDeleted: number;\n  numUpdated: number;\n  numSkipped: number;\n};\n\ntype StringOrDocFunc = string | ((doc: DocumentInterface) => string);\n\nexport interface HashedDocumentInterface extends DocumentInterface {\n  uid: string;\n  hash_?: string;\n  contentHash?: string;\n  metadataHash?: string;\n  pageContent: string;\n  metadata: Metadata;\n  calculateHashes(): void;\n  toDocument(): DocumentInterface;\n}\n\ninterface HashedDocumentArgs {\n  pageContent: string;\n  metadata: Metadata;\n  uid: string;\n}\n\n/**\n * HashedDocument is a Document with hashes calculated.\n * Hashes are calculated based on page content and metadata.\n * It is used for indexing.\n */\nexport class _HashedDocument implements HashedDocumentInterface {\n  uid: string;\n\n  hash_?: string;\n\n  contentHash?: string;\n\n  metadataHash?: string;\n\n  pageContent: string;\n\n  metadata: Metadata;\n\n  private keyEncoder: HashKeyEncoder = sha256;\n\n  constructor(fields: HashedDocumentArgs) {\n    this.uid = fields.uid;\n    this.pageContent = fields.pageContent;\n    this.metadata = fields.metadata;\n  }\n\n  makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void {\n    this.keyEncoder = keyEncoderFn;\n  }\n\n  calculateHashes(): void {\n    const forbiddenKeys = [\"hash_\", \"content_hash\", \"metadata_hash\"];\n\n    for (const key of forbiddenKeys) {\n      if (key in this.metadata) {\n        throw new Error(\n          `Metadata cannot contain key ${key} as it is reserved for internal use. Restricted keys: [${forbiddenKeys.join(\n            \", \"\n          )}]`\n        );\n      }\n    }\n\n    const contentHash = this._hashStringToUUID(this.pageContent);\n\n    try {\n      const metadataHash = this._hashNestedDictToUUID(this.metadata);\n      this.contentHash = contentHash;\n      this.metadataHash = metadataHash;\n    } catch (e) {\n      throw new Error(\n        `Failed to hash metadata: ${e}. Please use a dict that can be serialized using json.`\n      );\n    }\n\n    this.hash_ = this._hashStringToUUID(this.contentHash + this.metadataHash);\n\n    if (!this.uid) {\n      this.uid = this.hash_;\n    }\n  }\n\n  toDocument(): DocumentInterface {\n    return new Document({\n      pageContent: this.pageContent,\n      metadata: this.metadata,\n    });\n  }\n\n  static fromDocument(\n    document: DocumentInterface,\n    uid?: string\n  ): _HashedDocument {\n    const doc = new this({\n      pageContent: document.pageContent,\n      metadata: document.metadata,\n      uid: uid || (document as DocumentInterface & { uid: string }).uid,\n    });\n    doc.calculateHashes();\n    return doc;\n  }\n\n  private _hashStringToUUID(inputString: string): string {\n    const hash_value = this.keyEncoder(inputString);\n    return uuidv5(hash_value, UUIDV5_NAMESPACE);\n  }\n\n  private _hashNestedDictToUUID(data: Record<string, unknown>): string {\n    const serialized_data = JSON.stringify(data, Object.keys(data).sort());\n    const hash_value = this.keyEncoder(serialized_data);\n    return uuidv5(hash_value, UUIDV5_NAMESPACE);\n  }\n}\n\nexport type CleanupMode = \"full\" | \"incremental\";\n\nexport type IndexOptions = {\n  /**\n   * The number of documents to index in one batch.\n   */\n  batchSize?: number;\n  /**\n   * The cleanup mode to use. Can be \"full\", \"incremental\" or undefined.\n   * - **Incremental**: Cleans up all documents that haven't been updated AND\n   *   that are associated with source ids that were seen\n   *   during indexing.\n   *   Clean up is done continuously during indexing helping\n   *   to minimize the probability of users seeing duplicated\n   *   content.\n   * - **Full**: Delete all documents that haven to been returned by the loader.\n   *   Clean up runs after all documents have been indexed.\n   *   This means that users may see duplicated content during indexing.\n   * - **undefined**: Do not delete any documents.\n   */\n  cleanup?: CleanupMode;\n  /**\n   * Optional key that helps identify the original source of the document.\n   * Must either be a string representing the key of the source in the metadata\n   * or a function that takes a document and returns a string representing the source.\n   * **Required when cleanup is incremental**.\n   */\n  sourceIdKey?: StringOrDocFunc;\n  /**\n   * Batch size to use when cleaning up documents.\n   */\n  cleanupBatchSize?: number;\n  /**\n   * Force update documents even if they are present in the\n   * record manager. Useful if you are re-indexing with updated embeddings.\n   */\n  forceUpdate?: boolean;\n};\n\nexport function _batch<T>(size: number, iterable: T[]): T[][] {\n  const batches: T[][] = [];\n  let currentBatch: T[] = [];\n\n  iterable.forEach((item) => {\n    currentBatch.push(item);\n\n    if (currentBatch.length >= size) {\n      batches.push(currentBatch);\n      currentBatch = [];\n    }\n  });\n\n  if (currentBatch.length > 0) {\n    batches.push(currentBatch);\n  }\n\n  return batches;\n}\n\nexport function _deduplicateInOrder(\n  hashedDocuments: HashedDocumentInterface[]\n): HashedDocumentInterface[] {\n  const seen = new Set<string>();\n  const deduplicated: HashedDocumentInterface[] = [];\n\n  for (const hashedDoc of hashedDocuments) {\n    if (!hashedDoc.hash_) {\n      throw new Error(\"Hashed document does not have a hash\");\n    }\n\n    if (!seen.has(hashedDoc.hash_)) {\n      seen.add(hashedDoc.hash_);\n      deduplicated.push(hashedDoc);\n    }\n  }\n  return deduplicated;\n}\n\nexport function _getSourceIdAssigner(\n  sourceIdKey: StringOrDocFunc | null\n): (doc: DocumentInterface) => string | null {\n  if (sourceIdKey === null) {\n    return (_doc: DocumentInterface) => null;\n  } else if (typeof sourceIdKey === \"string\") {\n    return (doc: DocumentInterface) => doc.metadata[sourceIdKey];\n  } else if (typeof sourceIdKey === \"function\") {\n    return sourceIdKey;\n  } else {\n    throw new Error(\n      `sourceIdKey should be null, a string or a function, got ${typeof sourceIdKey}`\n    );\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const _isBaseDocumentLoader = (arg: any): arg is BaseDocumentLoader => {\n  if (\n    \"load\" in arg &&\n    typeof arg.load === \"function\" &&\n    \"loadAndSplit\" in arg &&\n    typeof arg.loadAndSplit === \"function\"\n  ) {\n    return true;\n  }\n  return false;\n};\n\ninterface IndexArgs {\n  docsSource: BaseDocumentLoader | DocumentInterface[];\n  recordManager: RecordManagerInterface;\n  vectorStore: VectorStore;\n  options?: IndexOptions;\n}\n\n/**\n * Index data from the doc source into the vector store.\n *\n * Indexing functionality uses a manager to keep track of which documents\n * are in the vector store.\n *\n * This allows us to keep track of which documents were updated, and which\n * documents were deleted, which documents should be skipped.\n *\n * For the time being, documents are indexed using their hashes, and users\n *  are not able to specify the uid of the document.\n *\n * @param {IndexArgs} args\n * @param {BaseDocumentLoader | DocumentInterface[]} args.docsSource The source of documents to index. Can be a DocumentLoader or a list of Documents.\n * @param {RecordManagerInterface} args.recordManager The record manager to use for keeping track of indexed documents.\n * @param {VectorStore} args.vectorStore The vector store to use for storing the documents.\n * @param {IndexOptions | undefined} args.options Options for indexing.\n * @returns {Promise<IndexingResult>}\n */\nexport async function index(args: IndexArgs): Promise<IndexingResult> {\n  const { docsSource, recordManager, vectorStore, options } = args;\n  const {\n    batchSize = 100,\n    cleanup,\n    sourceIdKey,\n    cleanupBatchSize = 1000,\n    forceUpdate = false,\n  } = options ?? {};\n\n  if (cleanup === \"incremental\" && !sourceIdKey) {\n    throw new Error(\n      \"sourceIdKey is required when cleanup mode is incremental. Please provide through 'options.sourceIdKey'.\"\n    );\n  }\n\n  const docs = _isBaseDocumentLoader(docsSource)\n    ? await docsSource.load()\n    : docsSource;\n\n  const sourceIdAssigner = _getSourceIdAssigner(sourceIdKey ?? null);\n\n  const indexStartDt = await recordManager.getTime();\n  let numAdded = 0;\n  let numDeleted = 0;\n  let numUpdated = 0;\n  let numSkipped = 0;\n\n  const batches = _batch<DocumentInterface>(batchSize ?? 100, docs);\n\n  for (const batch of batches) {\n    const hashedDocs = _deduplicateInOrder(\n      batch.map((doc) => _HashedDocument.fromDocument(doc))\n    );\n\n    const sourceIds = hashedDocs.map((doc) => sourceIdAssigner(doc));\n\n    if (cleanup === \"incremental\") {\n      hashedDocs.forEach((_hashedDoc, index) => {\n        const source = sourceIds[index];\n        if (source === null) {\n          throw new Error(\n            \"sourceIdKey must be provided when cleanup is incremental\"\n          );\n        }\n      });\n    }\n\n    const batchExists = await recordManager.exists(\n      hashedDocs.map((doc) => doc.uid)\n    );\n\n    const uids: string[] = [];\n    const docsToIndex: DocumentInterface[] = [];\n    const docsToUpdate: string[] = [];\n    const seenDocs = new Set<string>();\n    hashedDocs.forEach((hashedDoc, i) => {\n      const docExists = batchExists[i];\n      if (docExists) {\n        if (forceUpdate) {\n          seenDocs.add(hashedDoc.uid);\n        } else {\n          docsToUpdate.push(hashedDoc.uid);\n          return;\n        }\n      }\n      uids.push(hashedDoc.uid);\n      docsToIndex.push(hashedDoc.toDocument());\n    });\n\n    if (docsToUpdate.length > 0) {\n      await recordManager.update(docsToUpdate, { timeAtLeast: indexStartDt });\n      numSkipped += docsToUpdate.length;\n    }\n\n    if (docsToIndex.length > 0) {\n      await vectorStore.addDocuments(docsToIndex, { ids: uids });\n      numAdded += docsToIndex.length - seenDocs.size;\n      numUpdated += seenDocs.size;\n    }\n\n    await recordManager.update(\n      hashedDocs.map((doc) => doc.uid),\n      { timeAtLeast: indexStartDt, groupIds: sourceIds }\n    );\n\n    if (cleanup === \"incremental\") {\n      sourceIds.forEach((sourceId) => {\n        if (!sourceId) throw new Error(\"Source id cannot be null\");\n      });\n      const uidsToDelete = await recordManager.listKeys({\n        before: indexStartDt,\n        groupIds: sourceIds,\n      });\n\n      if (uidsToDelete.length > 0) {\n        await vectorStore.delete({ ids: uidsToDelete });\n        await recordManager.deleteKeys(uidsToDelete);\n        numDeleted += uidsToDelete.length;\n      }\n    }\n  }\n\n  if (cleanup === \"full\") {\n    let uidsToDelete = await recordManager.listKeys({\n      before: indexStartDt,\n      limit: cleanupBatchSize,\n    });\n    while (uidsToDelete.length > 0) {\n      await vectorStore.delete({ ids: uidsToDelete });\n      await recordManager.deleteKeys(uidsToDelete);\n      numDeleted += uidsToDelete.length;\n      uidsToDelete = await recordManager.listKeys({\n        before: indexStartDt,\n        limit: cleanupBatchSize,\n      });\n    }\n  }\n\n  return {\n    numAdded,\n    numDeleted,\n    numUpdated,\n    numSkipped,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;AAwCA,IAAa,kBAAb,MAAgE;CAC9D;CAEA;CAEA;CAEA;CAEA;CAEA;CAEA,AAAQ,aAA6BA;CAErC,YAAYC,QAA4B;EACtC,KAAK,MAAM,OAAO;EAClB,KAAK,cAAc,OAAO;EAC1B,KAAK,WAAW,OAAO;CACxB;CAED,sBAAsBC,cAAoC;EACxD,KAAK,aAAa;CACnB;CAED,kBAAwB;EACtB,MAAM,gBAAgB;GAAC;GAAS;GAAgB;EAAgB;AAEhE,OAAK,MAAM,OAAO,cAChB,KAAI,OAAO,KAAK,SACd,OAAM,IAAI,MACR,CAAC,4BAA4B,EAAE,IAAI,uDAAuD,EAAE,cAAc,KACxG,KACD,CAAC,CAAC,CAAC;EAKV,MAAM,cAAc,KAAK,kBAAkB,KAAK,YAAY;AAE5D,MAAI;GACF,MAAM,eAAe,KAAK,sBAAsB,KAAK,SAAS;GAC9D,KAAK,cAAc;GACnB,KAAK,eAAe;EACrB,SAAQ,GAAG;AACV,SAAM,IAAI,MACR,CAAC,yBAAyB,EAAE,EAAE,sDAAsD,CAAC;EAExF;EAED,KAAK,QAAQ,KAAK,kBAAkB,KAAK,cAAc,KAAK,aAAa;AAEzE,MAAI,CAAC,KAAK,KACR,KAAK,MAAM,KAAK;CAEnB;CAED,aAAgC;AAC9B,SAAO,IAAIC,0BAAS;GAClB,aAAa,KAAK;GAClB,UAAU,KAAK;EAChB;CACF;CAED,OAAO,aACLC,UACAC,KACiB;EACjB,MAAM,MAAM,IAAI,KAAK;GACnB,aAAa,SAAS;GACtB,UAAU,SAAS;GACnB,KAAK,OAAQ,SAAiD;EAC/D;EACD,IAAI,iBAAiB;AACrB,SAAO;CACR;CAED,AAAQ,kBAAkBC,aAA6B;EACrD,MAAM,aAAa,KAAK,WAAW,YAAY;AAC/C,sBAAc,YAAYC,wCAAiB;CAC5C;CAED,AAAQ,sBAAsBC,MAAuC;EACnE,MAAM,kBAAkB,KAAK,UAAU,MAAM,OAAO,KAAK,KAAK,CAAC,MAAM,CAAC;EACtE,MAAM,aAAa,KAAK,WAAW,gBAAgB;AACnD,sBAAc,YAAYD,wCAAiB;CAC5C;AACF;AAyCD,SAAgB,OAAUE,MAAcC,UAAsB;CAC5D,MAAMC,UAAiB,CAAE;CACzB,IAAIC,eAAoB,CAAE;CAE1B,SAAS,QAAQ,CAAC,SAAS;EACzB,aAAa,KAAK,KAAK;AAEvB,MAAI,aAAa,UAAU,MAAM;GAC/B,QAAQ,KAAK,aAAa;GAC1B,eAAe,CAAE;EAClB;CACF,EAAC;AAEF,KAAI,aAAa,SAAS,GACxB,QAAQ,KAAK,aAAa;AAG5B,QAAO;AACR;AAED,SAAgB,oBACdC,iBAC2B;CAC3B,MAAM,uBAAO,IAAI;CACjB,MAAMC,eAA0C,CAAE;AAElD,MAAK,MAAM,aAAa,iBAAiB;AACvC,MAAI,CAAC,UAAU,MACb,OAAM,IAAI,MAAM;AAGlB,MAAI,CAAC,KAAK,IAAI,UAAU,MAAM,EAAE;GAC9B,KAAK,IAAI,UAAU,MAAM;GACzB,aAAa,KAAK,UAAU;EAC7B;CACF;AACD,QAAO;AACR;AAED,SAAgB,qBACdC,aAC2C;AAC3C,KAAI,gBAAgB,KAClB,QAAO,CAACC,SAA4B;UAC3B,OAAO,gBAAgB,SAChC,QAAO,CAACC,QAA2B,IAAI,SAAS;UACvC,OAAO,gBAAgB,WAChC,QAAO;KAEP,OAAM,IAAI,MACR,CAAC,wDAAwD,EAAE,OAAO,aAAa;AAGpF;AAGD,MAAa,wBAAwB,CAACC,QAAwC;AAC5E,KACE,UAAU,OACV,OAAO,IAAI,SAAS,cACpB,kBAAkB,OAClB,OAAO,IAAI,iBAAiB,WAE5B,QAAO;AAET,QAAO;AACR;;;;;;;;;;;;;;;;;;;;AA4BD,eAAsB,MAAMC,MAA0C;CACpE,MAAM,EAAE,YAAY,eAAe,aAAa,SAAS,GAAG;CAC5D,MAAM,EACJ,YAAY,KACZ,SACA,aACA,mBAAmB,KACnB,cAAc,OACf,GAAG,WAAW,CAAE;AAEjB,KAAI,YAAY,iBAAiB,CAAC,YAChC,OAAM,IAAI,MACR;CAIJ,MAAM,OAAO,sBAAsB,WAAW,GAC1C,MAAM,WAAW,MAAM,GACvB;CAEJ,MAAM,mBAAmB,qBAAqB,eAAe,KAAK;CAElE,MAAM,eAAe,MAAM,cAAc,SAAS;CAClD,IAAI,WAAW;CACf,IAAI,aAAa;CACjB,IAAI,aAAa;CACjB,IAAI,aAAa;CAEjB,MAAM,UAAU,OAA0B,aAAa,KAAK,KAAK;AAEjE,MAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,aAAa,oBACjB,MAAM,IAAI,CAAC,QAAQ,gBAAgB,aAAa,IAAI,CAAC,CACtD;EAED,MAAM,YAAY,WAAW,IAAI,CAAC,QAAQ,iBAAiB,IAAI,CAAC;AAEhE,MAAI,YAAY,eACd,WAAW,QAAQ,CAAC,YAAYC,YAAU;GACxC,MAAM,SAAS,UAAUA;AACzB,OAAI,WAAW,KACb,OAAM,IAAI,MACR;EAGL,EAAC;EAGJ,MAAM,cAAc,MAAM,cAAc,OACtC,WAAW,IAAI,CAAC,QAAQ,IAAI,IAAI,CACjC;EAED,MAAMC,OAAiB,CAAE;EACzB,MAAMC,cAAmC,CAAE;EAC3C,MAAMC,eAAyB,CAAE;EACjC,MAAM,2BAAW,IAAI;EACrB,WAAW,QAAQ,CAAC,WAAW,MAAM;GACnC,MAAM,YAAY,YAAY;AAC9B,OAAI,UACF,KAAI,aACF,SAAS,IAAI,UAAU,IAAI;QACtB;IACL,aAAa,KAAK,UAAU,IAAI;AAChC;GACD;GAEH,KAAK,KAAK,UAAU,IAAI;GACxB,YAAY,KAAK,UAAU,YAAY,CAAC;EACzC,EAAC;AAEF,MAAI,aAAa,SAAS,GAAG;GAC3B,MAAM,cAAc,OAAO,cAAc,EAAE,aAAa,aAAc,EAAC;GACvE,cAAc,aAAa;EAC5B;AAED,MAAI,YAAY,SAAS,GAAG;GAC1B,MAAM,YAAY,aAAa,aAAa,EAAE,KAAK,KAAM,EAAC;GAC1D,YAAY,YAAY,SAAS,SAAS;GAC1C,cAAc,SAAS;EACxB;EAED,MAAM,cAAc,OAClB,WAAW,IAAI,CAAC,QAAQ,IAAI,IAAI,EAChC;GAAE,aAAa;GAAc,UAAU;EAAW,EACnD;AAED,MAAI,YAAY,eAAe;GAC7B,UAAU,QAAQ,CAAC,aAAa;AAC9B,QAAI,CAAC,SAAU,OAAM,IAAI,MAAM;GAChC,EAAC;GACF,MAAM,eAAe,MAAM,cAAc,SAAS;IAChD,QAAQ;IACR,UAAU;GACX,EAAC;AAEF,OAAI,aAAa,SAAS,GAAG;IAC3B,MAAM,YAAY,OAAO,EAAE,KAAK,aAAc,EAAC;IAC/C,MAAM,cAAc,WAAW,aAAa;IAC5C,cAAc,aAAa;GAC5B;EACF;CACF;AAED,KAAI,YAAY,QAAQ;EACtB,IAAI,eAAe,MAAM,cAAc,SAAS;GAC9C,QAAQ;GACR,OAAO;EACR,EAAC;AACF,SAAO,aAAa,SAAS,GAAG;GAC9B,MAAM,YAAY,OAAO,EAAE,KAAK,aAAc,EAAC;GAC/C,MAAM,cAAc,WAAW,aAAa;GAC5C,cAAc,aAAa;GAC3B,eAAe,MAAM,cAAc,SAAS;IAC1C,QAAQ;IACR,OAAO;GACR,EAAC;EACH;CACF;AAED,QAAO;EACL;EACA;EACA;EACA;CACD;AACF"}

package/dist/indexing/base.d.cts

@@ -40,9 +40,6 @@ declare class _HashedDocument implements HashedDocumentInterface {
   metadataHash?: string;
   pageContent: string;
   metadata: Metadata;
-  // For backwards compatibility, we use a default key encoder
-  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning
-  // about the security implications of using SHA-1 as a key encoder.
   private keyEncoder;
   constructor(fields: HashedDocumentArgs);
   makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;

package/dist/indexing/base.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.cts","names":["VectorStore","RecordManagerInterface","HashKeyEncoder","DocumentInterface","BaseDocumentLoader","Metadata","Record","IndexingResult","StringOrDocFunc","HashedDocumentInterface","HashedDocumentArgs","_HashedDocument","CleanupMode","IndexOptions","_batch","T","_deduplicateInOrder","_getSourceIdAssigner","_isBaseDocumentLoader","IndexArgs","index","Promise"],"sources":["../../src/indexing/base.d.ts"],"sourcesContent":["import { VectorStore } from \"../vectorstores.js\";\nimport { RecordManagerInterface } from \"./record_manager.js\";\nimport { type HashKeyEncoder } from \"../utils/hash.js\";\nimport { DocumentInterface } from \"../documents/document.js\";\nimport { BaseDocumentLoader } from \"../document_loaders/base.js\";\ntype Metadata = Record<string, unknown>;\ntype IndexingResult = {\n    numAdded: number;\n    numDeleted: number;\n    numUpdated: number;\n    numSkipped: number;\n};\ntype StringOrDocFunc = string | ((doc: DocumentInterface) => string);\nexport interface HashedDocumentInterface extends DocumentInterface {\n    uid: string;\n    hash_?: string;\n    contentHash?: string;\n    metadataHash?: string;\n    pageContent: string;\n    metadata: Metadata;\n    calculateHashes(): void;\n    toDocument(): DocumentInterface;\n}\ninterface HashedDocumentArgs {\n    pageContent: string;\n    metadata: Metadata;\n    uid: string;\n}\n/**\n * HashedDocument is a Document with hashes calculated.\n * Hashes are calculated based on page content and metadata.\n * It is used for indexing.\n */\nexport declare class _HashedDocument implements HashedDocumentInterface {\n    uid: string;\n    hash_?: string;\n    contentHash?: string;\n    metadataHash?: string;\n    pageContent: string;\n    metadata: Metadata;\n    // For backwards compatibility, we use a default key encoder\n    // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning\n    // about the security implications of using SHA-1 as a key encoder.\n    private keyEncoder;\n    constructor(fields: HashedDocumentArgs);\n    makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;\n    calculateHashes(): void;\n    toDocument(): DocumentInterface;\n    static fromDocument(document: DocumentInterface, uid?: string): _HashedDocument;\n    private _hashStringToUUID;\n    private _hashNestedDictToUUID;\n}\nexport type CleanupMode = \"full\" | \"incremental\";\nexport type IndexOptions = {\n    /**\n     * The number of documents to index in one batch.\n     */\n    batchSize?: number;\n    /**\n     * The cleanup mode to use. Can be \"full\", \"incremental\" or undefined.\n     * - **Incremental**: Cleans up all documents that haven't been updated AND\n     *   that are associated with source ids that were seen\n     *   during indexing.\n     *   Clean up is done continuously during indexing helping\n     *   to minimize the probability of users seeing duplicated\n     *   content.\n     * - **Full**: Delete all documents that haven to been returned by the loader.\n     *   Clean up runs after all documents have been indexed.\n     *   This means that users may see duplicated content during indexing.\n     * - **undefined**: Do not delete any documents.\n     */\n    cleanup?: CleanupMode;\n    /**\n     * Optional key that helps identify the original source of the document.\n     * Must either be a string representing the key of the source in the metadata\n     * or a function that takes a document and returns a string representing the source.\n     * **Required when cleanup is incremental**.\n     */\n    sourceIdKey?: StringOrDocFunc;\n    /**\n     * Batch size to use when cleaning up documents.\n     */\n    cleanupBatchSize?: number;\n    /**\n     * Force update documents even if they are present in the\n     * record manager. Useful if you are re-indexing with updated embeddings.\n     */\n    forceUpdate?: boolean;\n};\nexport declare function _batch<T>(size: number, iterable: T[]): T[][];\nexport declare function _deduplicateInOrder(hashedDocuments: HashedDocumentInterface[]): HashedDocumentInterface[];\nexport declare function _getSourceIdAssigner(sourceIdKey: StringOrDocFunc | null): (doc: DocumentInterface) => string | null;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport declare const _isBaseDocumentLoader: (arg: any) => arg is BaseDocumentLoader;\ninterface IndexArgs {\n    docsSource: BaseDocumentLoader | DocumentInterface[];\n    recordManager: RecordManagerInterface;\n    vectorStore: VectorStore;\n    options?: IndexOptions;\n}\n/**\n * Index data from the doc source into the vector store.\n *\n * Indexing functionality uses a manager to keep track of which documents\n * are in the vector store.\n *\n * This allows us to keep track of which documents were updated, and which\n * documents were deleted, which documents should be skipped.\n *\n * For the time being, documents are indexed using their hashes, and users\n *  are not able to specify the uid of the document.\n *\n * @param {IndexArgs} args\n * @param {BaseDocumentLoader | DocumentInterface[]} args.docsSource The source of documents to index. Can be a DocumentLoader or a list of Documents.\n * @param {RecordManagerInterface} args.recordManager The record manager to use for keeping track of indexed documents.\n * @param {VectorStore} args.vectorStore The vector store to use for storing the documents.\n * @param {IndexOptions | undefined} args.options Options for indexing.\n * @returns {Promise<IndexingResult>}\n */\nexport declare function index(args: IndexArgs): Promise<IndexingResult>;\nexport {};\n"],"mappings":";;;;;;;KAKKK,QAAAA,GAAWC;KACXC,cAAAA;EADAF,QAAAA,EAAAA,MAAQ;EACRE,UAAAA,EAAAA,MAAc;EAMdC,UAAAA,EAAAA,MAAe;EACHC,UAAAA,EAAAA,MAAAA;CAAuB;KADnCD,eAAAA,GAOSH,MAAAA,GAAAA,CAAAA,CAAAA,GAAAA,EAPyBF,iBAOzBE,EAAAA,GAAAA,MAAAA,CAAAA;AAEIF,UARDM,uBAAAA,SAAgCN,iBAQ/BA,CAAAA;EAAiB,GARcA,EAAAA,MAAAA;EAAiB,KAAA,CAAA,EAAA,MAAA;EAUxDO,WAAAA,CAAAA,EAAAA,MAAAA;EAUWC,YAAAA,CAAAA,EAAAA,MAAe;EAAA,WAAA,EAAA,MAAA;EAAA,QAMtBN,EApBAA,QAoBAA;EAAQ,eAKEK,EAAAA,EAAAA,IAAAA;EAAkB,UACFR,EAAAA,EAxBtBC,iBAwBsBD;;UAtB9BQ,kBAAAA,CAyBwBP;EAAiB,WAAiBQ,EAAAA,MAAAA;EAAe,QAfnCF,EARlCJ,QAQkCI;EAAuB,GAAA,EAAA,MAAA;AAmBvE;AACA;;;;AAyBiC;AAWTK,cAxDHH,eAAAA,YAA2BF,uBAwDlB,CAAA;EAAA,GAAA,EAAA,MAAA;EAAA,KAA4BM,CAAAA,EAAAA,MAAAA;EAAC,WAAKA,CAAAA,EAAAA,MAAAA;EAAC,YAAA,CAAA,EAAA,MAAA;EACzCC,WAAAA,EAAAA,MAAAA;EAAmB,QAAA,EAnD7BX,QAmD6B;EAAA;EAAyC;EAA4B;EACxFY,QAAAA,UAAAA;EAAoB,WAAA,CAAA,MAAA,EA/CpBP,kBA+CoB;EAAA,qBAAcF,CAAAA,YAAAA,EA9ClBN,cA8CkBM,CAAAA,EAAAA,IAAAA;EAAe,eAAgBL,CAAAA,CAAAA,EAAAA,IAAAA;EAAiB,UAAA,CAAA,CAAA,EA5CxFA,iBA4CwF;EAErFe,OAAAA,YAAAA,CAAAA,QAA8D,EA7CjDf,iBA6C+BC,EAAAA,GAAkB,CAAlBA,EAAkB,MAAA,CAAA,EA7CfO,eA6Ce;EACzEQ,QAAAA,iBAAS;EAAA,QAAA,qBAAA;;AACkBhB,KA3CzBS,WAAAA,GA2CyBT,MAAAA,GAAAA,aAAAA;AAClBF,KA3CPY,YAAAA,GA2COZ;EAAsB;;AAEf;EAqBFmB,SAAK,CAAA,EAAA,MAAA;EAAA;;;;AAA0B;;;;;;;;;YAhDzCR;;;;;;;gBAOIJ;;;;;;;;;;;iBAWMM,kCAAkCC,MAAMA;iBACxCC,mBAAAA,kBAAqCP,4BAA4BA;iBACjEQ,oBAAAA,cAAkCT,+BAA+BL;;cAEpEe,4CAA4Cd;UACvDe,SAAAA;cACMf,qBAAqBD;iBAClBF;eACFD;YACHa;;;;;;;;;;;;;;;;;;;;;iBAqBUO,KAAAA,OAAYD,YAAYE,QAAQd"}
+{"version":3,"file":"base.d.cts","names":["VectorStore","RecordManagerInterface","HashKeyEncoder","DocumentInterface","BaseDocumentLoader","Metadata","Record","IndexingResult","StringOrDocFunc","HashedDocumentInterface","HashedDocumentArgs","_HashedDocument","CleanupMode","IndexOptions","_batch","T","_deduplicateInOrder","_getSourceIdAssigner","_isBaseDocumentLoader","IndexArgs","index","Promise"],"sources":["../../src/indexing/base.d.ts"],"sourcesContent":["import { VectorStore } from \"../vectorstores.js\";\nimport { RecordManagerInterface } from \"./record_manager.js\";\nimport { type HashKeyEncoder } from \"../utils/hash.js\";\nimport { DocumentInterface } from \"../documents/document.js\";\nimport { BaseDocumentLoader } from \"../document_loaders/base.js\";\ntype Metadata = Record<string, unknown>;\ntype IndexingResult = {\n    numAdded: number;\n    numDeleted: number;\n    numUpdated: number;\n    numSkipped: number;\n};\ntype StringOrDocFunc = string | ((doc: DocumentInterface) => string);\nexport interface HashedDocumentInterface extends DocumentInterface {\n    uid: string;\n    hash_?: string;\n    contentHash?: string;\n    metadataHash?: string;\n    pageContent: string;\n    metadata: Metadata;\n    calculateHashes(): void;\n    toDocument(): DocumentInterface;\n}\ninterface HashedDocumentArgs {\n    pageContent: string;\n    metadata: Metadata;\n    uid: string;\n}\n/**\n * HashedDocument is a Document with hashes calculated.\n * Hashes are calculated based on page content and metadata.\n * It is used for indexing.\n */\nexport declare class _HashedDocument implements HashedDocumentInterface {\n    uid: string;\n    hash_?: string;\n    contentHash?: string;\n    metadataHash?: string;\n    pageContent: string;\n    metadata: Metadata;\n    private keyEncoder;\n    constructor(fields: HashedDocumentArgs);\n    makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;\n    calculateHashes(): void;\n    toDocument(): DocumentInterface;\n    static fromDocument(document: DocumentInterface, uid?: string): _HashedDocument;\n    private _hashStringToUUID;\n    private _hashNestedDictToUUID;\n}\nexport type CleanupMode = \"full\" | \"incremental\";\nexport type IndexOptions = {\n    /**\n     * The number of documents to index in one batch.\n     */\n    batchSize?: number;\n    /**\n     * The cleanup mode to use. Can be \"full\", \"incremental\" or undefined.\n     * - **Incremental**: Cleans up all documents that haven't been updated AND\n     *   that are associated with source ids that were seen\n     *   during indexing.\n     *   Clean up is done continuously during indexing helping\n     *   to minimize the probability of users seeing duplicated\n     *   content.\n     * - **Full**: Delete all documents that haven to been returned by the loader.\n     *   Clean up runs after all documents have been indexed.\n     *   This means that users may see duplicated content during indexing.\n     * - **undefined**: Do not delete any documents.\n     */\n    cleanup?: CleanupMode;\n    /**\n     * Optional key that helps identify the original source of the document.\n     * Must either be a string representing the key of the source in the metadata\n     * or a function that takes a document and returns a string representing the source.\n     * **Required when cleanup is incremental**.\n     */\n    sourceIdKey?: StringOrDocFunc;\n    /**\n     * Batch size to use when cleaning up documents.\n     */\n    cleanupBatchSize?: number;\n    /**\n     * Force update documents even if they are present in the\n     * record manager. Useful if you are re-indexing with updated embeddings.\n     */\n    forceUpdate?: boolean;\n};\nexport declare function _batch<T>(size: number, iterable: T[]): T[][];\nexport declare function _deduplicateInOrder(hashedDocuments: HashedDocumentInterface[]): HashedDocumentInterface[];\nexport declare function _getSourceIdAssigner(sourceIdKey: StringOrDocFunc | null): (doc: DocumentInterface) => string | null;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport declare const _isBaseDocumentLoader: (arg: any) => arg is BaseDocumentLoader;\ninterface IndexArgs {\n    docsSource: BaseDocumentLoader | DocumentInterface[];\n    recordManager: RecordManagerInterface;\n    vectorStore: VectorStore;\n    options?: IndexOptions;\n}\n/**\n * Index data from the doc source into the vector store.\n *\n * Indexing functionality uses a manager to keep track of which documents\n * are in the vector store.\n *\n * This allows us to keep track of which documents were updated, and which\n * documents were deleted, which documents should be skipped.\n *\n * For the time being, documents are indexed using their hashes, and users\n *  are not able to specify the uid of the document.\n *\n * @param {IndexArgs} args\n * @param {BaseDocumentLoader | DocumentInterface[]} args.docsSource The source of documents to index. Can be a DocumentLoader or a list of Documents.\n * @param {RecordManagerInterface} args.recordManager The record manager to use for keeping track of indexed documents.\n * @param {VectorStore} args.vectorStore The vector store to use for storing the documents.\n * @param {IndexOptions | undefined} args.options Options for indexing.\n * @returns {Promise<IndexingResult>}\n */\nexport declare function index(args: IndexArgs): Promise<IndexingResult>;\nexport {};\n"],"mappings":";;;;;;;KAKKK,QAAAA,GAAWC;KACXC,cAAAA;EADAF,QAAAA,EAAAA,MAAQ;EACRE,UAAAA,EAAAA,MAAc;EAMdC,UAAAA,EAAAA,MAAe;EACHC,UAAAA,EAAAA,MAAAA;CAAuB;KADnCD,eAAAA,GAOSH,MAAAA,GAAAA,CAAAA,CAAAA,GAAAA,EAPyBF,iBAOzBE,EAAAA,GAAAA,MAAAA,CAAAA;AAEIF,UARDM,uBAAAA,SAAgCN,iBAQ/BA,CAAAA;EAAiB,GARcA,EAAAA,MAAAA;EAAiB,KAAA,CAAA,EAAA,MAAA;EAUxDO,WAAAA,CAAAA,EAAAA,MAAAA;EAUWC,YAAAA,CAAAA,EAAAA,MAAe;EAAA,WAAA,EAAA,MAAA;EAAA,QAMtBN,EApBAA,QAoBAA;EAAQ,eAEEK,EAAAA,EAAAA,IAAAA;EAAkB,UACFR,EAAAA,EArBtBC,iBAqBsBD;;UAnB9BQ,kBAAAA,CAsBwBP;EAAiB,WAAiBQ,EAAAA,MAAAA;EAAe,QAZnCF,EARlCJ,QAQkCI;EAAuB,GAAA,EAAA,MAAA;AAgBvE;AACA;;;;AAyBiC;AAWTK,cArDHH,eAAAA,YAA2BF,uBAqDlB,CAAA;EAAA,GAAA,EAAA,MAAA;EAAA,KAA4BM,CAAAA,EAAAA,MAAAA;EAAC,WAAKA,CAAAA,EAAAA,MAAAA;EAAC,YAAA,CAAA,EAAA,MAAA;EACzCC,WAAAA,EAAAA,MAAAA;EAAmB,QAAA,EAhD7BX,QAgD6B;EAAA,QAAkBI,UAAAA;EAAuB,WAAKA,CAAAA,MAAAA,EA9CjEC,kBA8CiED;EAAuB,qBAAA,CAAA,YAAA,EA7CxEP,cA6CwE,CAAA,EAAA,IAAA;EACxFe,eAAAA,CAAAA,CAAAA,EAAAA,IAAoB;EAAA,UAAA,CAAA,CAAA,EA5C1Bd,iBA4C0B;EAAA,OAAcK,YAAAA,CAAAA,QAAAA,EA3CxBL,iBA2CwBK,EAAAA,GAAAA,CAAAA,EAAAA,MAAAA,CAAAA,EA3CUG,eA2CVH;EAAe,QAAgBL,iBAAAA;EAAiB,QAAA,qBAAA;AAE1G;AACUgB,KA1CEP,WAAAA,GA0CO,MAAA,GAAA,aAAA;AAAA,KAzCPC,YAAAA,GAyCO;EAAA;;;EAEsB,SACxBb,CAAAA,EAAAA,MAAAA;EAAW;AACF;AAqB1B;;;;;AAAuD;;;;;;YAhDzCY;;;;;;;gBAOIJ;;;;;;;;;;;iBAWMM,kCAAkCC,MAAMA;iBACxCC,mBAAAA,kBAAqCP,4BAA4BA;iBACjEQ,oBAAAA,cAAkCT,+BAA+BL;;cAEpEe,4CAA4Cd;UACvDe,SAAAA;cACMf,qBAAqBD;iBAClBF;eACFD;YACHa;;;;;;;;;;;;;;;;;;;;;iBAqBUO,KAAAA,OAAYD,YAAYE,QAAQd"}

package/dist/indexing/base.d.ts

@@ -40,9 +40,6 @@ declare class _HashedDocument implements HashedDocumentInterface {
   metadataHash?: string;
   pageContent: string;
   metadata: Metadata;
-  // For backwards compatibility, we use a default key encoder
-  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning
-  // about the security implications of using SHA-1 as a key encoder.
   private keyEncoder;
   constructor(fields: HashedDocumentArgs);
   makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;