overai 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -11
- package/dist/index.d.ts +1 -1
- package/dist/index.js +9 -8
- package/package.json +5 -8
package/README.md
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
OverAI is a production-ready Multi AI Agents framework, designed to create AI Agents to automate and solve problems ranging from simple tasks to complex challenges. It provides a low-code solution to streamline the building and management of multi-agent LLM systems, emphasising simplicity, customisation, and effective human-agent collaboration.
|
|
4
4
|
|
|
5
|
+
## Why OverAI? (vs n8n and others)
|
|
6
|
+
|
|
7
|
+
While visual workflow tools like **n8n** are excellent for linear automation, **OverAI** is designed for the next generation of intelligent orchestration:
|
|
8
|
+
|
|
9
|
+
- **Code-First Autonomy**: Move beyond rigid flowcharts. Define complex, dynamic agent behaviors using standard TypeScript/JavaScript that can adapt to changing contexts.
|
|
10
|
+
- **True Multi-Agent Collaboration**: Agents don't just pass data; they communicate, delegate tasks, critique each other's work, and solve problems iteratively.
|
|
11
|
+
- **Production-Grade Engineering**: Built for developers. Benefit from Git version control, TypeScript type safety, CI/CD integration, and easy debugging—things that are hard to do with visual drag-and-drop tools.
|
|
12
|
+
- **Deep Embedding**: Don't just call an external webhook. Embed powerful AI agents directly into your existing backend services and APIs.
|
|
13
|
+
|
|
5
14
|
## Installation
|
|
6
15
|
|
|
7
16
|
```bash
|
|
@@ -12,8 +21,8 @@ npm install overai
|
|
|
12
21
|
|
|
13
22
|
1. Clone the repository:
|
|
14
23
|
```bash
|
|
15
|
-
git clone https://github.com/
|
|
16
|
-
cd
|
|
24
|
+
git clone https://github.com/your-username/overai.git
|
|
25
|
+
cd overai
|
|
17
26
|
```
|
|
18
27
|
|
|
19
28
|
2. Install dependencies:
|
|
@@ -33,7 +42,7 @@ Here are examples of different ways to use OverAI:
|
|
|
33
42
|
### 1. Single Agent Example
|
|
34
43
|
|
|
35
44
|
```typescript
|
|
36
|
-
import { Agent,
|
|
45
|
+
import { Agent, OverAI } from 'overai';
|
|
37
46
|
|
|
38
47
|
async function main() {
|
|
39
48
|
// Create a simple agent (no task specified)
|
|
@@ -44,7 +53,7 @@ async function main() {
|
|
|
44
53
|
});
|
|
45
54
|
|
|
46
55
|
// Run the agent
|
|
47
|
-
const
|
|
56
|
+
const overAI = new OverAI({
|
|
48
57
|
agents: [agent],
|
|
49
58
|
tasks: ["Explain the process of photosynthesis in detail."],
|
|
50
59
|
verbose: true
|
|
@@ -52,7 +61,7 @@ async function main() {
|
|
|
52
61
|
|
|
53
62
|
try {
|
|
54
63
|
console.log('Starting single agent example...');
|
|
55
|
-
const results = await
|
|
64
|
+
const results = await overAI.start();
|
|
56
65
|
console.log('\nFinal Results:', results);
|
|
57
66
|
} catch (error) {
|
|
58
67
|
console.error('Error:', error);
|
|
@@ -65,7 +74,7 @@ main();
|
|
|
65
74
|
### 2. Multi-Agent Example
|
|
66
75
|
|
|
67
76
|
```typescript
|
|
68
|
-
import { Agent,
|
|
77
|
+
import { Agent, OverAI } from 'overai';
|
|
69
78
|
|
|
70
79
|
async function main() {
|
|
71
80
|
// Create multiple agents with different roles
|
|
@@ -88,7 +97,7 @@ async function main() {
|
|
|
88
97
|
});
|
|
89
98
|
|
|
90
99
|
// Run the agents in sequence
|
|
91
|
-
const
|
|
100
|
+
const overAI = new OverAI({
|
|
92
101
|
agents: [researchAgent, summaryAgent, recommendationAgent],
|
|
93
102
|
tasks: [
|
|
94
103
|
"Research and analyze current renewable energy technologies and their implementation.",
|
|
@@ -100,7 +109,7 @@ async function main() {
|
|
|
100
109
|
|
|
101
110
|
try {
|
|
102
111
|
console.log('Starting multi-agent example...');
|
|
103
|
-
const results = await
|
|
112
|
+
const results = await overAI.start();
|
|
104
113
|
console.log('\nFinal Results:', results);
|
|
105
114
|
} catch (error) {
|
|
106
115
|
console.error('Error:', error);
|
|
@@ -113,7 +122,7 @@ main();
|
|
|
113
122
|
### 3. Task-Based Agent Example
|
|
114
123
|
|
|
115
124
|
```typescript
|
|
116
|
-
import { Agent, Task,
|
|
125
|
+
import { Agent, Task, OverAI } from 'overai';
|
|
117
126
|
|
|
118
127
|
async function main() {
|
|
119
128
|
// Create agents first
|
|
@@ -161,14 +170,14 @@ The blog post should:
|
|
|
161
170
|
});
|
|
162
171
|
|
|
163
172
|
// Run the tasks
|
|
164
|
-
const
|
|
173
|
+
const overAI = new OverAI({
|
|
165
174
|
tasks: [createRecipesTask, writeBlogTask],
|
|
166
175
|
verbose: true
|
|
167
176
|
});
|
|
168
177
|
|
|
169
178
|
try {
|
|
170
179
|
console.log('Starting task-based example...');
|
|
171
|
-
const results = await
|
|
180
|
+
const results = await overAI.start();
|
|
172
181
|
console.log('\nFinal Results:', results);
|
|
173
182
|
} catch (error) {
|
|
174
183
|
console.error('Error:', error);
|
package/dist/index.d.ts
CHANGED
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
* await agents.start();
|
|
37
37
|
* ```
|
|
38
38
|
*/
|
|
39
|
-
export { Agent, Agents, PraisonAIAgents, Router } from './agent';
|
|
39
|
+
export { Agent, Agents, PraisonAIAgents, Router, PraisonAIAgents as OverAI } from './agent';
|
|
40
40
|
export type { SimpleAgentConfig, PraisonAIAgentsConfig, SimpleRouterConfig, SimpleRouteConfig } from './agent';
|
|
41
41
|
export { Workflow, parallel, route, loop, repeat } from './workflows';
|
|
42
42
|
export type { WorkflowStep, WorkflowContext, StepResult } from './workflows';
|
package/dist/index.js
CHANGED
|
@@ -52,14 +52,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
52
52
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
53
53
|
};
|
|
54
54
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
55
|
-
exports.
|
|
56
|
-
exports.
|
|
57
|
-
exports.
|
|
58
|
-
exports.
|
|
59
|
-
exports.
|
|
60
|
-
exports.
|
|
61
|
-
exports.
|
|
62
|
-
exports.createCLIApprovalPrompt = exports.createComputerUseAgent = exports.ComputerUseClient = exports.createComputerUse = exports.createPostgresTool = exports.NLPostgresClient = exports.createNLPostgres = exports.parseSlackMessage = exports.verifySlackSignature = exports.SlackBot = exports.createSlackBot = exports.createTelemetrySettings = exports.clearEvents = exports.getEvents = exports.recordEvent = exports.createTelemetryMiddleware = exports.withSpan = exports.createAISpan = exports.getTracer = exports.initOpenTelemetry = exports.isTelemetryEnabled = exports.disableAITelemetry = exports.enableAITelemetry = exports.getTelemetrySettings = exports.configureTelemetry = exports.autoEnableDevTools = exports.createDevToolsMiddleware = exports.getDevToolsUrl = exports.getDevToolsState = exports.isDevToolsEnabled = exports.disableDevTools = exports.enableDevTools = exports.TRANSCRIPTION_MODELS = void 0;
|
|
55
|
+
exports.superagentGuard = exports.firecrawlCrawl = exports.firecrawlScrape = exports.parallelSearch = exports.perplexitySearch = exports.exaSearch = exports.tavilyCrawl = exports.tavilyExtract = exports.tavilySearch = exports.codeExecution = exports.composeMiddleware = exports.createValidationMiddleware = exports.createTracingMiddleware = exports.createRetryMiddleware = exports.createRateLimitMiddleware = exports.createRedactionMiddleware = exports.createTimeoutMiddleware = exports.createLoggingMiddleware = exports.MissingEnvVarError = exports.MissingDependencyError = exports.ToolsRegistry = exports.resetToolsRegistry = exports.createToolsRegistry = exports.getToolsRegistry = exports.registerBuiltinTools = exports.tools = exports.getTool = exports.registerTool = exports.getRegistry = exports.ToolRegistry = exports.tool = exports.FunctionTool = exports.createTool = exports.validateTool = exports.ToolValidationError = exports.BaseTool = exports.setDefaultDbAdapter = exports.getDefaultDbAdapter = exports.createDbAdapter = exports.db = exports.repeat = exports.loop = exports.route = exports.parallel = exports.Workflow = exports.OverAI = exports.Router = exports.PraisonAIAgents = exports.Agents = exports.Agent = void 0;
|
|
56
|
+
exports.enableTelemetry = exports.getTelemetry = exports.AgentTelemetry = exports.TelemetryCollector = exports.DEFAULT_POLICIES = exports.createLLMSummarizer = exports.createAutoMemory = exports.AutoMemory = exports.createFileMemory = exports.FileMemory = exports.createMemory = exports.Memory = exports.CLI_SPEC_VERSION = exports.executeCommand = exports.parseArgs = exports.parseSkillFile = exports.createSkillManager = exports.SkillManager = exports.EvalSuite = exports.reliabilityEval = exports.performanceEval = exports.accuracyEval = exports.createContextAgent = exports.ContextAgent = exports.routeConditions = exports.createRouter = exports.RouterAgent = exports.handoffFilters = exports.handoff = exports.Handoff = exports.registerLocalTool = exports.registerNpmTool = exports.createCustomTool = exports.registerCustomTool = exports.codeMode = exports.airweaveSearch = exports.bedrockBrowserFill = exports.bedrockBrowserClick = exports.bedrockBrowserNavigate = exports.bedrockCodeInterpreter = exports.valyuCompanyResearch = exports.valyuEconomicsSearch = exports.valyuSecSearch = exports.valyuPatentSearch = exports.valyuBioSearch = exports.valyuPaperSearch = exports.valyuFinanceSearch = exports.valyuWebSearch = exports.superagentVerify = exports.superagentRedact = void 0;
|
|
57
|
+
exports.QdrantVectorStore = exports.createWeaviateStore = exports.WeaviateVectorStore = exports.createPineconeStore = exports.PineconeVectorStore = exports.createMemoryVectorStore = exports.MemoryVectorStore = exports.BaseVectorStore = exports.validateWorkflowDefinition = exports.loadWorkflowFromFile = exports.createWorkflowFromYAML = exports.parseYAMLWorkflow = exports.createPubSub = exports.createEventBus = exports.AgentEvents = exports.AgentEventBus = exports.EventEmitterPubSub = exports.PubSub = exports.createFileCache = exports.createMemoryCache = exports.FileCache = exports.MemoryCache = exports.BaseCache = exports.createTaskAgent = exports.createPlanningAgent = exports.createPlanStorage = exports.createTodoList = exports.createPlan = exports.TaskAgent = exports.PlanningAgent = exports.PlanStorage = exports.TodoItem = exports.TodoList = exports.PlanStep = exports.Plan = exports.createLLMGuardrail = exports.LLMGuardrail = exports.createPromptExpanderAgent = exports.PromptExpanderAgent = exports.createQueryRewriterAgent = exports.QueryRewriterAgent = exports.createDeepResearchAgent = exports.DeepResearchAgent = exports.createImageAgent = exports.ImageAgent = exports.createAutoAgents = exports.AutoAgents = exports.createAgentTelemetry = exports.cleanupTelemetry = exports.disableTelemetry = void 0;
|
|
58
|
+
exports.createMemoryAdapter = exports.MemoryObservabilityAdapter = exports.noopAdapter = exports.NoopObservabilityAdapter = exports.hasObservabilityToolEnvVar = exports.listObservabilityTools = exports.getObservabilityToolInfo = exports.OBSERVABILITY_TOOLS = exports.registerBuiltinProviders = exports.createProviderRegistry = exports.getDefaultRegistry = exports.listProviders = exports.hasProvider = exports.unregisterProvider = exports.registerProvider = exports.ProviderRegistry = exports.BaseProvider = exports.GoogleProvider = exports.AnthropicProvider = exports.OpenAIProvider = exports.getAvailableProviders = exports.isProviderAvailable = exports.parseModelString = exports.getDefaultProvider = exports.createProvider = exports.createGraphRAG = exports.GraphRAG = exports.GraphStore = exports.createLLMReranker = exports.createCrossEncoderReranker = exports.createCohereReranker = exports.LLMReranker = exports.CrossEncoderReranker = exports.CohereReranker = exports.BaseReranker = exports.createElevenLabsVoice = exports.createOpenAIVoice = exports.ElevenLabsVoiceProvider = exports.OpenAIVoiceProvider = exports.BaseVoiceProvider = exports.createLangfuseObservability = exports.createMemoryObservability = exports.createConsoleObservability = exports.LangfuseObservabilityProvider = exports.MemoryObservabilityProvider = exports.ConsoleObservabilityProvider = exports.BaseObservabilityProvider = exports.createChromaStore = exports.ChromaVectorStore = exports.createQdrantStore = void 0;
|
|
59
|
+
exports.cronExpressions = exports.createScheduler = exports.Scheduler = exports.MODE_POLICIES = exports.cliApprovalPrompt = exports.createAutonomyManager = exports.AutonomyManager = exports.DEFAULT_BLOCKED_PATHS = exports.DEFAULT_BLOCKED_COMMANDS = exports.CommandValidator = exports.sandboxExec = exports.createSandboxExecutor = exports.SandboxExecutor = exports.createDiffViewer = exports.DiffViewer = exports.createGitManager = exports.GitManager = exports.DEFAULT_IGNORE_PATTERNS = exports.getRepoTree = exports.createRepoMap = exports.RepoMap = exports.createHistoryManager = exports.HistoryManager = exports.createStatusDisplay = exports.StatusDisplay = exports.createInteractiveTUI = exports.InteractiveTUI = exports.MODEL_PRICING = exports.formatCost = exports.estimateTokens = exports.createCostTracker = exports.CostTracker = exports.isSlashCommand = exports.executeSlashCommand = exports.parseSlashCommand = exports.registerCommand = exports.createSlashCommandHandler = exports.SlashCommandHandler = exports.ADAPTERS = exports.COMMUNITY_PROVIDERS = exports.PROVIDER_ALIASES = exports.AISDK_PROVIDERS = exports.trace = exports.resetObservabilityAdapter = exports.getObservabilityAdapter = exports.setObservabilityAdapter = exports.clearAdapterCache = exports.createObservabilityAdapter = exports.createConsoleAdapter = exports.ConsoleObservabilityAdapter = void 0;
|
|
60
|
+
exports.clearAICache = exports.applyMiddleware = exports.wrapModel = exports.createAILoggingMiddleware = exports.createCachingMiddleware = exports.resolveModelAlias = exports.hasModelAlias = exports.listModelAliases = exports.MODEL_ALIASES = exports.parseModel = exports.getModel = exports.createModel = exports.functionToTool = exports.createToolSet = exports.defineTool = exports.aiEmbedMany = exports.aiEmbed = exports.aiGenerateImage = exports.aiStreamObject = exports.aiGenerateObject = exports.aiStreamText = exports.aiGenerateText = exports.getQuickContext = exports.createFastContext = exports.FastContext = exports.triggerN8NWebhook = exports.createN8NIntegration = exports.N8NIntegration = exports.externalAgentAsTool = exports.createExternalAgent = exports.getExternalAgentRegistry = exports.GenericExternalAgent = exports.AiderAgent = exports.CodexCliAgent = exports.GeminiCliAgent = exports.ClaudeCodeAgent = exports.BaseExternalAgent = exports.renderWorkflow = exports.createFlowDisplay = exports.FlowDisplay = exports.createFileCheckpointStorage = exports.FileCheckpointStorage = exports.MemoryCheckpointStorage = exports.createCheckpointManager = exports.CheckpointManager = exports.createFileJobStorage = exports.FileJobStorage = exports.MemoryJobStorage = exports.createJobQueue = exports.JobQueue = void 0;
|
|
61
|
+
exports.transcribe = exports.generateSpeech = exports.createDangerousPatternChecker = exports.isDangerous = exports.DANGEROUS_PATTERNS = exports.ToolApprovalTimeoutError = exports.ToolApprovalDeniedError = exports.withApproval = exports.setApprovalManager = exports.getApprovalManager = exports.ApprovalManager = exports.pipeUIMessageStreamToResponse = exports.toUIMessageStreamResponse = exports.createApprovalResponse = exports.getToolsNeedingApproval = exports.hasPendingApprovals = exports.createSystemMessage = exports.createTextMessage = exports.safeValidateUIMessages = exports.validateUIMessages = exports.convertToUIMessages = exports.convertToModelMessages = exports.stopWhen = exports.stopWhenNoToolCalls = exports.stopAfterSteps = exports.AgentLoop = exports.createAgentLoop = exports.createPagesHandler = exports.createRouteHandler = exports.createNestHandler = exports.createFastifyHandler = exports.createHonoHandler = exports.createExpressHandler = exports.createHttpHandler = exports.mcpToolsToAITools = exports.closeAllMCPClients = exports.closeMCPClient = exports.getMCPClient = exports.createMCP = exports.isDataUrl = exports.isUrl = exports.uint8ArrayToBase64 = exports.base64ToUint8Array = exports.toMessageContent = exports.createMultimodalMessage = exports.createTextPart = exports.createPdfPart = exports.createFilePart = exports.createImagePart = exports.getAICacheStats = void 0;
|
|
62
|
+
exports.createCLIApprovalPrompt = exports.createComputerUseAgent = exports.ComputerUseClient = exports.createComputerUse = exports.createPostgresTool = exports.NLPostgresClient = exports.createNLPostgres = exports.parseSlackMessage = exports.verifySlackSignature = exports.SlackBot = exports.createSlackBot = exports.createTelemetrySettings = exports.clearEvents = exports.getEvents = exports.recordEvent = exports.createTelemetryMiddleware = exports.withSpan = exports.createAISpan = exports.getTracer = exports.initOpenTelemetry = exports.isTelemetryEnabled = exports.disableAITelemetry = exports.enableAITelemetry = exports.getTelemetrySettings = exports.configureTelemetry = exports.autoEnableDevTools = exports.createDevToolsMiddleware = exports.getDevToolsUrl = exports.getDevToolsState = exports.isDevToolsEnabled = exports.disableDevTools = exports.enableDevTools = exports.TRANSCRIPTION_MODELS = exports.SPEECH_MODELS = void 0;
|
|
63
63
|
// ============================================================================
|
|
64
64
|
// CORE API - The main classes users should use
|
|
65
65
|
// ============================================================================
|
|
@@ -69,6 +69,7 @@ Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { r
|
|
|
69
69
|
Object.defineProperty(exports, "Agents", { enumerable: true, get: function () { return agent_1.Agents; } });
|
|
70
70
|
Object.defineProperty(exports, "PraisonAIAgents", { enumerable: true, get: function () { return agent_1.PraisonAIAgents; } });
|
|
71
71
|
Object.defineProperty(exports, "Router", { enumerable: true, get: function () { return agent_1.Router; } });
|
|
72
|
+
Object.defineProperty(exports, "OverAI", { enumerable: true, get: function () { return agent_1.PraisonAIAgents; } });
|
|
72
73
|
// Workflow - Step-based workflow execution
|
|
73
74
|
var workflows_1 = require("./workflows");
|
|
74
75
|
Object.defineProperty(exports, "Workflow", { enumerable: true, get: function () { return workflows_1.Workflow; } });
|
package/package.json
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "overai",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.2",
|
|
4
4
|
"description": "OverAI TypeScript AI Agents Framework - Production-ready Multi-Agent System",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"files": [
|
|
8
|
-
"dist"
|
|
8
|
+
"dist",
|
|
9
|
+
"README.md",
|
|
10
|
+
"LICENSE"
|
|
9
11
|
],
|
|
10
12
|
"bin": {
|
|
11
13
|
"overai": "./dist/cli/index.js"
|
|
@@ -110,10 +112,5 @@
|
|
|
110
112
|
},
|
|
111
113
|
"engines": {
|
|
112
114
|
"node": ">=14.0.0"
|
|
113
|
-
}
|
|
114
|
-
"files": [
|
|
115
|
-
"dist",
|
|
116
|
-
"README.md",
|
|
117
|
-
"LICENSE"
|
|
118
|
-
]
|
|
115
|
+
}
|
|
119
116
|
}
|