diff --git a/examples/agents/agile-stories-agent/.env.baseai.example b/examples/agents/agile-stories-agent/.env.baseai.example new file mode 100644 index 00000000..8c643651 --- /dev/null +++ b/examples/agents/agile-stories-agent/.env.baseai.example @@ -0,0 +1,21 @@ +# !! SERVER SIDE ONLY !! +# Keep all your API keys secret — use only on the server side. + +# TODO: ADD: Both in your production and local env files. +# Langbase API key for your User or Org account. +# How to get this API key https://langbase.com/docs/api-reference/api-keys +LANGBASE_API_KEY= + +# TODO: ADD: LOCAL ONLY. Add only to local env files. +# Following keys are needed for local pipe runs. For providers you are using. +# For Langbase, please add the key to your LLM keysets. +# Read more: Langbase LLM Keysets https://langbase.com/docs/features/keysets +OPENAI_API_KEY= +ANTHROPIC_API_KEY= +COHERE_API_KEY= +FIREWORKS_API_KEY= +GOOGLE_API_KEY= +GROQ_API_KEY= +MISTRAL_API_KEY= +PERPLEXITY_API_KEY= +TOGETHER_API_KEY= diff --git a/examples/agents/agile-stories-agent/.gitignore b/examples/agents/agile-stories-agent/.gitignore new file mode 100644 index 00000000..c256453b --- /dev/null +++ b/examples/agents/agile-stories-agent/.gitignore @@ -0,0 +1,8 @@ +# baseai +**/.baseai/ +node_modules +.env +package-lock.json +pnpm-lock.yaml +# env file +.env diff --git a/examples/agents/agile-stories-agent/README.md b/examples/agents/agile-stories-agent/README.md new file mode 100644 index 00000000..42ead1fc --- /dev/null +++ b/examples/agents/agile-stories-agent/README.md @@ -0,0 +1,53 @@ +![Agile User Stories Agent by ⌘ BaseAI][cover] + +![License: MIT][mit] [![Fork on ⌘ Langbase][fork]][pipe] + +## Build an Agile User Stories Agent with BaseAI framework — ⌘ Langbase + +This AI Agent is built using the BaseAI framework. It leverages an agentic pipe that integrates over 30+ LLMs (including OpenAI, Gemini, Mistral, Llama, Gemma, etc.) and can handle any data, with context sizes of up to 10M+ tokens, supported by memory. The framework is compatible with any front-end framework (such as React, Remix, Astro, Next.js), giving you, as a developer, the freedom to tailor your AI application exactly as you envision. + +## Features + +- Agile User Stories Agent — Built with [BaseAI framework and agentic Pipe ⌘ ][qs]. +- Composable Agents — build and compose agents with BaseAI. +- Add and Sync deployed pipe on Langbase locally npx baseai@latest add ([see the Code button][pipe]). + +## Learn more + +1. Check the [Learning path to build an agentic AI pipe with ⌘ BaseAI][learn] +2. Read the [source code on GitHub][gh] for this agent example +3. Go through Documentaion: [Pipe Quick Start][qs] +4. Learn more about [Memory features in ⌘ BaseAI][memory] +5. Learn more about [Tool calls support in ⌘ BaseAI][toolcalls] + + +> NOTE: +> This is a BaseAI project, you can deploy BaseAI pipes, memory and tool calls on Langbase. + +--- + +## Authors + +This project is created by [Langbase][lb] team members, with contributions from: + +- Muhammad-Ali Danish - Software Engineer, [Langbase][lb]
+**_Built by ⌘ [Langbase.com][lb] — Ship hyper-personalized AI assistants with memory!_** + + +[lb]: https://langbase.com +[pipe]: https://langbase.com/examples/agile-user-stories-agent +[gh]: https://github.com/LangbaseInc/baseai/tree/main/examples/agents/agile-user-stories-agent +[cover]:https://raw.githubusercontent.com/LangbaseInc/docs-images/main/baseai/baseai-cover.png +[download]:https://download-directory.github.io/?url=https://github.com/LangbaseInc/baseai/tree/main/examples/agents/agile-user-stories-agent +[learn]:https://baseai.dev/learn +[memory]:https://baseai.dev/docs/memory/quickstart +[toolcalls]:https://baseai.dev/docs/tools/quickstart +[deploy]:https://baseai.dev/docs/deployment/authentication +[signup]: https://langbase.fyi/io +[qs]:https://baseai.dev/docs/pipe/quickstart +[docs]:https://baseai.dev/docs +[xaa]:https://x.com/MrAhmadAwais +[xab]:https://x.com/AhmadBilalDev +[local]:http://localhost:9000 +[mit]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&color=%23000000 +[fork]: https://img.shields.io/badge/FORK%20ON-%E2%8C%98%20Langbase-000000.svg?style=for-the-badge&logo=%E2%8C%98%20Langbase&logoColor=000000 \ No newline at end of file diff --git a/examples/agents/agile-stories-agent/baseai/baseai.config.ts b/examples/agents/agile-stories-agent/baseai/baseai.config.ts new file mode 100644 index 00000000..3c0328bc --- /dev/null +++ b/examples/agents/agile-stories-agent/baseai/baseai.config.ts @@ -0,0 +1,18 @@ +import type { BaseAIConfig } from 'baseai'; + +export const config: BaseAIConfig = { + log: { + isEnabled: false, + logSensitiveData: false, + pipe: true, + 'pipe.completion': true, + 'pipe.request': true, + 'pipe.response': true, + tool: true, + memory: true + }, + memory: { + useLocalEmbeddings: false + }, + envFilePath: '.env' +}; diff --git a/examples/agents/agile-stories-agent/baseai/pipes/agile-user-stories-agent.ts b/examples/agents/agile-stories-agent/baseai/pipes/agile-user-stories-agent.ts new file mode 100644 index 00000000..a4b09029 --- /dev/null +++ b/examples/agents/agile-stories-agent/baseai/pipes/agile-user-stories-agent.ts @@ -0,0 +1,42 @@ +import { PipeI } from '@baseai/core'; + +const pipeAgileUserStoriesAgent = (): PipeI => ({ + // Replace with your API key https://langbase.com/docs/api-reference/api-keys + apiKey: process.env.LANGBASE_API_KEY!, + name: `agile-user-stories-agent`, + description: ``, + status: `public`, + model: `openai:gpt-4o-mini`, + stream: true, + json: false, + store: true, + moderate: true, + top_p: 1, + max_tokens: 1000, + temperature: 0.7, + presence_penalty: 0, + frequency_penalty: 0, + stop: [], + tool_choice: 'auto', + parallel_tool_calls: true, + messages: [ + { + role: 'system', + content: + "You are an AI assistant and agent that specializing in software engineering and agile methodologies. Your role is to generate user stories and acceptance criteria based on the project requirements provided by the user. Please follow these guidelines:\n\nGuidelines:\n\n1. **Understand the Requirement**: Analyze the project requirement provided by the user. For example, a project requirement might be, 'We need a feature for users to reset their password.'\n\n2. **User Story Format**: Create user stories using the format: 'As a [type of user], I want [an action] so that [a benefit/value].' Ensure each story adheres to the SMART criteria (Specific, Measurable, Achievable, Relevant, Time-bound). For example, ensure the story is measurable: 'I want to reset my password within 5 minutes.'\n\n3. **Acceptance Criteria Format**: Use the Given-When-Then structure for acceptance criteria:\n - Given [a context]\n - When [an action is performed]\n - Then [a set of observable outcomes should occur]\n Ensure criteria are clear, concise, and testable, covering both positive and negative scenarios when appropriate.\n\n4. **Adaptability**: Generate 3-5 user stories or acceptance criteria per requirement by default, but adapt the quantity based on the complexity of the requirement. Adjust based on user feedback.\n\n5. **Proactive Clarification**: If the requirements are vague or incomplete, ask clarifying questions to ensure the most accurate stories and criteria. After generating stories and criteria, proactively ask the user for feedback or additional context to refine the output further.\n\n**Example Input**: 'We need a feature for users to reset their password.'\n\n**Example Output**:\n\n**User Stories**:\n1. As a registered user, I want to reset my password so that I can regain access to my account if I forget my credentials.\n2. As a security-conscious user, I want a secure method to reset my password so that I can protect my account from unauthorized access.\n\n**Acceptance Criteria**:\n1. Given a user has forgotten their password \n When they click on the \"Forgot Password\" link \n Then they should be prompted to enter their email address.\n2. Given a user has entered their email address for password reset \n When they submit the form \n Then a unique password reset link should be sent to their email.\n3. Given a user clicks on the password reset link \n When they enter a new password and confirm it \n Then their password should be updated, and they should be able to log in with the new password.\n\nHow can I assist you further with your project requirements?\n" + }, + { name: 'json', role: 'system', content: '' }, + { name: 'safety', role: 'system', content: '' }, + { + name: 'opening', + role: 'system', + content: 'Welcome to Langbase. Prompt away!' + }, + { name: 'rag', role: 'system', content: '' } + ], + variables: [], + tools: [], + memory: [] +}); + +export default pipeAgileUserStoriesAgent; diff --git a/examples/agents/agile-stories-agent/index.ts b/examples/agents/agile-stories-agent/index.ts new file mode 100644 index 00000000..4df03f16 --- /dev/null +++ b/examples/agents/agile-stories-agent/index.ts @@ -0,0 +1,57 @@ +import 'dotenv/config'; +import { Pipe } from '@baseai/core'; +import inquirer from 'inquirer'; +import ora from 'ora'; +import chalk from 'chalk'; +import pipeAgileUserStoriesAgent from './baseai/pipes/agile-user-stories-agent'; + + +const pipe = new Pipe(pipeAgileUserStoriesAgent()); + +async function main() { + + const initialSpinner = ora('Connecting to agile user stories agent...').start(); + try { + const { completion: initialUserStoriesAgentReps } = await pipe.run({ + messages: [{ role: 'user', content: 'Let me know how to use your services?' }], + }); + initialSpinner.stop(); + console.log(chalk.cyan('User Stories Agent response...')); + console.log(initialUserStoriesAgentReps); + } catch (error) { + initialSpinner.stop(); + console.error(chalk.red('Error processing initial request:'), error); + } + + while (true) { + const { userMsg } = await inquirer.prompt([ + { + type: 'input', + name: 'userMsg', + message: chalk.blue('Enter your query (or type "exit" to quit):'), + }, + ]); + + if (userMsg.toLowerCase() === 'exit') { + console.log(chalk.green('Goodbye!')); + break; + } + + const spinner = ora('Processing your request...').start(); + + try { + const { completion: userStoriesAgentResp } = await pipe.run({ + messages: [{ role: 'user', content: userMsg }], + }); + + spinner.stop(); + console.log(chalk.cyan('Agent:')); + console.log(userStoriesAgentResp); + } catch (error) { + spinner.stop(); + console.error(chalk.red('Error processing your request:'), error); + } + } +} + +main(); \ No newline at end of file diff --git a/examples/agents/agile-stories-agent/package.json b/examples/agents/agile-stories-agent/package.json new file mode 100644 index 00000000..f1fddee0 --- /dev/null +++ b/examples/agents/agile-stories-agent/package.json @@ -0,0 +1,22 @@ +{ + "name": "agile-user-stories-agent", + "version": "1.0.0", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "baseai": "baseai" + }, + "keywords": [], + "author": "", + "license": "ISC", + "description": "", + "dependencies": { + "@baseai/core": "^0.9.3", + "dotenv": "^16.4.5", + "inquirer": "^12.0.0", + "ora": "^8.1.0" + }, + "devDependencies": { + "baseai": "^0.9.3" + } +}