@illuma-ai/observability-core 0.1.0 → 0.2.0
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/dist/__tests__/core-client.test.d.ts +8 -0
- package/dist/__tests__/core-client.test.d.ts.map +1 -0
- package/dist/__tests__/core-client.test.js +844 -0
- package/dist/__tests__/core-client.test.js.map +1 -0
- package/dist/__tests__/generation-client.test.d.ts +8 -0
- package/dist/__tests__/generation-client.test.d.ts.map +1 -0
- package/dist/__tests__/generation-client.test.js +117 -0
- package/dist/__tests__/generation-client.test.js.map +1 -0
- package/dist/__tests__/span-client.test.d.ts +9 -0
- package/dist/__tests__/span-client.test.d.ts.map +1 -0
- package/dist/__tests__/span-client.test.js +272 -0
- package/dist/__tests__/span-client.test.js.map +1 -0
- package/dist/__tests__/trace-client.test.d.ts +9 -0
- package/dist/__tests__/trace-client.test.d.ts.map +1 -0
- package/dist/__tests__/trace-client.test.js +260 -0
- package/dist/__tests__/trace-client.test.js.map +1 -0
- package/dist/__tests__/types.test.d.ts +9 -0
- package/dist/__tests__/types.test.d.ts.map +1 -0
- package/dist/__tests__/types.test.js +453 -0
- package/dist/__tests__/types.test.js.map +1 -0
- package/dist/__tests__/utils.test.d.ts +7 -0
- package/dist/__tests__/utils.test.d.ts.map +1 -0
- package/dist/__tests__/utils.test.js +164 -0
- package/dist/__tests__/utils.test.js.map +1 -0
- package/dist/core-client.d.ts +1 -0
- package/dist/core-client.d.ts.map +1 -1
- package/dist/core-client.js +4 -0
- package/dist/core-client.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/span-client.d.ts +28 -0
- package/dist/span-client.d.ts.map +1 -1
- package/dist/span-client.js +92 -0
- package/dist/span-client.js.map +1 -1
- package/dist/trace-client.d.ts +35 -0
- package/dist/trace-client.d.ts.map +1 -1
- package/dist/trace-client.js +110 -0
- package/dist/trace-client.js.map +1 -1
- package/dist/types.d.ts +109 -7
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +40 -2
- package/dist/types.js.map +1 -1
- package/package.json +5 -2
package/dist/types.d.ts
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* Core types for the Illuma Observability SDK.
|
|
3
3
|
*
|
|
4
4
|
* This module is the single source of truth for all observability types.
|
|
5
|
-
* It mirrors the Langfuse ingestion API contract so payloads are wire-compatible
|
|
5
|
+
* It mirrors the Langfuse ingestion API contract so payloads are wire-compatible,
|
|
6
|
+
* and incorporates best patterns from Opik for comprehensive LLM observability.
|
|
6
7
|
*/
|
|
7
8
|
/** Observation severity / log level. */
|
|
8
9
|
export declare enum ObservationLevel {
|
|
@@ -11,9 +12,39 @@ export declare enum ObservationLevel {
|
|
|
11
12
|
WARNING = "WARNING",
|
|
12
13
|
ERROR = "ERROR"
|
|
13
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* Observation type discriminator.
|
|
17
|
+
* Matches the server's accepted types for rich categorization of spans.
|
|
18
|
+
*/
|
|
19
|
+
export declare enum ObservationType {
|
|
20
|
+
/** Generic span (default). */
|
|
21
|
+
SPAN = "SPAN",
|
|
22
|
+
/** LLM generation / completion call. */
|
|
23
|
+
GENERATION = "GENERATION",
|
|
24
|
+
/** Point-in-time event (no duration). */
|
|
25
|
+
EVENT = "EVENT",
|
|
26
|
+
/** Autonomous agent execution. */
|
|
27
|
+
AGENT = "AGENT",
|
|
28
|
+
/** Tool / function invocation. */
|
|
29
|
+
TOOL = "TOOL",
|
|
30
|
+
/** Chain execution (sequential pipeline). */
|
|
31
|
+
CHAIN = "CHAIN",
|
|
32
|
+
/** Retriever / vector search operation. */
|
|
33
|
+
RETRIEVER = "RETRIEVER",
|
|
34
|
+
/** Evaluator execution. */
|
|
35
|
+
EVALUATOR = "EVALUATOR",
|
|
36
|
+
/** Embedding operation. */
|
|
37
|
+
EMBEDDING = "EMBEDDING",
|
|
38
|
+
/** Guardrail / safety check. */
|
|
39
|
+
GUARDRAIL = "GUARDRAIL"
|
|
40
|
+
}
|
|
41
|
+
/** Score data type discriminator. */
|
|
42
|
+
export type ScoreDataType = 'NUMERIC' | 'BOOLEAN' | 'CATEGORICAL' | 'CORRECTION';
|
|
43
|
+
/** Score source — how the score was produced. */
|
|
44
|
+
export type ScoreSource = 'API' | 'EVAL' | 'ANNOTATION';
|
|
14
45
|
/**
|
|
15
46
|
* Ingestion event type constants.
|
|
16
|
-
* These match the
|
|
47
|
+
* These match the server's accepted event types so payloads are processed
|
|
17
48
|
* without any translation layer.
|
|
18
49
|
*/
|
|
19
50
|
export declare const IngestionEventType: {
|
|
@@ -23,7 +54,15 @@ export declare const IngestionEventType: {
|
|
|
23
54
|
readonly GENERATION_CREATE: "generation-create";
|
|
24
55
|
readonly GENERATION_UPDATE: "generation-update";
|
|
25
56
|
readonly EVENT_CREATE: "event-create";
|
|
57
|
+
readonly AGENT_CREATE: "agent-create";
|
|
58
|
+
readonly TOOL_CREATE: "tool-create";
|
|
59
|
+
readonly CHAIN_CREATE: "chain-create";
|
|
60
|
+
readonly RETRIEVER_CREATE: "retriever-create";
|
|
61
|
+
readonly EVALUATOR_CREATE: "evaluator-create";
|
|
62
|
+
readonly EMBEDDING_CREATE: "embedding-create";
|
|
63
|
+
readonly GUARDRAIL_CREATE: "guardrail-create";
|
|
26
64
|
readonly SCORE_CREATE: "score-create";
|
|
65
|
+
readonly DATASET_RUN_ITEM_CREATE: "dataset-run-item-create";
|
|
27
66
|
readonly SDK_LOG: "sdk-log";
|
|
28
67
|
};
|
|
29
68
|
export type IngestionEventType = (typeof IngestionEventType)[keyof typeof IngestionEventType];
|
|
@@ -65,6 +104,12 @@ export interface ObservabilityClientConfig {
|
|
|
65
104
|
* Helps correlate traces with deployments.
|
|
66
105
|
*/
|
|
67
106
|
release?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Environment name (e.g. "production", "staging", "development").
|
|
109
|
+
* Attached to all traces and observations for filtering.
|
|
110
|
+
* @default "default"
|
|
111
|
+
*/
|
|
112
|
+
environment?: string;
|
|
68
113
|
/**
|
|
69
114
|
* Per-request timeout in milliseconds for flush HTTP calls.
|
|
70
115
|
* @default 10000
|
|
@@ -96,6 +141,15 @@ export interface UsageParams {
|
|
|
96
141
|
* { "cachedTokens": 200, "audioTokens": 50 }
|
|
97
142
|
*/
|
|
98
143
|
export type UsageDetailsParams = Record<string, number>;
|
|
144
|
+
/** Structured error information (from Opik). */
|
|
145
|
+
export interface ErrorInfo {
|
|
146
|
+
/** Exception class / type name. */
|
|
147
|
+
exceptionType: string;
|
|
148
|
+
/** Human-readable error message. */
|
|
149
|
+
message?: string;
|
|
150
|
+
/** Full stack trace / traceback. */
|
|
151
|
+
traceback: string;
|
|
152
|
+
}
|
|
99
153
|
/** Parameters for creating or updating a trace. */
|
|
100
154
|
export interface TraceParams {
|
|
101
155
|
/** Client-generated trace ID. Auto-generated if omitted. */
|
|
@@ -120,6 +174,16 @@ export interface TraceParams {
|
|
|
120
174
|
version?: string;
|
|
121
175
|
/** ISO-8601 timestamp. Defaults to now. */
|
|
122
176
|
timestamp?: string;
|
|
177
|
+
/** Deployment release identifier (e.g. git SHA, semver). */
|
|
178
|
+
release?: string;
|
|
179
|
+
/** Environment name (e.g. "production", "staging"). Overrides client-level setting. */
|
|
180
|
+
environment?: string;
|
|
181
|
+
/** External system ID for correlation. */
|
|
182
|
+
externalId?: string;
|
|
183
|
+
/** Thread/conversation ID for grouping multi-turn interactions. */
|
|
184
|
+
threadId?: string;
|
|
185
|
+
/** Structured error information if the trace represents a failure. */
|
|
186
|
+
errorInfo?: ErrorInfo;
|
|
123
187
|
}
|
|
124
188
|
/** Parameters for creating or updating an LLM generation observation. */
|
|
125
189
|
export interface GenerationParams {
|
|
@@ -137,8 +201,10 @@ export interface GenerationParams {
|
|
|
137
201
|
endTime?: string;
|
|
138
202
|
/** ISO-8601 time of first token received (streaming). */
|
|
139
203
|
completionStartTime?: string;
|
|
140
|
-
/** Model identifier, e.g. "gpt-4o", "claude-
|
|
204
|
+
/** Model identifier, e.g. "gpt-4o", "claude-sonnet-4-20250514". */
|
|
141
205
|
model?: string;
|
|
206
|
+
/** LLM provider name (e.g. "openai", "anthropic", "aws_bedrock", "google"). */
|
|
207
|
+
provider?: string;
|
|
142
208
|
/** Model parameters (temperature, max_tokens, etc.). */
|
|
143
209
|
modelParameters?: Record<string, unknown>;
|
|
144
210
|
/** Prompt / messages sent to the model. */
|
|
@@ -147,8 +213,10 @@ export interface GenerationParams {
|
|
|
147
213
|
output?: unknown;
|
|
148
214
|
/** Token / cost usage. */
|
|
149
215
|
usage?: UsageParams;
|
|
150
|
-
/** Extended usage details for non-standard billing. */
|
|
216
|
+
/** Extended usage details for non-standard billing (e.g. cached_tokens, reasoning_tokens). */
|
|
151
217
|
usageDetails?: UsageDetailsParams;
|
|
218
|
+
/** Per-usage-type cost breakdown (e.g. { input: 0.015, output: 0.012 }). */
|
|
219
|
+
costDetails?: Record<string, number>;
|
|
152
220
|
/** Arbitrary metadata. */
|
|
153
221
|
metadata?: Record<string, unknown>;
|
|
154
222
|
/** Observation severity level. */
|
|
@@ -157,10 +225,14 @@ export interface GenerationParams {
|
|
|
157
225
|
statusMessage?: string;
|
|
158
226
|
/** Application version override. */
|
|
159
227
|
version?: string;
|
|
228
|
+
/** Environment override. */
|
|
229
|
+
environment?: string;
|
|
160
230
|
/** Reference to a prompt template ID managed in the UI. */
|
|
161
231
|
promptName?: string;
|
|
162
232
|
/** Version of the prompt template. */
|
|
163
233
|
promptVersion?: number;
|
|
234
|
+
/** Structured error information. */
|
|
235
|
+
errorInfo?: ErrorInfo;
|
|
164
236
|
}
|
|
165
237
|
/** Parameters for creating or updating a span observation. */
|
|
166
238
|
export interface SpanParams {
|
|
@@ -188,6 +260,18 @@ export interface SpanParams {
|
|
|
188
260
|
statusMessage?: string;
|
|
189
261
|
/** Application version override. */
|
|
190
262
|
version?: string;
|
|
263
|
+
/** Environment override. */
|
|
264
|
+
environment?: string;
|
|
265
|
+
/** Observation type for categorization (TOOL, AGENT, CHAIN, RETRIEVER, etc.). */
|
|
266
|
+
type?: ObservationType;
|
|
267
|
+
/** Model name (when a span wraps an LLM call). */
|
|
268
|
+
model?: string;
|
|
269
|
+
/** Provider name (when a span wraps an LLM call). */
|
|
270
|
+
provider?: string;
|
|
271
|
+
/** Token/cost usage (when a span wraps an LLM call). */
|
|
272
|
+
usage?: UsageParams;
|
|
273
|
+
/** Structured error information. */
|
|
274
|
+
errorInfo?: ErrorInfo;
|
|
191
275
|
}
|
|
192
276
|
/** Parameters for creating an event observation (no duration). */
|
|
193
277
|
export interface EventParams {
|
|
@@ -213,6 +297,8 @@ export interface EventParams {
|
|
|
213
297
|
statusMessage?: string;
|
|
214
298
|
/** Application version override. */
|
|
215
299
|
version?: string;
|
|
300
|
+
/** Environment override. */
|
|
301
|
+
environment?: string;
|
|
216
302
|
}
|
|
217
303
|
/** Parameters for creating a score (evaluation metric). */
|
|
218
304
|
export interface ScoreParams {
|
|
@@ -222,16 +308,32 @@ export interface ScoreParams {
|
|
|
222
308
|
traceId: string;
|
|
223
309
|
/** Optional observation within the trace to score. */
|
|
224
310
|
observationId?: string;
|
|
311
|
+
/** Optional session to attach this score to. */
|
|
312
|
+
sessionId?: string;
|
|
225
313
|
/** Score name / metric key, e.g. "accuracy", "helpfulness". */
|
|
226
314
|
name: string;
|
|
227
|
-
/** Numeric score value. */
|
|
315
|
+
/** Numeric score value (for NUMERIC/BOOLEAN). */
|
|
228
316
|
value: number;
|
|
317
|
+
/** String value (for CATEGORICAL scores). */
|
|
318
|
+
stringValue?: string;
|
|
229
319
|
/** Human-readable comment explaining the score. */
|
|
230
320
|
comment?: string;
|
|
231
|
-
/**
|
|
232
|
-
|
|
321
|
+
/**
|
|
322
|
+
* Data type of the score.
|
|
323
|
+
* - NUMERIC: arbitrary number
|
|
324
|
+
* - BOOLEAN: 0 or 1
|
|
325
|
+
* - CATEGORICAL: string value with optional categories
|
|
326
|
+
* - CORRECTION: ground truth / correction data
|
|
327
|
+
*/
|
|
328
|
+
dataType?: ScoreDataType;
|
|
329
|
+
/** How this score was produced. */
|
|
330
|
+
source?: ScoreSource;
|
|
331
|
+
/** Arbitrary metadata for the score. */
|
|
332
|
+
metadata?: Record<string, unknown>;
|
|
233
333
|
/** Optional config ID for score definitions managed in the UI. */
|
|
234
334
|
configId?: string;
|
|
335
|
+
/** Environment override. */
|
|
336
|
+
environment?: string;
|
|
235
337
|
}
|
|
236
338
|
/** A single event in the ingestion batch. */
|
|
237
339
|
export interface IngestionEvent {
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,wCAAwC;AACxC,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED;;;GAGG;AACH,oBAAY,eAAe;IACzB,8BAA8B;IAC9B,IAAI,SAAS;IACb,wCAAwC;IACxC,UAAU,eAAe;IACzB,yCAAyC;IACzC,KAAK,UAAU;IACf,kCAAkC;IAClC,KAAK,UAAU;IACf,kCAAkC;IAClC,IAAI,SAAS;IACb,6CAA6C;IAC7C,KAAK,UAAU;IACf,2CAA2C;IAC3C,SAAS,cAAc;IACvB,2BAA2B;IAC3B,SAAS,cAAc;IACvB,2BAA2B;IAC3B,SAAS,cAAc;IACvB,gCAAgC;IAChC,SAAS,cAAc;CACxB;AAED,qCAAqC;AACrC,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,GAAG,YAAY,CAAC;AAEjF,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,YAAY,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;CAgCrB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAM/D,uEAAuE;AACvE,MAAM,WAAW,yBAAyB;IACxC,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAElB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAMD,4CAA4C;AAC5C,MAAM,WAAW,WAAW;IAC1B,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+EAA+E;IAC/E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yBAAyB;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAMxD,gDAAgD;AAChD,MAAM,WAAW,SAAS;IACxB,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,mDAAmD;AACnD,MAAM,WAAW,WAAW;IAC1B,4DAA4D;IAC5D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,mDAAmD;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,gDAAgD;IAChD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uFAAuF;IACvF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAMD,yEAAyE;AACzE,MAAM,WAAW,gBAAgB;IAC/B,kEAAkE;IAClE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,2CAA2C;IAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sBAAsB;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,4EAA4E;IAC5E,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,kCAAkC;IAClC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAMD,8DAA8D;AAC9D,MAAM,WAAW,UAAU;IACzB,kEAAkE;IAClE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sBAAsB;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,kCAAkC;IAClC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,sBAAsB;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,oCAAoC;IACpC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAMD,kEAAkE;AAClE,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sBAAsB;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,kCAAkC;IAClC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,sBAAsB;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD,2DAA2D;AAC3D,MAAM,WAAW,WAAW;IAC1B,4DAA4D;IAC5D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,mCAAmC;IACnC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD,6CAA6C;AAC7C,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,+DAA+D;IAC/D,IAAI,EAAE,kBAAkB,CAAC;IACzB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,uDAAuD;IACvD,QAAQ,CAAC,EAAE;QACT,sDAAsD;QACtD,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,mBAAmB;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,gDAAgD;QAChD,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,iCAAiC;IACjC,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,0EAA0E;AAC1E,MAAM,WAAW,sBAAsB;IACrC,2CAA2C;IAC3C,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAClC,MAAM,EAAE,oBAAoB,EAAE,CAAC;CAChC;AAMD,6EAA6E;AAC7E,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,4EAA4E;AAC5E,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACzB,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,EAAE,EAAE,OAAO,CAAC;CACb"}
|
package/dist/types.js
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* Core types for the Illuma Observability SDK.
|
|
3
3
|
*
|
|
4
4
|
* This module is the single source of truth for all observability types.
|
|
5
|
-
* It mirrors the Langfuse ingestion API contract so payloads are wire-compatible
|
|
5
|
+
* It mirrors the Langfuse ingestion API contract so payloads are wire-compatible,
|
|
6
|
+
* and incorporates best patterns from Opik for comprehensive LLM observability.
|
|
6
7
|
*/
|
|
7
8
|
// ---------------------------------------------------------------------------
|
|
8
9
|
// Enums & Constants
|
|
@@ -15,9 +16,36 @@ export var ObservationLevel;
|
|
|
15
16
|
ObservationLevel["WARNING"] = "WARNING";
|
|
16
17
|
ObservationLevel["ERROR"] = "ERROR";
|
|
17
18
|
})(ObservationLevel || (ObservationLevel = {}));
|
|
19
|
+
/**
|
|
20
|
+
* Observation type discriminator.
|
|
21
|
+
* Matches the server's accepted types for rich categorization of spans.
|
|
22
|
+
*/
|
|
23
|
+
export var ObservationType;
|
|
24
|
+
(function (ObservationType) {
|
|
25
|
+
/** Generic span (default). */
|
|
26
|
+
ObservationType["SPAN"] = "SPAN";
|
|
27
|
+
/** LLM generation / completion call. */
|
|
28
|
+
ObservationType["GENERATION"] = "GENERATION";
|
|
29
|
+
/** Point-in-time event (no duration). */
|
|
30
|
+
ObservationType["EVENT"] = "EVENT";
|
|
31
|
+
/** Autonomous agent execution. */
|
|
32
|
+
ObservationType["AGENT"] = "AGENT";
|
|
33
|
+
/** Tool / function invocation. */
|
|
34
|
+
ObservationType["TOOL"] = "TOOL";
|
|
35
|
+
/** Chain execution (sequential pipeline). */
|
|
36
|
+
ObservationType["CHAIN"] = "CHAIN";
|
|
37
|
+
/** Retriever / vector search operation. */
|
|
38
|
+
ObservationType["RETRIEVER"] = "RETRIEVER";
|
|
39
|
+
/** Evaluator execution. */
|
|
40
|
+
ObservationType["EVALUATOR"] = "EVALUATOR";
|
|
41
|
+
/** Embedding operation. */
|
|
42
|
+
ObservationType["EMBEDDING"] = "EMBEDDING";
|
|
43
|
+
/** Guardrail / safety check. */
|
|
44
|
+
ObservationType["GUARDRAIL"] = "GUARDRAIL";
|
|
45
|
+
})(ObservationType || (ObservationType = {}));
|
|
18
46
|
/**
|
|
19
47
|
* Ingestion event type constants.
|
|
20
|
-
* These match the
|
|
48
|
+
* These match the server's accepted event types so payloads are processed
|
|
21
49
|
* without any translation layer.
|
|
22
50
|
*/
|
|
23
51
|
export const IngestionEventType = {
|
|
@@ -31,8 +59,18 @@ export const IngestionEventType = {
|
|
|
31
59
|
GENERATION_UPDATE: 'generation-update',
|
|
32
60
|
// Events (point-in-time observations)
|
|
33
61
|
EVENT_CREATE: 'event-create',
|
|
62
|
+
// Typed observation creates (server routes these to observation table with correct type)
|
|
63
|
+
AGENT_CREATE: 'agent-create',
|
|
64
|
+
TOOL_CREATE: 'tool-create',
|
|
65
|
+
CHAIN_CREATE: 'chain-create',
|
|
66
|
+
RETRIEVER_CREATE: 'retriever-create',
|
|
67
|
+
EVALUATOR_CREATE: 'evaluator-create',
|
|
68
|
+
EMBEDDING_CREATE: 'embedding-create',
|
|
69
|
+
GUARDRAIL_CREATE: 'guardrail-create',
|
|
34
70
|
// Scores
|
|
35
71
|
SCORE_CREATE: 'score-create',
|
|
72
|
+
// Dataset
|
|
73
|
+
DATASET_RUN_ITEM_CREATE: 'dataset-run-item-create',
|
|
36
74
|
// SDK metadata
|
|
37
75
|
SDK_LOG: 'sdk-log',
|
|
38
76
|
};
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E,wCAAwC;AACxC,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;AACjB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,eAqBX;AArBD,WAAY,eAAe;IACzB,8BAA8B;IAC9B,gCAAa,CAAA;IACb,wCAAwC;IACxC,4CAAyB,CAAA;IACzB,yCAAyC;IACzC,kCAAe,CAAA;IACf,kCAAkC;IAClC,kCAAe,CAAA;IACf,kCAAkC;IAClC,gCAAa,CAAA;IACb,6CAA6C;IAC7C,kCAAe,CAAA;IACf,2CAA2C;IAC3C,0CAAuB,CAAA;IACvB,2BAA2B;IAC3B,0CAAuB,CAAA;IACvB,2BAA2B;IAC3B,0CAAuB,CAAA;IACvB,gCAAgC;IAChC,0CAAuB,CAAA;AACzB,CAAC,EArBW,eAAe,KAAf,eAAe,QAqB1B;AAQD;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,SAAS;IACT,YAAY,EAAE,cAAc;IAE5B,QAAQ;IACR,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAE1B,cAAc;IACd,iBAAiB,EAAE,mBAAmB;IACtC,iBAAiB,EAAE,mBAAmB;IAEtC,sCAAsC;IACtC,YAAY,EAAE,cAAc;IAE5B,yFAAyF;IACzF,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IAEpC,SAAS;IACT,YAAY,EAAE,cAAc;IAE5B,UAAU;IACV,uBAAuB,EAAE,yBAAyB;IAElD,eAAe;IACf,OAAO,EAAE,SAAS;CACV,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@illuma-ai/observability-core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Core observability SDK - shared foundation for Node.js and browser clients",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -16,12 +16,15 @@
|
|
|
16
16
|
],
|
|
17
17
|
"scripts": {
|
|
18
18
|
"build": "tsc",
|
|
19
|
+
"test": "vitest run",
|
|
20
|
+
"test:watch": "vitest",
|
|
19
21
|
"prepublishOnly": "npm run build"
|
|
20
22
|
},
|
|
21
23
|
"dependencies": {},
|
|
22
24
|
"devDependencies": {
|
|
23
25
|
"typescript": "^5.4.5",
|
|
24
|
-
"@types/node": "^20.14.2"
|
|
26
|
+
"@types/node": "^20.14.2",
|
|
27
|
+
"vitest": "^1.6.0"
|
|
25
28
|
},
|
|
26
29
|
"publishConfig": {
|
|
27
30
|
"access": "public"
|