@arizeai/phoenix-client/dist/esm/sessions/addSessionAnnotation.d.ts

A client for the Phoenix API

import { ClientFn } from "../types/core.js";
import { SessionAnnotation } from "./types.js";
/**
 * Parameters to add a span annotation
 */
export interface AddSessionAnnotationParams extends ClientFn {
    sessionAnnotation: SessionAnnotation;
    /**
     * 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 session.
 *
 * 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 addSessionAnnotation({
 *   sessionAnnotation: {
 *     sessionId: "123abc",
 *     name: "quality_score",
 *     label: "good",
 *     score: 0.95,
 *     annotatorKind: "LLM",
 *     identifier: "custom_id_123",
 *     metadata: {
 *       model: "gpt-4"
 *     }
 *   }
 * });
 * ```
 */
export declare function addSessionAnnotation({ client: _client, sessionAnnotation, sync, }: AddSessionAnnotationParams): Promise<{
    id: string;
} | null>;
//# sourceMappingURL=addSessionAnnotation.d.ts.map