teckel-ai 0.5.1 → 0.7.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 +40 -5
- package/dist/index.d.mts +410 -105
- package/dist/index.d.ts +410 -105
- package/dist/index.js +5 -2
- package/dist/index.mjs +5 -2
- package/dist/otel/index.d.mts +212 -0
- package/dist/otel/index.d.ts +212 -0
- package/dist/otel/index.js +5 -0
- package/dist/otel/index.mjs +5 -0
- package/dist/types-c7iVpo4d.d.mts +177 -0
- package/dist/types-c7iVpo4d.d.ts +177 -0
- package/package.json +28 -4
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# teckel-ai
|
|
2
2
|
|
|
3
|
-
TypeScript SDK for [Teckel AI](https://teckel.ai)
|
|
3
|
+
TypeScript SDK for [Teckel AI](https://teckel.ai) an agentic monitoring platform for tracking behavior and improving AI output.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -8,7 +8,7 @@ TypeScript SDK for [Teckel AI](https://teckel.ai)- Topic focused, RAG friendly,
|
|
|
8
8
|
npm install teckel-ai
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Quick Start
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
14
|
import { TeckelTracer } from 'teckel-ai';
|
|
@@ -25,13 +25,48 @@ tracer.trace({
|
|
|
25
25
|
await tracer.flush();
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
+
## OpenTelemetry Integration
|
|
29
|
+
|
|
30
|
+
Capture detailed spans from AI SDK calls:
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { TeckelTracer } from 'teckel-ai';
|
|
34
|
+
import { TeckelSpanCollector } from 'teckel-ai/otel';
|
|
35
|
+
|
|
36
|
+
const tracer = new TeckelTracer({ apiKey: process.env.TECKEL_API_KEY });
|
|
37
|
+
const spanCollector = new TeckelSpanCollector();
|
|
38
|
+
|
|
39
|
+
const result = await generateText({
|
|
40
|
+
model: openai('gpt-5-mini'),
|
|
41
|
+
prompt: userQuery,
|
|
42
|
+
experimental_telemetry: {
|
|
43
|
+
isEnabled: true,
|
|
44
|
+
tracer: spanCollector.getTracer()
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
const spans = spanCollector.getSpans();
|
|
49
|
+
|
|
50
|
+
// Tokens auto-aggregated from spans!
|
|
51
|
+
tracer.trace({
|
|
52
|
+
query: userQuery,
|
|
53
|
+
response: result.text,
|
|
54
|
+
spans
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
await spanCollector.shutdown();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Requires: `npm install @opentelemetry/api @opentelemetry/sdk-trace-base`
|
|
61
|
+
|
|
28
62
|
## Documentation
|
|
29
63
|
|
|
30
|
-
Full
|
|
64
|
+
Full documentation at [docs.teckel.ai](https://docs.teckel.ai):
|
|
31
65
|
|
|
32
66
|
- [Getting Started](https://docs.teckel.ai/docs/getting_started)
|
|
33
|
-
- [SDK Reference](https://docs.teckel.ai/docs/typescript_sdk_reference)
|
|
34
|
-
- [
|
|
67
|
+
- [TypeScript SDK Reference](https://docs.teckel.ai/docs/typescript_sdk_reference)
|
|
68
|
+
- [OpenTelemetry Integration](https://docs.teckel.ai/docs/opentelemetry_integration)
|
|
69
|
+
- [HTTP API Reference](https://docs.teckel.ai/docs/http_api_reference)
|
|
35
70
|
|
|
36
71
|
## License
|
|
37
72
|
|