@arizeai/phoenix-client/dist/esm/traces/addTraceAnnotation.d.ts

A client for the Phoenix API

import type { ClientFn } from "../types/core.js";
import type { TraceAnnotation } from "./types.js";
/**
 * Parameters to add a trace annotation
 */
export interface AddTraceAnnotationParams extends ClientFn {
    traceAnnotation: TraceAnnotation;
    /**
     * If true, the request will be fulfilled synchronously and return the annotation ID.
     * If false, the request will be processed asynchronously and return null.
     * @default false
     */
    sync?: boolean;
}
/**
 * Add an annotation to a trace.
 *
 * 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 trace annotation
 * @returns The ID of the created or updated annotation
 *
 * @example
 * ```ts
 * const result = await addTraceAnnotation({
 *   traceAnnotation: {
 *     traceId: "abc123",
 *     name: "correctness",
 *     label: "correct",
 *     score: 1.0,
 *     annotatorKind: "HUMAN",
 *     identifier: "custom_id_123",
 *     metadata: { reviewer: "alice" }
 *   },
 *   sync: true,
 * });
 * ```
 */
export declare function addTraceAnnotation({ client: _client, traceAnnotation, sync, }: AddTraceAnnotationParams): Promise<{
    id: string;
} | null>;
//# sourceMappingURL=addTraceAnnotation.d.ts.map