@arizeai/phoenix-client 7.10.0 → 7.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "7.10.0",
+  "version": "7.11.0",
   "description": "A client for the Phoenix API",
   "keywords": [
     "arize",
@@ -103,30 +103,30 @@
     }
   },
   "dependencies": {
-    "@arizeai/openinference-semantic-conventions": "^2.7.0",
+    "@arizeai/openinference-semantic-conventions": "^2.9.0",
     "@arizeai/phoenix-config": "0.5.0",
     "@arizeai/phoenix-otel": "2.2.0",
     "async": "^3.2.6",
     "openapi-fetch": "^0.17.0",
     "tiny-invariant": "^1.3.3",
-    "zod": "^4.4.3"
+    "zod": "^4.5.4"
   },
   "devDependencies": {
-    "@ai-sdk/openai": "^4.0.46",
-    "@ai-sdk/otel": "^1.0.77",
+    "@ai-sdk/openai": "^4.0.60",
+    "@ai-sdk/otel": "^1.0.93",
     "@anthropic-ai/sdk": "^0.111.0",
-    "@arizeai/phoenix-evals": "2.4.0",
+    "@arizeai/phoenix-evals": "2.5.0",
     "@arizeai/phoenix-testing": "0.0.0",
     "@opentelemetry/api": "^1.9.1",
-    "@opentelemetry/sdk-trace-node": "^2.10.0",
+    "@opentelemetry/sdk-trace-node": "^2.11.0",
     "@types/async": "^3.2.25",
-    "@types/node": "^26.2.0",
-    "ai": "^7.0.77",
+    "@types/node": "^26.4.1",
+    "ai": "^7.0.93",
     "dotenv": "^17.4.2",
-    "jest": "^30.4.2",
+    "jest": "^30.5.1",
     "openai": "^6.49.0",
     "openapi-typescript": "^7.13.0",
-    "tsx": "^4.23.12",
+    "tsx": "^4.23.13",
     "vitest": "^5.0.0"
   },
   "peerDependencies": {

package/src/__generated__/api/v1.ts

@@ -5296,6 +5296,13 @@ export interface components {
         PromptVersion: {
             /** Description */
             description?: string | null;
+            /**
+             * Metadata
+             * @description Arbitrary JSON metadata for the prompt version.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
             model_provider: components["schemas"]["ModelProvider"];
             /** Model Name */
             model_name: string;
@@ -5315,6 +5322,13 @@ export interface components {
         PromptVersionData: {
             /** Description */
             description?: string | null;
+            /**
+             * Metadata
+             * @description Arbitrary JSON metadata for the prompt version.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
             model_provider: components["schemas"]["ModelProvider"];
             /** Model Name */
             model_name: string;

package/src/prompts/createPrompt.ts

@@ -84,6 +84,11 @@ interface PromptVersionInputBase {
    * The description of the prompt version.
    */
   description?: string;
+  /**
+   * Optional metadata for the prompt version as a JSON object.
+   * @example { "agent": "support", "dependencies": ["retriever"] }
+   */
+  metadata?: PromptVersionData["metadata"];
   /**
    * The name of the model to use for the prompt version.
    */
@@ -165,142 +170,51 @@ export type PromptVersionInput =
 export function promptVersion(params: PromptVersionInput): PromptVersionData {
   const {
     description = "",
+    metadata,
     modelProvider: model_provider,
     modelName: model_name,
     template: templateMessages,
     templateFormat: template_format = "MUSTACHE",
-    invocationParameters: invocation_parameters,
   } = params;
-  switch (model_provider) {
+  return {
+    description,
+    ...(metadata ? { metadata } : {}),
+    model_provider,
+    model_name,
+    template_type: "CHAT",
+    template_format,
+    template: {
+      type: "chat",
+      messages: templateMessages,
+    },
+    invocation_parameters: toInvocationParameters(params),
+  };
+}
+
+function toInvocationParameters(
+  params: PromptVersionInput
+): PromptVersionData["invocation_parameters"] {
+  switch (params.modelProvider) {
     case "OPENAI":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "openai",
-          openai: invocation_parameters ?? {},
-        },
-      };
+      return { type: "openai", openai: params.invocationParameters ?? {} };
     case "AZURE_OPENAI":
       return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "azure_openai",
-          azure_openai: invocation_parameters ?? {},
-        },
+        type: "azure_openai",
+        azure_openai: params.invocationParameters ?? {},
       };
     case "ANTHROPIC":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "anthropic",
-          anthropic: invocation_parameters,
-        },
-      };
+      return { type: "anthropic", anthropic: params.invocationParameters };
     case "GOOGLE":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "google",
-          google: invocation_parameters ?? {},
-        },
-      };
+      return { type: "google", google: params.invocationParameters ?? {} };
     case "DEEPSEEK":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "deepseek",
-          deepseek: invocation_parameters ?? {},
-        },
-      };
+      return { type: "deepseek", deepseek: params.invocationParameters ?? {} };
     case "XAI":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "xai",
-          xai: invocation_parameters ?? {},
-        },
-      };
+      return { type: "xai", xai: params.invocationParameters ?? {} };
     case "OLLAMA":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "ollama",
-          ollama: invocation_parameters ?? {},
-        },
-      };
+      return { type: "ollama", ollama: params.invocationParameters ?? {} };
     case "AWS":
-      return {
-        description,
-        model_provider,
-        model_name,
-        template_type: "CHAT",
-        template_format,
-        template: {
-          type: "chat",
-          messages: templateMessages,
-        },
-        invocation_parameters: {
-          type: "aws",
-          aws: invocation_parameters ?? {},
-        },
-      };
+      return { type: "aws", aws: params.invocationParameters ?? {} };
     default:
-      return assertUnreachable(model_provider);
+      return assertUnreachable(params);
   }
 }