Merge pull request #1760 from getzep/zep-cloud-setup

Zep cloud setup
2026-06-28 21:00:58 +03:00 · 2024-02-26 23:26:17 +08:00
parent 850e50689e 6819d5f66b
commit 89307b13c9
9 changed files with 457 additions and 6 deletions
@@ -17,7 +17,7 @@ class ZepMemory_Memory implements INode {
    inputs: INodeParams[]

    constructor() {
-        this.label = 'Zep Memory'
+        this.label = 'Zep Memory - Open Source'
        this.name = 'ZepMemory'
        this.version = 2.0
        this.type = 'ZepMemory'
@@ -97,11 +97,11 @@ class ZepMemory_Memory implements INode {
    }

    async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
-        return await initalizeZep(nodeData, options)
+        return await initializeZep(nodeData, options)
    }
 }

-const initalizeZep = async (nodeData: INodeData, options: ICommonObject): Promise<ZepMemory> => {
+const initializeZep = async (nodeData: INodeData, options: ICommonObject): Promise<ZepMemory> => {
    const baseURL = nodeData.inputs?.baseURL as string
    const aiPrefix = nodeData.inputs?.aiPrefix as string
    const humanPrefix = nodeData.inputs?.humanPrefix as string
@@ -0,0 +1,181 @@
+import { IMessage, INode, INodeData, INodeParams, MemoryMethods, MessageType } from '../../../src/Interface'
+import { convertBaseMessagetoIMessage, getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
+import { ZepMemory, ZepMemoryInput } from '@getzep/zep-cloud/langchain'
+
+import { ICommonObject } from '../../../src'
+import { InputValues, MemoryVariables, OutputValues } from 'langchain/memory'
+import { BaseMessage } from 'langchain/schema'
+
+class ZepMemoryCloud_Memory implements INode {
+    label: string
+    name: string
+    version: number
+    description: string
+    type: string
+    icon: string
+    category: string
+    baseClasses: string[]
+    credential: INodeParams
+    inputs: INodeParams[]
+
+    constructor() {
+        this.label = 'Zep Memory - Cloud'
+        this.name = 'ZepMemoryCloud'
+        this.version = 2.0
+        this.type = 'ZepMemory'
+        this.icon = 'zep.svg'
+        this.category = 'Memory'
+        this.description = 'Summarizes the conversation and stores the memory in zep server'
+        this.baseClasses = [this.type, ...getBaseClasses(ZepMemory)]
+        this.credential = {
+            label: 'Connect Credential',
+            name: 'credential',
+            type: 'credential',
+            optional: true,
+            description: 'Configure JWT authentication on your Zep instance (Optional)',
+            credentialNames: ['zepMemoryApi']
+        }
+        this.inputs = [
+            {
+                label: 'Session Id',
+                name: 'sessionId',
+                type: 'string',
+                description:
+                    'If not specified, a random id will be used. Learn <a target="_blank" href="https://docs.flowiseai.com/memory/long-term-memory#ui-and-embedded-chat">more</a>',
+                default: '',
+                additionalParams: true,
+                optional: true
+            },
+            {
+                label: 'Memory Type',
+                name: 'memoryType',
+                type: 'string',
+                default: 'perpetual',
+                description: 'Zep Memory Type, can be perpetual or message_window',
+                additionalParams: true
+            },
+            {
+                label: 'AI Prefix',
+                name: 'aiPrefix',
+                type: 'string',
+                default: 'ai',
+                additionalParams: true
+            },
+            {
+                label: 'Human Prefix',
+                name: 'humanPrefix',
+                type: 'string',
+                default: 'human',
+                additionalParams: true
+            },
+            {
+                label: 'Memory Key',
+                name: 'memoryKey',
+                type: 'string',
+                default: 'chat_history',
+                additionalParams: true
+            },
+            {
+                label: 'Input Key',
+                name: 'inputKey',
+                type: 'string',
+                default: 'input',
+                additionalParams: true
+            },
+            {
+                label: 'Output Key',
+                name: 'outputKey',
+                type: 'string',
+                default: 'text',
+                additionalParams: true
+            }
+        ]
+    }
+
+    async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
+        return await initializeZep(nodeData, options)
+    }
+}
+
+const initializeZep = async (nodeData: INodeData, options: ICommonObject): Promise<ZepMemory> => {
+    const aiPrefix = nodeData.inputs?.aiPrefix as string
+    const humanPrefix = nodeData.inputs?.humanPrefix as string
+    const memoryKey = nodeData.inputs?.memoryKey as string
+    const inputKey = nodeData.inputs?.inputKey as string
+
+    const memoryType = nodeData.inputs?.memoryType as 'perpetual' | 'message_window'
+    const sessionId = nodeData.inputs?.sessionId as string
+
+    const credentialData = await getCredentialData(nodeData.credential ?? '', options)
+    const apiKey = getCredentialParam('apiKey', credentialData, nodeData)
+    const obj: ZepMemoryInput & ZepMemoryExtendedInput = {
+        apiKey,
+        aiPrefix,
+        humanPrefix,
+        memoryKey,
+        sessionId,
+        inputKey,
+        memoryType: memoryType,
+        returnMessages: true
+    }
+
+    return new ZepMemoryExtended(obj)
+}
+
+interface ZepMemoryExtendedInput {
+    memoryType?: 'perpetual' | 'message_window'
+}
+
+class ZepMemoryExtended extends ZepMemory implements MemoryMethods {
+    memoryType: 'perpetual' | 'message_window'
+
+    constructor(fields: ZepMemoryInput & ZepMemoryExtendedInput) {
+        super(fields)
+        this.memoryType = fields.memoryType ?? 'perpetual'
+    }
+
+    async loadMemoryVariables(values: InputValues, overrideSessionId = ''): Promise<MemoryVariables> {
+        if (overrideSessionId) {
+            this.sessionId = overrideSessionId
+        }
+        return super.loadMemoryVariables({ ...values, memoryType: this.memoryType })
+    }
+
+    async saveContext(inputValues: InputValues, outputValues: OutputValues, overrideSessionId = ''): Promise<void> {
+        if (overrideSessionId) {
+            this.sessionId = overrideSessionId
+        }
+        return super.saveContext(inputValues, outputValues)
+    }
+
+    async clear(overrideSessionId = ''): Promise<void> {
+        if (overrideSessionId) {
+            this.sessionId = overrideSessionId
+        }
+        return super.clear()
+    }
+
+    async getChatMessages(overrideSessionId = '', returnBaseMessages = false): Promise<IMessage[] | BaseMessage[]> {
+        const id = overrideSessionId ? overrideSessionId : this.sessionId
+        const memoryVariables = await this.loadMemoryVariables({}, id)
+        const baseMessages = memoryVariables[this.memoryKey]
+        return returnBaseMessages ? baseMessages : convertBaseMessagetoIMessage(baseMessages)
+    }
+
+    async addChatMessages(msgArray: { text: string; type: MessageType }[], overrideSessionId = ''): Promise<void> {
+        const id = overrideSessionId ? overrideSessionId : this.sessionId
+        const input = msgArray.find((msg) => msg.type === 'userMessage')
+        const output = msgArray.find((msg) => msg.type === 'apiMessage')
+        const inputValues = { [this.inputKey ?? 'input']: input?.text }
+        const outputValues = { output: output?.text }
+
+        await this.saveContext(inputValues, outputValues, id)
+    }
+
+    async clearChatMessages(overrideSessionId = ''): Promise<void> {
+        const id = overrideSessionId ? overrideSessionId : this.sessionId
+        await this.clear(id)
+    }
+}
+
+module.exports = { nodeClass: ZepMemoryCloud_Memory }
@@ -0,0 +1,19 @@
+<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
+<circle cx="16" cy="16" r="14" fill="url(#paint0_linear_119_15736)"/>
+<path d="M12.6665 9.33333V12.6667H19.3332V9.33333C19.3332 8.59695 18.7362 8 17.9998 8H13.9998C13.2635 8 12.6665 8.59695 12.6665 9.33333Z" fill="white" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M19.3333 14.6667H12.6667C12.2985 14.6667 12 14.9652 12 15.3334V18.0001C12 18.3683 12.2985 18.6667 12.6667 18.6667H19.3333C19.7015 18.6667 20 18.3683 20 18.0001V15.3334C20 14.9652 19.7015 14.6667 19.3333 14.6667Z" fill="white" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M10 14.6667V20.0001" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M22 14.6667V20.0001" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M14 20.6667V24.0001" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M18 20.6667V24.0001" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M13.3335 24.6667H14.6668" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M17.3335 24.6667H18.6668" stroke="white" stroke-width="1.33333" stroke-linecap="round" stroke-linejoin="round"/>
+<circle cx="14.3889" cy="10.0556" r="0.888889" fill="#7734A6"/>
+<circle cx="17.7224" cy="10.0556" r="0.888889" fill="#7734A6"/>
+<defs>
+<linearGradient id="paint0_linear_119_15736" x1="5.5" y1="6.5" x2="24.5" y2="26" gradientUnits="userSpaceOnUse">
+<stop stop-color="#6A31A6"/>
+<stop offset="1" stop-color="#9A3BA3"/>
+</linearGradient>
+</defs>
+</svg>