@arizeai/phoenix-client 6.9.2 → 6.10.0

package/src/constants/serverRequirements.ts

@@ -106,6 +106,30 @@ export const DATASET_UPLOAD_EXAMPLE_IDS: ParameterRequirement = {
   minServerVersion: [15, 0, 0],
 };
 
+export const ADD_TRACE_NOTE_IDENTIFIER: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "identifier",
+  parameterLocation: "body",
+  route: "POST /v1/trace_notes",
+  minServerVersion: [15, 5, 0],
+};
+
+export const ADD_SPAN_NOTE_IDENTIFIER: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "identifier",
+  parameterLocation: "body",
+  route: "POST /v1/span_notes",
+  minServerVersion: [15, 5, 0],
+};
+
+export const ADD_SESSION_NOTE_IDENTIFIER: ParameterRequirement = {
+  kind: "parameter",
+  parameterName: "identifier",
+  parameterLocation: "body",
+  route: "POST /v1/session_notes",
+  minServerVersion: [15, 5, 0],
+};
+
 /**
  * Aggregate list of every known capability requirement.
  *
@@ -125,4 +149,7 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   GET_SPANS_BY_ATTRIBUTE,
   LIST_PROJECT_TRACES,
   DATASET_UPLOAD_EXAMPLE_IDS,
+  ADD_TRACE_NOTE_IDENTIFIER,
+  ADD_SPAN_NOTE_IDENTIFIER,
+  ADD_SESSION_NOTE_IDENTIFIER,
 ] as const;

package/src/prompts/sdks/toOpenAI.ts

@@ -36,14 +36,47 @@ export const toOpenAI = <V extends Variables = Variables>({
 }: ToOpenAIParams<V>): ChatCompletionCreateParams | null => {
   try {
     let invocationParameters: Partial<ChatCompletionCreateParams>;
-    if (prompt.invocation_parameters.type === "openai") {
-      invocationParameters = prompt.invocation_parameters.openai;
-    } else {
-      // eslint-disable-next-line no-console
-      console.warn(
-        "Prompt is not an OpenAI prompt, falling back to default OpenAI invocation parameters"
-      );
-      invocationParameters = {};
+    switch (prompt.invocation_parameters.type) {
+      case "openai":
+        invocationParameters = prompt.invocation_parameters.openai;
+        break;
+      case "azure_openai":
+        invocationParameters = prompt.invocation_parameters.azure_openai;
+        break;
+      case "deepseek":
+        invocationParameters = prompt.invocation_parameters.deepseek;
+        break;
+      case "xai":
+        invocationParameters = prompt.invocation_parameters.xai;
+        break;
+      case "ollama":
+        invocationParameters = prompt.invocation_parameters.ollama;
+        break;
+      case "cerebras":
+        invocationParameters = prompt.invocation_parameters.cerebras;
+        break;
+      case "fireworks":
+        invocationParameters = prompt.invocation_parameters.fireworks;
+        break;
+      case "groq":
+        invocationParameters = prompt.invocation_parameters.groq;
+        break;
+      case "moonshot":
+        invocationParameters = prompt.invocation_parameters.moonshot;
+        break;
+      case "perplexity":
+        invocationParameters = prompt.invocation_parameters.perplexity;
+        break;
+      case "together":
+        invocationParameters = prompt.invocation_parameters.together;
+        break;
+      default:
+        // eslint-disable-next-line no-console
+        console.warn(
+          "Prompt is not an OpenAI-family prompt, falling back to default OpenAI invocation parameters"
+        );
+        invocationParameters = {};
+        break;
     }
     // parts of the prompt that can be directly converted to OpenAI params
     const baseCompletionParams = {

package/src/sessions/addSessionNote.ts

@@ -1,5 +1,8 @@
 import { createClient } from "../client";
-import { ADD_SESSION_NOTE } from "../constants/serverRequirements";
+import {
+  ADD_SESSION_NOTE,
+  ADD_SESSION_NOTE_IDENTIFIER,
+} from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import { formatApiError } from "../utils/apiErrorUtils";
 import { ensureServerCapability } from "../utils/serverVersionUtils";
@@ -16,6 +19,13 @@ export interface SessionNote {
    * The note text to add to the session.
    */
   note: string;
+  /**
+   * Optional caller-supplied identifier. When non-empty, the note is upserted
+   * on `(sessionId, name='note', identifier)` — repeated calls with the same
+   * identifier overwrite the existing note. When omitted, the server stamps a
+   * unique `px-session-note:<uuid>` identifier so each call appends a new note.
+   */
+  identifier?: string;
 }
 
 /**
@@ -28,8 +38,10 @@ export interface AddSessionNoteParams extends ClientFn {
 /**
  * Add a note to a session.
  *
- * Notes are a special type of annotation that allow multiple entries per session.
- * Each note gets a unique UUIDv4 identifier.
+ * When `sessionNote.identifier` is omitted, each call appends a new note with
+ * an auto-generated identifier. When `identifier` is non-empty, repeated calls
+ * with the same `(sessionId, name='note', identifier)` overwrite the existing
+ * note.
  *
  * @param params - The parameters to add a session note.
  * @returns The ID of the created note annotation.
@@ -52,12 +64,19 @@ export async function addSessionNote({
 }: AddSessionNoteParams): Promise<{ id: string }> {
   const client = _client ?? createClient();
   await ensureServerCapability({ client, requirement: ADD_SESSION_NOTE });
+  if (sessionNote.identifier) {
+    await ensureServerCapability({
+      client,
+      requirement: ADD_SESSION_NOTE_IDENTIFIER,
+    });
+  }
 
   const { data, error } = await client.POST("/v1/session_notes", {
     body: {
       data: {
         session_id: sessionNote.sessionId.trim(),
         note: sessionNote.note,
+        identifier: sessionNote.identifier,
       },
     },
   });

package/src/spans/addSpanNote.ts

@@ -1,6 +1,8 @@
 import { createClient } from "../client";
+import { ADD_SPAN_NOTE_IDENTIFIER } from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import { formatApiError } from "../utils/apiErrorUtils";
+import { ensureServerCapability } from "../utils/serverVersionUtils";
 
 /**
  * Parameters for a single span note
@@ -14,6 +16,13 @@ export interface SpanNote {
    * The note text to add to the span
    */
   note: string;
