@arizeai/phoenix-client 1.0.2 → 1.2.0

package/dist/esm/spans/addSpanAnnotation.js

@@ -0,0 +1,44 @@
+import { createClient } from "../client.js";
+import { toSpanAnnotationData } from "./types.js";
+/**
+ * Add an annotation to a span.
+ *
+ * The annotation can be of type "LLM", "CODE", or "HUMAN" and can include a label, score, and metadata.
+ * If an identifier is provided and an annotation with that identifier already exists, it will be updated.
+ *
+ * @param params - The parameters to add a span annotation
+ * @returns The ID of the created or updated annotation
+ *
+ * @example
+ * ```ts
+ * const result = await addSpanAnnotation({
+ *   spanAnnotation: {
+ *     spanId: "123abc",
+ *     name: "quality_score",
+ *     label: "good",
+ *     score: 0.95,
+ *     annotatorKind: "LLM",
+ *     identifier: "custom_id_123",
+ *     metadata: {
+ *       model: "gpt-4"
+ *     }
+ *   }
+ * });
+ * ```
+ */
+export async function addSpanAnnotation({ client: _client, spanAnnotation, }) {
+    const client = _client ?? createClient();
+    const { data, error } = await client.POST("/v1/span_annotations", {
+        body: {
+            data: [toSpanAnnotationData(spanAnnotation)],
+        },
+    });
+    if (error) {
+        throw new Error(`Failed to add span annotation: ${error}`);
+    }
+    if (!data?.data?.[0]?.id) {
+        throw new Error("No annotation ID returned from server");
+    }
+    return data.data[0];
+}
+//# sourceMappingURL=addSpanAnnotation.js.map

package/dist/esm/spans/addSpanAnnotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addSpanAnnotation.js","sourceRoot":"","sources":["../../../src/spans/addSpanAnnotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAkB,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAS/D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,EACtC,MAAM,EAAE,OAAO,EACf,cAAc,GACU;IACxB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IAEzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE;QAChE,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;SAC7C;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC"}

package/dist/esm/spans/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./addSpanAnnotation.js";
+export * from "./logSpanAnnotations.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/spans/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC"}

package/dist/esm/spans/index.js

@@ -0,0 +1,3 @@
+export * from "./addSpanAnnotation.js";
+export * from "./logSpanAnnotations.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/spans/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC"}

package/dist/esm/spans/logSpanAnnotations.d.ts

@@ -0,0 +1,51 @@
+import { ClientFn } from "../types/core.js";
+import { SpanAnnotation } from "./types.js";
+/**
+ * Parameters to log multiple span annotations
+ */
+interface LogSpanAnnotationsParams extends ClientFn {
+    /**
+     * The span annotations to log
+     */
+    spanAnnotations: SpanAnnotation[];
+}
+/**
+ * Log multiple span annotations in a single request.
+ *
+ * Each annotation can be of type "LLM", "CODE", or "HUMAN" and can include a label, score, and metadata.
+ * If an identifier is provided and an annotation with that identifier already exists, it will be updated.
+ *
+ * @param params - The parameters to log span annotations
+ * @returns The IDs of the created or updated annotations
+ *
+ * @example
+ * ```ts
+ * const results = await logSpanAnnotations({
+ *   spanAnnotations: [
+ *     {
+ *       spanId: "123abc",
+ *       name: "quality_score",
+ *       label: "good",
+ *       score: 0.95,
+ *       annotatorKind: "LLM",
+ *       identifier: "custom_id_123",
+ *       metadata: {
+ *         model: "gpt-4"
+ *       }
+ *     },
+ *     {
+ *       spanId: "456def",
+ *       name: "sentiment",
+ *       label: "positive",
+ *       score: 0.8,
+ *       annotatorKind: "CODE"
+ *     }
+ *   ]
+ * });
+ * ```
+ */
+export declare function logSpanAnnotations({ client: _client, spanAnnotations, }: LogSpanAnnotationsParams): Promise<{
+    id: string;
+}[]>;
+export {};
+//# sourceMappingURL=logSpanAnnotations.d.ts.map

package/dist/esm/spans/logSpanAnnotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logSpanAnnotations.d.ts","sourceRoot":"","sources":["../../../src/spans/logSpanAnnotations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,cAAc,EAAwB,MAAM,SAAS,CAAC;AAE/D;;GAEG;AACH,UAAU,wBAAyB,SAAQ,QAAQ;IACjD;;OAEG;IACH,eAAe,EAAE,cAAc,EAAE,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,eAAe,GAChB,EAAE,wBAAwB,GAAG,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,CAkBtD"}

package/dist/esm/spans/logSpanAnnotations.js

