elsium-ai 0.1.6 → 0.1.7
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 +94 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/elsium-ai/elsium-ai" target="blank"><img src="https://raw.githubusercontent.com/elsium-ai/elsium-ai/main/assets/logo.png" width="320" alt="ElsiumAI Logo" /></a>
|
|
3
|
+
</p>
|
|
4
|
+
<h3 align="center">Reliability. Governance. Reproducible AI.</h3>
|
|
5
|
+
<p align="center">The TypeScript framework for AI systems you can trust in production.</p>
|
|
6
|
+
<p align="center">
|
|
7
|
+
<a href="https://github.com/elsium-ai/elsium-ai/actions"><img src="https://github.com/elsium-ai/elsium-ai/workflows/CI/badge.svg" alt="CI"></a>
|
|
8
|
+
<a href="https://github.com/elsium-ai/elsium-ai/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
|
|
9
|
+
<a href="https://www.npmjs.com/package/elsium-ai"><img src="https://img.shields.io/npm/v/elsium-ai.svg" alt="npm"></a>
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
> **AI systems must fail predictably.**
|
|
15
|
+
> **AI systems must be auditable.**
|
|
16
|
+
> **AI systems must be reproducible.**
|
|
17
|
+
> **AI systems must be governed by policy, not hope.**
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Install
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install elsium-ai
|
|
25
|
+
# or
|
|
26
|
+
bun add elsium-ai
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
This umbrella package re-exports all ElsiumAI modules. You can also install individual packages for smaller bundles.
|
|
30
|
+
|
|
31
|
+
## Quick Start
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import { gateway } from 'elsium-ai'
|
|
35
|
+
import { defineAgent } from 'elsium-ai'
|
|
36
|
+
import { env } from 'elsium-ai'
|
|
37
|
+
|
|
38
|
+
const llm = gateway({
|
|
39
|
+
provider: 'anthropic',
|
|
40
|
+
model: 'claude-sonnet-4-6',
|
|
41
|
+
apiKey: env('ANTHROPIC_API_KEY'),
|
|
42
|
+
})
|
|
43
|
+
|
|
44
|
+
const agent = defineAgent(
|
|
45
|
+
{ name: 'assistant', system: 'You are a helpful assistant.' },
|
|
46
|
+
{ complete: (req) => llm.complete(req) },
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
const result = await agent.run('What is TypeScript?')
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Three Pillars
|
|
53
|
+
|
|
54
|
+
| Pillar | The guarantee |
|
|
55
|
+
|--------|--------------|
|
|
56
|
+
| **Reliability** | Your system stays up when providers break — circuit breakers, bulkhead isolation, request dedup, graceful shutdown |
|
|
57
|
+
| **Governance** | You control who does what, and you can prove it — policy engine, RBAC, approval gates, hash-chained audit trail |
|
|
58
|
+
| **Reproducible AI** | Tools to measure, pin, and reproduce AI outputs — seed propagation, output pinning, provenance tracking, determinism assertions |
|
|
59
|
+
|
|
60
|
+
## Packages
|
|
61
|
+
|
|
62
|
+
| Package | Description |
|
|
63
|
+
|---------|-------------|
|
|
64
|
+
| [`@elsium-ai/core`](https://www.npmjs.com/package/@elsium-ai/core) | Types, errors, streaming, circuit breaker, dedup, policy engine, shutdown |
|
|
65
|
+
| [`@elsium-ai/gateway`](https://www.npmjs.com/package/@elsium-ai/gateway) | Multi-provider gateway, X-Ray, provider mesh, bulkhead, PII detection |
|
|
66
|
+
| [`@elsium-ai/agents`](https://www.npmjs.com/package/@elsium-ai/agents) | Agents, memory, guardrails, approval gates, multi-agent |
|
|
67
|
+
| [`@elsium-ai/tools`](https://www.npmjs.com/package/@elsium-ai/tools) | Tool definitions with Zod validation |
|
|
68
|
+
| [`@elsium-ai/rag`](https://www.npmjs.com/package/@elsium-ai/rag) | Document loading, chunking, embeddings, vector search |
|
|
69
|
+
| [`@elsium-ai/workflows`](https://www.npmjs.com/package/@elsium-ai/workflows) | Sequential, parallel, and branching workflows |
|
|
70
|
+
| [`@elsium-ai/observe`](https://www.npmjs.com/package/@elsium-ai/observe) | Tracing, cost intelligence, audit trail, provenance tracking |
|
|
71
|
+
| [`@elsium-ai/mcp`](https://www.npmjs.com/package/@elsium-ai/mcp) | Bidirectional MCP client and server |
|
|
72
|
+
| [`@elsium-ai/app`](https://www.npmjs.com/package/@elsium-ai/app) | HTTP server, CORS, auth, rate limiting, RBAC |
|
|
73
|
+
| [`@elsium-ai/testing`](https://www.npmjs.com/package/@elsium-ai/testing) | Mocks, evals, pinning, determinism assertions, prompt versioning |
|
|
74
|
+
| [`@elsium-ai/cli`](https://www.npmjs.com/package/@elsium-ai/cli) | Scaffolding, dev server, X-Ray inspection |
|
|
75
|
+
|
|
76
|
+
## Performance
|
|
77
|
+
|
|
78
|
+
Measured with zero-latency mock provider to isolate framework cost.
|
|
79
|
+
|
|
80
|
+
| Metric | P50 | P95 | Conditions |
|
|
81
|
+
|---|:---:|:---:|---|
|
|
82
|
+
| Core completion path | 2.3us | 5.5us | Agent, no middleware |
|
|
83
|
+
| Full governance stack | 6.2us | 9.5us | Security + audit + policy + cost + xray + logging |
|
|
84
|
+
| Under concurrency | 5.0us | 6.4us | 100 parallel requests, full stack |
|
|
85
|
+
|
|
86
|
+
Framework cost contribution: <0.01% of total request time.
|
|
87
|
+
|
|
88
|
+
## Documentation
|
|
89
|
+
|
|
90
|
+
Full documentation, architecture diagrams, and examples at [github.com/elsium-ai/elsium-ai](https://github.com/elsium-ai/elsium-ai).
|
|
91
|
+
|
|
92
|
+
## License
|
|
93
|
+
|
|
94
|
+
[MIT](https://github.com/elsium-ai/elsium-ai/blob/main/LICENSE) - Copyright (c) 2026 Eric Utrera
|