Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/develop/ai/agent-builder/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The agent builder will generate complete, working code examples for your chosen

## Features

- **Multiple programming languages**: Generate code in Python, with JavaScript (Node.js), Java, and C# coming soon
- **Multiple programming languages**: Generate code in Python and JavaScript (Node.js), with Java and C# coming soon
- **LLM integration**: Support for OpenAI, Anthropic Claude, and Llama 2
- **Redis optimized**: Uses Redis data structures for optimal performance

Expand Down
251 changes: 251 additions & 0 deletions static/code/agent-templates/javascript/conversational_agent.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
/*
* Redis Conversational Agent (Node.js)
* Uses node-redis with Redis Search for semantic message history
*
* Requires Redis Stack 6.2+ or Redis 8 with the Search module for JSON
* vector indexing. The vector field is stored as a JSON array of floats,
* which is the correct on-disk format for JSON-backed vector indexes.
*
* To run this code:
* Install dependencies:
* npm install redis openai dotenv
*
* Set environment variables:
* LLM_API_KEY=your_${formData.llmModel.toLowerCase()}_api_key
* LLM_API_BASE_URL=your_base_url (optional, default: ${CONFIG.models[formData.llmModel].baseUrl})
* LLM_MODEL=your_model_name (optional, default: ${CONFIG.models[formData.llmModel].defaultModel})
* EMBEDDING_MODEL=your_embed_model (optional, default: text-embedding-3-small)
* VECTOR_DIM=1536 (optional, must match your embedding model's output dimension)
* REDIS_URL=redis://localhost:6379
* (or use REDIS_HOST, REDIS_PORT, REDIS_PASSWORD, REDIS_USERNAME separately)
*/

require('dotenv').config();
const { createClient } = require('redis');
const OpenAI = require('openai');

const INDEX_NAME = 'message_history_idx';
const MESSAGE_PREFIX = 'message:';
const RECENT_KEY = (session) => `recent:${session}`;
const EMBEDDING_MODEL = process.env.EMBEDDING_MODEL || 'text-embedding-3-small';
const VECTOR_DIM = parseInt(process.env.VECTOR_DIM) || 1536;
const RECENT_WINDOW = 6; // always include this many recent turns in context
const SEMANTIC_TOP_K = 4; // additional turns retrieved by semantic similarity
const MAX_CONTENT_CHARS = 2000;

