@arizeai/phoenix-client 7.3.1 → 7.5.0

package/src/client.ts

@@ -158,9 +158,10 @@ export const createClient = (
         const headers = mergedOptions.headers
           ? { ...(mergedOptions.headers as Record<string, string>) }
           : {};
-        const resp = await fetch(`${baseUrl}/arize_phoenix_version`, {
-          headers,
-        });
+        const fetchImpl = mergedOptions.fetch ?? globalThis.fetch;
+        const resp = await fetchImpl(
+          new Request(`${baseUrl}/arize_phoenix_version`, { headers })
+        );
         if (resp.ok) {
           const text = await resp.text();
           const parsed = parseSemanticVersion(text);

package/src/constants/serverRequirements.ts

@@ -138,6 +138,69 @@ export const ADD_SESSION_NOTE_IDENTIFIER: ParameterRequirement = {
   minServerVersion: [15, 5, 0],
 };
 
+export const PATCH_PROMPT: RouteRequirement = {
+  kind: "route",
+  method: "PATCH",
+  path: "/v1/prompts/{prompt_identifier}",
+  minServerVersion: [19, 18, 0],
+};
+
+export const AGENT_SESSION_CREATE: RouteRequirement = {
+  kind: "route",
+  method: "POST",
+  path: "/v1/agent_sessions",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_LIST: RouteRequirement = {
+  kind: "route",
+  method: "GET",
+  path: "/v1/agent_sessions",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_GET: RouteRequirement = {
+  kind: "route",
+  method: "GET",
+  path: "/v1/agent_sessions/{session_id}",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_PATCH: RouteRequirement = {
+  kind: "route",
+  method: "PATCH",
+  path: "/v1/agent_sessions/{session_id}",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_COMPACT: RouteRequirement = {
+  kind: "route",
+  method: "POST",
+  path: "/v1/agent_sessions/{session_id}/compact",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_TOOL_OUTPUTS: RouteRequirement = {
+  kind: "route",
+  method: "POST",
+  path: "/v1/agent_sessions/{session_id}/tool_outputs",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_CHAT: RouteRequirement = {
+  kind: "route",
+  method: "POST",
+  path: "/v1/agent_sessions/{session_id}/chat",
+  minServerVersion: [20, 0, 0],
+};
+
+export const AGENT_SESSION_MESSAGES: RouteRequirement = {
+  kind: "route",
+  method: "GET",
+  path: "/v1/agent_sessions/{session_id}/messages",
+  minServerVersion: [20, 0, 0],
+};
+
 /**
  * Aggregate list of every known capability requirement.
  *
@@ -161,4 +224,13 @@ export const ALL_REQUIREMENTS: readonly CapabilityRequirement[] = [
   ADD_TRACE_NOTE_IDENTIFIER,
   ADD_SPAN_NOTE_IDENTIFIER,
   ADD_SESSION_NOTE_IDENTIFIER,
+  PATCH_PROMPT,
+  AGENT_SESSION_CREATE,
+  AGENT_SESSION_LIST,
+  AGENT_SESSION_GET,
+  AGENT_SESSION_PATCH,
+  AGENT_SESSION_COMPACT,
+  AGENT_SESSION_TOOL_OUTPUTS,
+  AGENT_SESSION_CHAT,
+  AGENT_SESSION_MESSAGES,
 ] as const;

package/src/index.ts

@@ -1,3 +1,29 @@
 export * from "./client";
 export * from "./authFetch";
 export * from "./errors";
+export {
+  AGENT_SESSION_CHAT,
+  AGENT_SESSION_COMPACT,
+  AGENT_SESSION_CREATE,
+  AGENT_SESSION_GET,
+  AGENT_SESSION_LIST,
+  AGENT_SESSION_MESSAGES,
+  AGENT_SESSION_PATCH,
+  AGENT_SESSION_TOOL_OUTPUTS,
+} from "./constants/serverRequirements";
+export { formatApiError } from "./utils/apiErrorUtils";
+export {
+  formatVersion,
+  parseSemanticVersion,
+  satisfiesMinVersion,
+} from "./utils/semverUtils";
+export {
+  capabilityLabel,
+  ensureServerCapability,
+} from "./utils/serverVersionUtils";
+export type { SemanticVersion } from "./types/semver";
+export type {
+  CapabilityRequirement,
+  ParameterRequirement,
+  RouteRequirement,
+} from "./types/serverRequirements";

package/src/prompts/index.ts

@@ -1,4 +1,5 @@
 export * from "./getPrompt";
 export * from "./createPrompt";
 export * from "./listPrompts";
+export * from "./updatePrompt";
 export * from "./sdks";

package/src/prompts/updatePrompt.ts

@@ -0,0 +1,95 @@
+import invariant from "tiny-invariant";
+
+import { createClient } from "../client";
+import { PATCH_PROMPT } from "../constants/serverRequirements";
+import { HttpError } from "../errors";
+import type { ClientFn } from "../types/core";
+import type { Prompt } from "../types/prompts";
+import { ensureServerCapability } from "../utils/serverVersionUtils";
+
+/**
+ * Parameters for updating a prompt's description and/or metadata.
+ *
+ * Omit a field to leave it unchanged. Pass `description: null` to clear the
+ * description. `metadata` replaces the existing metadata object as a whole.
+ */
+export interface UpdatePromptParams extends ClientFn {
+  /**
+   * The prompt name or ID.
+   */
+  promptIdentifier: string;
+  /**
+   * New description for the prompt. Pass `null` to clear it. Omit to leave
+   * unchanged.
+   */
+  description?: string | null;
+  /**
+   * New metadata object for the prompt (full replace). Omit to leave unchanged.
+   */
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * Update a prompt's description and/or metadata via
+ * `PATCH /v1/prompts/{prompt_identifier}`.
+ *
+ * @param params - The parameters to update the prompt.
+ * @returns The updated prompt.
+ *
+ * @requires Phoenix server >= 19.18.0
+ *
+ * @example
+ * ```ts
+ * import { updatePrompt } from "@arizeai/phoenix-client/prompts";
+ *
+ * const prompt = await updatePrompt({
+ *   promptIdentifier: "my-prompt",
+ *   description: "Production classifier",
+ *   metadata: { team: "ml", env: "prod" },
+ * });
+ *
+ * // Clear the description only
+ * await updatePrompt({
+ *   promptIdentifier: "my-prompt",
+ *   description: null,
+ * });
+ * ```
+ */
+export async function updatePrompt({
+  client: _client,
+  promptIdentifier,
+  description,
+  metadata,
+}: UpdatePromptParams): Promise<Prompt> {
+  if (description === undefined && metadata === undefined) {
+    throw new Error(
+      "At least one of description or metadata must be provided."
+    );
+  }
+
+  const client = _client ?? createClient();
+  await ensureServerCapability({ client, requirement: PATCH_PROMPT });
+
+  try {
+    const response = await client.PATCH("/v1/prompts/{prompt_identifier}", {
+      params: {
+        path: {
+          prompt_identifier: promptIdentifier,
+        },
+      },
+      body: {
+        ...(description !== undefined ? { description } : {}),
+        ...(metadata !== undefined ? { metadata } : {}),
+      },
+    });
+    invariant(response.data?.data, "Failed to update prompt");
+    return response.data.data;
+  } catch (error) {
+    if (error instanceof HttpError && error.status === 404) {
+      throw new Error(`Prompt not found: ${promptIdentifier}`, {
+        cause: error,
+      });
+    }
+    throw error;
+  }
+}