@arizeai/phoenix-client
Version:
A client for the Phoenix API
54 lines • 1.88 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.addSpanNote = addSpanNote;
const client_1 = require("../client");
const serverRequirements_1 = require("../constants/serverRequirements");
const apiErrorUtils_1 = require("../utils/apiErrorUtils");
const serverVersionUtils_1 = require("../utils/serverVersionUtils");
/**
* Add a note to a span.
*
* When `spanNote.identifier` is omitted, each call appends a new note with an
* auto-generated identifier. When `identifier` is non-empty, repeated calls
* with the same `(spanId, name='note', identifier)` overwrite the existing
* note.
*
* @param params - The parameters to add a span note
* @returns The ID of the created note annotation
*
* @example
* ```ts
* const result = await addSpanNote({
* spanNote: {
* spanId: "123abc",
* note: "This span looks suspicious, needs review"
* }
* });
* ```
*/
async function addSpanNote({ client: _client, spanNote, }) {
const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
if (spanNote.identifier) {
await (0, serverVersionUtils_1.ensureServerCapability)({
client,
requirement: serverRequirements_1.ADD_SPAN_NOTE_IDENTIFIER,
});
}
const { data, error } = await client.POST("/v1/span_notes", {
body: {
data: {
span_id: spanNote.spanId.trim(),
note: spanNote.note,
identifier: spanNote.identifier,
},
},
});
if (error) {
throw new Error(`Failed to add span note: ${(0, apiErrorUtils_1.formatApiError)(error)}`);
}
if (!(data === null || data === void 0 ? void 0 : data.data)) {
throw new Error("Failed to add span note: no data returned");
}
return data.data;
}
//# sourceMappingURL=addSpanNote.js.map