class ConversationalAgent {
constructor(sessionName = 'chat') {
this.sessionName = sessionName;
this.messageCount = 0;
this._dimValidated = false;

this.llmApiKey = process.env.LLM_API_KEY;
if (!this.llmApiKey) throw new Error('LLM_API_KEY environment variable is required');

this.llmBaseUrl = process.env.LLM_API_BASE_URL || '${CONFIG.models[formData.llmModel].baseUrl}';
this.llmModel = process.env.LLM_MODEL || '${CONFIG.models[formData.llmModel].defaultModel}';

this.openai = new OpenAI({ apiKey: this.llmApiKey, baseURL: this.llmBaseUrl });
this.redisClient = null;
}

async connect() {
const clientOptions = process.env.REDIS_URL
? { url: process.env.REDIS_URL }
: {
socket: {
host: process.env.REDIS_HOST || 'localhost',
port: parseInt(process.env.REDIS_PORT) || 6379,
},
password: process.env.REDIS_PASSWORD || undefined,
username: process.env.REDIS_USERNAME || 'default',
};

this.redisClient = createClient(clientOptions);
this.redisClient.on('error', (err) => console.error('Redis error:', err));
await this.redisClient.connect();
console.log('Connected to Redis successfully');

await this._ensureIndex();
console.log('LLM configured:', this.llmModel);
console.log('Embedding model:', EMBEDDING_MODEL, `(VECTOR_DIM=${VECTOR_DIM})`);
}

async _ensureIndex() {
try {
await this.redisClient.ft.info(INDEX_NAME);
} catch {
await this.redisClient.ft.create(
INDEX_NAME,
{
'$.role': { type: 'TAG', AS: 'role' },
'$.content': { type: 'TEXT', AS: 'content' },
'$.session': { type: 'TAG', AS: 'session' },
'$.embedding': {
type: 'VECTOR',
AS: 'embedding',
ALGORITHM: 'FLAT',
TYPE: 'FLOAT32',
DIM: VECTOR_DIM,
DISTANCE_METRIC: 'COSINE',
},
},
{ ON: 'JSON', PREFIX: MESSAGE_PREFIX }
);
console.log('Created search index:', INDEX_NAME);
}
}

async _embed(text) {
const response = await this.openai.embeddings.create({
model: EMBEDDING_MODEL,
input: text,
});
const embedding = response.data[0].embedding;

// Validate dimension on first call. If this throws, either set VECTOR_DIM
// to the correct value in your environment, or recreate the index.
if (!this._dimValidated) {
if (embedding.length !== VECTOR_DIM) {
throw new Error(
`Embedding model '${EMBEDDING_MODEL}' returned ${embedding.length} dimensions ` +
`but VECTOR_DIM is ${VECTOR_DIM}. ` +
`Set VECTOR_DIM=${embedding.length} and recreate the index.`
);
}
this._dimValidated = true;
}

return embedding; // plain JS number array
}

_toQueryBuffer(embedding) {
return Buffer.from(new Float32Array(embedding).buffer);
}

async _storeMessage(role, content) {
const truncated = content.slice(0, MAX_CONTENT_CHARS);
const embedding = await this._embed(truncated);
const key = `${MESSAGE_PREFIX}${this.sessionName}:${Date.now()}_${this.messageCount++}`;

await this.redisClient.json.set(key, '$', {
role,
content: truncated,
session: this.sessionName,
embedding, // stored as JSON array of floats, required for JSON vector index
});

// Track insertion order for recent-turn retrieval
await this.redisClient.rPush(RECENT_KEY(this.sessionName), key);
await this.redisClient.lTrim(RECENT_KEY(this.sessionName), -RECENT_WINDOW * 4, -1);
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recent window retrieval ignores RECENT_WINDOW limit

Low Severity

RECENT_WINDOW is 6, described as "always include this many recent turns in context," but lTrim uses RECENT_WINDOW * 4 (keeping 24 items, i.e. 12 turns), and _getRecentMessages fetches all items via lRange(0, -1). The effective recent window is 12 turns — double the stated intent. The multiplier likely needs to be * 2 (user + assistant per turn), and/or retrieval needs to be bounded.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 3bf88f8. Configure here.

}

async _getRecentMessages() {
const keys = await this.redisClient.lRange(RECENT_KEY(this.sessionName), 0, -1);
if (!keys.length) return [];
const docs = await this.redisClient.json.mGet(keys, '$');
return docs
.filter(Boolean)
.flatMap((d) => d)
.filter(Boolean)
.map((m) => ({ role: m.role, content: m.content, _key: m._key }));
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deduplication broken because _key is always undefined

High Severity

In _getRecentMessages, m._key reads from the JSON document retrieved from Redis, but _storeMessage only stores { role, content, session, embedding } — there is no _key field. So m._key is always undefined for every recent message. In _buildContext, the seen set becomes Set([undefined]), meaning no semantic results are ever filtered out. The deduplication between recent and semantic messages is completely non-functional, causing duplicate messages in the LLM context. The keys array from lRange holds the actual Redis keys but is never mapped onto the returned objects.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 3bf88f8. Configure here.


async _getSemanticMessages(query) {
const queryBuffer = this._toQueryBuffer(await this._embed(query));
const results = await this.redisClient.ft.search(
INDEX_NAME,
`(@session:{${this.sessionName}})=>[KNN ${SEMANTIC_TOP_K} @embedding $vec AS score]`,
{
PARAMS: { vec: queryBuffer },
RETURN: ['role', 'content', '__key'],
SORTBY: { BY: 'score', DIRECTION: 'ASC' },
DIALECT: 2,
}
);
return results.documents.map((doc) => ({
role: doc.value.role,
content: doc.value.content,
_key: doc.id,
}));
}

async _buildContext(userInput) {
// Hybrid: recent turns for conversational coherence + semantic search for deeper context.
const [recent, semantic] = await Promise.all([
this._getRecentMessages().catch(() => []),
this._getSemanticMessages(userInput).catch(() => []),
]);

// Deduplicate by key, preserving recent turns first
const seen = new Set(recent.map((m) => m._key));
const extra = semantic.filter((m) => !seen.has(m._key));

return [...recent, ...extra].map(({ role, content }) => ({ role, content }));
}

async chat(userInput) {
const context = await this._buildContext(userInput);

const messages = [
{
role: 'system',
content: 'You are a helpful assistant that answers questions based on the conversation history.',
},
...context,
{ role: 'user', content: userInput },
];

const response = await this.openai.chat.completions.create({
model: this.llmModel,
messages,
});

const assistantResponse = response.choices[0]?.message?.content;
if (!assistantResponse) throw new Error('Empty response from LLM');

await this._storeMessage('user', userInput);
await this._storeMessage('assistant', assistantResponse);

return assistantResponse;
}

async disconnect() {
if (this.redisClient) await this.redisClient.disconnect();
}
}

async function main() {
const agent = new ConversationalAgent();
try {
await agent.connect();
console.log(await agent.chat('Tell me about yourself.'));
} catch (err) {
console.error('Failed to initialize agent:', err.message);
await agent.disconnect();
process.exit(1);
}

const readline = require('readline');
const rl = readline.createInterface({ input: process.stdin, output: process.stdout });

const askQuestion = () => {
rl.question('Enter a prompt: ', async (input) => {
if (['quit', 'exit', 'bye'].includes(input.toLowerCase())) {
console.log('Goodbye!');
rl.close();
await agent.disconnect();
return;
}
try {
console.log(await agent.chat(input));
} catch (err) {
console.error('Error:', err.message);
}
askQuestion();
});
};
askQuestion();
}

main();
Loading
Loading