@arizeai/phoenix-client/dist/esm/spans/addSpanAnnotation.js

A client for the Phoenix API

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, sync = false, }) {
    const client = _client ?? createClient();
    const { data, error } = await client.POST("/v1/span_annotations", {
        params: {
            query: { sync },
        },
        body: {
            data: [toSpanAnnotationData(spanAnnotation)],
        },
    });
    if (error) {
        throw new Error(`Failed to add span annotation: ${error}`);
    }
    return data?.data?.[0] || null;
}
//# sourceMappingURL=addSpanAnnotation.js.map