@@ -0,0 +1,53 @@
+import { createClient } from "../client.js";
+import { toSpanAnnotationData } from "./types.js";
+/**
+ * Log multiple span annotations in a single request.
+ *
+ * Each annotation can be of type "LLM", "CODE", or "HUMAN" and can include a label, score, and metadata.
+ * If an identifier is provided and an annotation with that identifier already exists, it will be updated.
+ *
+ * @param params - The parameters to log span annotations
+ * @returns The IDs of the created or updated annotations
+ *
+ * @example
+ * ```ts
+ * const results = await logSpanAnnotations({
+ *   spanAnnotations: [
+ *     {
+ *       spanId: "123abc",
+ *       name: "quality_score",
+ *       label: "good",
+ *       score: 0.95,
+ *       annotatorKind: "LLM",
+ *       identifier: "custom_id_123",
+ *       metadata: {
+ *         model: "gpt-4"
+ *       }
+ *     },
+ *     {
+ *       spanId: "456def",
+ *       name: "sentiment",
+ *       label: "positive",
+ *       score: 0.8,
+ *       annotatorKind: "CODE"
+ *     }
+ *   ]
+ * });
+ * ```
+ */
+export async function logSpanAnnotations({ client: _client, spanAnnotations, }) {
+    const client = _client ?? createClient();
+    const { data, error } = await client.POST("/v1/span_annotations", {
+        body: {
+            data: spanAnnotations.map(toSpanAnnotationData),
+        },
+    });
+    if (error) {
+        throw new Error(`Failed to log span annotations: ${error}`);
+    }
+    if (!data?.data?.length) {
+        throw new Error("No annotation IDs returned from server");
+    }
+    return data.data;
+}
+//# sourceMappingURL=logSpanAnnotations.js.map

package/dist/esm/spans/logSpanAnnotations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logSpanAnnotations.js","sourceRoot":"","sources":["../../../src/spans/logSpanAnnotations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAkB,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAY/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,eAAe,GACU;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IAEzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE;QAChE,IAAI,EAAE;YACJ,IAAI,EAAE,eAAe,CAAC,GAAG,CAAC,oBAAoB,CAAC;SAChD;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}

package/dist/esm/spans/types.d.ts

@@ -0,0 +1,43 @@
+import { paths } from "../__generated__/api/v1.js";
+type SpanAnnotationData = paths["/v1/span_annotations"]["post"]["requestBody"]["content"]["application/json"]["data"][0];
+/**
+ * Parameters for a single span annotation
+ */
+export interface SpanAnnotation {
+    /**
+     * The OpenTelemetry Span ID (hex format without 0x prefix)
+     */
+    spanId: string;
+    /**
+     * The name of the annotation
+     */
+    name: string;
+    /**
+     * The label assigned by the annotation
+     */
+    label?: string;
+    /**
+     * The score assigned by the annotation
+     */
+    score?: number;
+    /**
+     * The identifier of the annotation. If provided, the annotation will be updated if it already exists.
+     */
+    identifier?: string;
+    /**
+     * Metadata for the annotation
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The kind of annotator used for the annotation
+     * Can be "HUMAN", "LLM", or "CODE"
+     * @default "HUMAN"
+     */
+    annotatorKind?: SpanAnnotationData["annotator_kind"];
+}
+/**
+ * Convert a SpanAnnotation to the API format
+ */
+export declare function toSpanAnnotationData(annotation: SpanAnnotation): SpanAnnotationData;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/spans/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/spans/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAEhD,KAAK,kBAAkB,GACrB,KAAK,CAAC,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjG;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;CACtD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,cAAc,GACzB,kBAAkB,CAapB"}

package/dist/esm/spans/types.js

@@ -0,0 +1,18 @@
+/**
+ * Convert a SpanAnnotation to the API format
+ */
+export function toSpanAnnotationData(annotation) {
+    return {
+        span_id: annotation.spanId,
+        name: annotation.name,
+        annotator_kind: annotation.annotatorKind ?? "HUMAN",
+        result: {
+            label: annotation.label ?? null,
+            score: annotation.score ?? null,
+            explanation: null,
+        },
+        metadata: annotation.metadata ?? null,
+        identifier: annotation.identifier ?? "",
+    };
+}
+//# sourceMappingURL=types.js.map

package/dist/esm/spans/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/spans/types.ts"],"names":[],"mappings":"AAyCA;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAA0B;IAE1B,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,MAAM;QAC1B,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,cAAc,EAAE,UAAU,CAAC,aAAa,IAAI,OAAO;QACnD,MAAM,EAAE;YACN,KAAK,EAAE,UAAU,CAAC,KAAK,IAAI,IAAI;YAC/B,KAAK,EAAE,UAAU,CAAC,KAAK,IAAI,IAAI;YAC/B,WAAW,EAAE,IAAI;SAClB;QACD,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,IAAI;QACrC,UAAU,EAAE,UAAU,CAAC,UAAU,IAAI,EAAE;KACxC,CAAC;AACJ,CAAC"}