@arizeai/phoenix-client
Version:
A client for the Phoenix API
56 lines • 1.69 kB
TypeScript
import { ClientFn } from "../types/core.js";
import { SessionAnnotation } from "./types.js";
/**
* Parameters to log multiple session annotations
*/
export interface LogSessionAnnotationsParams extends ClientFn {
/**
* The session annotations to log
*/
sessionAnnotations: SessionAnnotation[];
/**
* 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 session 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 session annotations
* @returns The IDs of the created or updated annotations
*
* @example
* ```ts
* const results = await logSessionAnnotations({
* sessionAnnotations: [
* {
* sessionId: "123abc",
* name: "quality_score",
* label: "good",
* score: 0.95,
* annotatorKind: "LLM",
* identifier: "custom_id_123",
* metadata: {
* model: "gpt-4"
* }
* },
* {
* sessionId: "456def",
* name: "sentiment",
* label: "positive",
* score: 0.8,
* annotatorKind: "CODE"
* }
* ]
* });
* ```
*/
export declare function logSessionAnnotations({ client: _client, sessionAnnotations, sync, }: LogSessionAnnotationsParams): Promise<{
id: string;
}[]>;
//# sourceMappingURL=logSessionAnnotations.d.ts.map