@axlsdk/axl 0.1.0 → 0.1.1
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 +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Core SDK for orchestrating agentic systems in TypeScript.
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install axl zod
|
|
8
|
+
npm install @axlsdk/axl zod
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## API
|
|
@@ -15,7 +15,7 @@ npm install axl zod
|
|
|
15
15
|
Define a tool with Zod input validation:
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import { tool } from 'axl';
|
|
18
|
+
import { tool } from '@axlsdk/axl';
|
|
19
19
|
import { z } from 'zod';
|
|
20
20
|
|
|
21
21
|
const calculator = tool({
|
|
@@ -36,7 +36,7 @@ const calculator = tool({
|
|
|
36
36
|
Define an agent with model, system prompt, tools, and handoffs:
|
|
37
37
|
|
|
38
38
|
```typescript
|
|
39
|
-
import { agent } from 'axl';
|
|
39
|
+
import { agent } from '@axlsdk/axl';
|
|
40
40
|
|
|
41
41
|
const researcher = agent({
|
|
42
42
|
name: 'researcher',
|
|
@@ -66,7 +66,7 @@ const dynamicAgent = agent({
|
|
|
66
66
|
Define a named workflow with typed input/output:
|
|
67
67
|
|
|
68
68
|
```typescript
|
|
69
|
-
import { workflow } from 'axl';
|
|
69
|
+
import { workflow } from '@axlsdk/axl';
|
|
70
70
|
import { z } from 'zod';
|
|
71
71
|
|
|
72
72
|
const myWorkflow = workflow({
|
|
@@ -85,7 +85,7 @@ const myWorkflow = workflow({
|
|
|
85
85
|
Register and execute workflows:
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
|
-
import { AxlRuntime } from 'axl';
|
|
88
|
+
import { AxlRuntime } from '@axlsdk/axl';
|
|
89
89
|
|
|
90
90
|
const runtime = new AxlRuntime();
|
|
91
91
|
runtime.register(myWorkflow);
|
|
@@ -165,7 +165,7 @@ const value = await ctx.checkpoint(async () => expensiveOperation());
|
|
|
165
165
|
Automatic span emission for every `ctx.*` primitive with cost-per-span attribution. Install `@opentelemetry/api` as an optional peer dependency.
|
|
166
166
|
|
|
167
167
|
```typescript
|
|
168
|
-
import { defineConfig, AxlRuntime } from 'axl';
|
|
168
|
+
import { defineConfig, AxlRuntime } from '@axlsdk/axl';
|
|
169
169
|
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
|
|
170
170
|
|
|
171
171
|
const config = defineConfig({
|
|
@@ -185,7 +185,7 @@ runtime.initializeTelemetry();
|
|
|
185
185
|
When disabled (default), `NoopSpanManager` provides zero overhead.
|
|
186
186
|
|
|
187
187
|
```typescript
|
|
188
|
-
import { createSpanManager, NoopSpanManager } from 'axl';
|
|
188
|
+
import { createSpanManager, NoopSpanManager } from '@axlsdk/axl';
|
|
189
189
|
```
|
|
190
190
|
|
|
191
191
|
### Memory Primitives
|
|
@@ -206,7 +206,7 @@ const profile = await ctx.recall('user-profile', { scope: 'global' });
|
|
|
206
206
|
Semantic recall requires a vector store and embedder configured on the runtime:
|
|
207
207
|
|
|
208
208
|
```typescript
|
|
209
|
-
import { AxlRuntime, InMemoryVectorStore, OpenAIEmbedder } from 'axl';
|
|
209
|
+
import { AxlRuntime, InMemoryVectorStore, OpenAIEmbedder } from '@axlsdk/axl';
|
|
210
210
|
|
|
211
211
|
const runtime = new AxlRuntime({
|
|
212
212
|
memory: {
|
|
@@ -282,13 +282,13 @@ import {
|
|
|
282
282
|
BudgetExceededError, // Budget limit exceeded
|
|
283
283
|
GuardrailError, // Guardrail blocked input or output
|
|
284
284
|
ToolDenied, // Agent tried to call unauthorized tool
|
|
285
|
-
} from 'axl';
|
|
285
|
+
} from '@axlsdk/axl';
|
|
286
286
|
```
|
|
287
287
|
|
|
288
288
|
### State Stores
|
|
289
289
|
|
|
290
290
|
```typescript
|
|
291
|
-
import { MemoryStore, SQLiteStore, RedisStore } from 'axl';
|
|
291
|
+
import { MemoryStore, SQLiteStore, RedisStore } from '@axlsdk/axl';
|
|
292
292
|
|
|
293
293
|
// In-memory (default)
|
|
294
294
|
const runtime = new AxlRuntime();
|