+  /**
+   * Optional caller-supplied identifier. When non-empty, the note is upserted
+   * on `(spanId, name='note', identifier)` — repeated calls with the same
+   * identifier overwrite the existing note. When omitted, the server stamps a
+   * unique `px-span-note:<uuid>` identifier so each call appends a new note.
+   */
+  identifier?: string;
 }
 
 /**
@@ -26,11 +35,10 @@ export interface AddSpanNoteParams extends ClientFn {
 /**
  * Add a note to a span.
  *
- * Notes are append-only: each call creates a new note with an auto-generated
- * UUIDv4 identifier, so multiple notes accumulate on the same span. Structured
- * annotations, by contrast, are keyed by `(name, spanId, identifier)` — to keep
- * multiple structured annotations with the same name on a span, supply distinct
- * identifiers; otherwise re-writing the same name overwrites the existing one.
+ * 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
@@ -50,12 +58,19 @@ export async function addSpanNote({
   spanNote,
 }: AddSpanNoteParams): Promise<{ id: string }> {
   const client = _client ?? createClient();
+  if (spanNote.identifier) {
+    await ensureServerCapability({
+      client,
+      requirement: 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,
       },
     },
   });

package/src/spans/getSpanAnnotations.ts

@@ -12,7 +12,7 @@ export interface GetSpanAnnotationsParams extends ClientFn {
   project: ProjectIdentifier;
   /** One or more span IDs to fetch annotations for */
   spanIds: string[];
-  /** Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list. */
+  /** Optional list of annotation names to include. If provided, only annotations with these names will be returned (allowlist). When omitted, the response includes every matching row regardless of name (no annotation names are excluded by default). */
   includeAnnotationNames?: string[];
   /** Optional list of annotation names to exclude from results. */
   excludeAnnotationNames?: string[];

package/src/traces/addTraceNote.ts

@@ -1,5 +1,8 @@
 import { createClient } from "../client";
-import { ADD_TRACE_NOTE } from "../constants/serverRequirements";
+import {
+  ADD_TRACE_NOTE,
+  ADD_TRACE_NOTE_IDENTIFIER,
+} from "../constants/serverRequirements";
 import type { ClientFn } from "../types/core";
 import { formatApiError } from "../utils/apiErrorUtils";
 import { ensureServerCapability } from "../utils/serverVersionUtils";
@@ -16,6 +19,13 @@ export interface TraceNote {
    * The note text to add to the trace.
    */
   note: string;
+  /**
+   * Optional caller-supplied identifier. When non-empty, the note is upserted
+   * on `(traceId, name='note', identifier)` — repeated calls with the same
+   * identifier overwrite the existing note. When omitted, the server stamps a
+   * unique `px-trace-note:<uuid>` identifier so each call appends a new note.
+   */
+  identifier?: string;
 }
 
 /**
@@ -28,11 +38,10 @@ export interface AddTraceNoteParams extends ClientFn {
 /**
  * Add a note to a trace.
  *
- * Notes are append-only: each call creates a new note with an auto-generated
- * UUIDv4 identifier, so multiple notes accumulate on the same trace. Structured
- * annotations, by contrast, are keyed by `(name, traceId, identifier)` — to keep
- * multiple structured annotations with the same name on a trace, supply distinct
- * identifiers; otherwise re-writing the same name overwrites the existing one.
+ * When `traceNote.identifier` is omitted, each call appends a new note with an
+ * auto-generated identifier. When `identifier` is non-empty, repeated calls
+ * with the same `(traceId, name='note', identifier)` overwrite the existing
+ * note.
  *
  * @param params - The parameters to add a trace note.
  * @returns The ID of the created note annotation.
@@ -53,12 +62,19 @@ export async function addTraceNote({
 }: AddTraceNoteParams): Promise<{ id: string }> {
   const client = _client ?? createClient();
   await ensureServerCapability({ client, requirement: ADD_TRACE_NOTE });
+  if (traceNote.identifier) {
+    await ensureServerCapability({
+      client,
+      requirement: ADD_TRACE_NOTE_IDENTIFIER,
+    });
+  }
 
   const { data, error } = await client.POST("/v1/trace_notes", {
     body: {
       data: {
         trace_id: traceNote.traceId.trim(),
         note: traceNote.note,
+        identifier: traceNote.identifier,
       },
     },
   });