@arizeai/phoenix-client/dist/esm/spans/addDocumentAnnotation.js

A client for the Phoenix API

import { createClient } from "../client.js";
import { toDocumentAnnotationData } from "./types.js";
/**
 * Add an annotation to a document within a span.
 *
 * The annotation can be of type "LLM", "CODE", or "HUMAN" and can include a label, score, explanation, and metadata.
 * At least one of label, score, or explanation must be provided.
 *
 * @param params - The parameters to add a document annotation
 * @returns The ID of the created annotation
 *
 * @example
 * ```ts
 * const result = await addDocumentAnnotation({
 *   documentAnnotation: {
 *     spanId: "123abc",
 *     documentPosition: 0,
 *     name: "relevance_score",
 *     label: "relevant",
 *     score: 0.95,
 *     annotatorKind: "LLM",
 *     explanation: "Document is highly relevant to the query",
 *     metadata: {
 *       model: "gpt-4"
 *     }
 *   }
 * });
 * ```
 */
export async function addDocumentAnnotation({ client: _client, documentAnnotation, sync = false, }) {
    const client = _client ?? createClient();
    const { data, error } = await client.POST("/v1/document_annotations", {
        params: {
            query: { sync },
        },
        body: {
            data: [toDocumentAnnotationData(documentAnnotation)],
        },
    });
    if (error) {
        throw new Error(`Failed to add document annotation: ${error}`);
    }
    return data?.data?.[0] || null;
}
//# sourceMappingURL=addDocumentAnnotation.js.map