@arizeai/phoenix-client
Version:
A client for the Phoenix API
55 lines • 1.69 kB
JavaScript
import { createClient } from "../client.js";
import { toDocumentAnnotationData } from "./types.js";
/**
* Log multiple document annotations in a single request.
*
* Each 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 for each annotation.
*
* @param params - The parameters to log document annotations
* @returns The IDs of the created annotations
*
* @example
* ```ts
* const results = await logDocumentAnnotations({
* documentAnnotations: [
* {
* 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"
* }
* },
* {
* spanId: "123abc",
* documentPosition: 1,
* name: "relevance_score",
* label: "somewhat_relevant",
* score: 0.6,
* annotatorKind: "LLM"
* }
* ]
* });
* ```
*/
export async function logDocumentAnnotations({ client: _client, documentAnnotations, sync = false, }) {
const client = _client ?? createClient();
const { data, error } = await client.POST("/v1/document_annotations", {
params: {
query: { sync },
},
body: {
data: documentAnnotations.map(toDocumentAnnotationData),
},
});
if (error) {
throw new Error(`Failed to log document annotations: ${error}`);
}
return data?.data || [];
}
//# sourceMappingURL=logDocumentAnnotations.js.map