@arizeai/phoenix-client
Version:
A client for the Phoenix API
53 lines • 1.59 kB
TypeScript
import type { ClientFn } from "../types/core.js";
import type { TraceAnnotation } from "./types.js";
/**
* Parameters to log multiple trace annotations
*/
export interface LogTraceAnnotationsParams extends ClientFn {
/**
* The trace annotations to log
*/
traceAnnotations: TraceAnnotation[];
/**
* If true, the request will be fulfilled synchronously and return the annotation IDs.
* If false, the request will be processed asynchronously and return null.
* @default false
*/
sync?: boolean;
}
/**
* Log multiple trace 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 trace annotations
* @returns The IDs of the created or updated annotations
*
* @example
* ```ts
* const results = await logTraceAnnotations({
* traceAnnotations: [
* {
* traceId: "abc123",
* name: "correctness",
* label: "correct",
* score: 1.0,
* annotatorKind: "HUMAN",
* },
* {
* traceId: "def456",
* name: "faithfulness",
* label: "faithful",
* score: 0.9,
* annotatorKind: "LLM",
* },
* ],
* sync: true,
* });
* ```
*/
export declare function logTraceAnnotations({ client: _client, traceAnnotations, sync, }: LogTraceAnnotationsParams): Promise<{
id: string;
}[]>;
//# sourceMappingURL=logTraceAnnotations.d.ts.map