@arizeai/phoenix-client/dist/esm/spans/types.d.ts

A client for the Phoenix API

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