Prompts - Phoenix

The prompts module lets you create prompt versions in Phoenix, fetch them back by selector, list prompts, update a prompt’s description and metadata, and adapt prompt versions to supported provider SDKs.

Relevant Source Files

src/prompts/getPrompt.ts for the exact selector shape

Create A Prompt

import {
  createPrompt,
  promptVersion,
} from "@arizeai/phoenix-client/prompts";

await createPrompt({
  name: "support-response",
  description: "Customer support reply prompt",
  version: promptVersion({
    modelProvider: "OPENAI",
    modelName: "gpt-4o-mini",
    template: [{ role: "user", content: "Reply to {{question}}" }],
  }),
});

Fetch By Selector

import { getPrompt } from "@arizeai/phoenix-client/prompts";

const prompt = await getPrompt({
  prompt: { name: "support-response", tag: "production" },
});

prompt can be selected by { name }, { name, tag }, or { versionId }.

Update Description And Metadata

import { updatePrompt } from "@arizeai/phoenix-client/prompts";

await updatePrompt({
  promptIdentifier: "support-response",
  description: "Customer support reply prompt",
  metadata: { team: "ml", env: "production" },
});

promptIdentifier is a prompt name or ID. Omit a field to leave it unchanged, and pass description: null to clear it. metadata replaces the existing metadata object as a whole rather than merging into it. Requires a Phoenix server on 19.18.0 or later.

Convert To Another SDK

import { toSDK } from "@arizeai/phoenix-client/prompts";

const promptAsAI = toSDK({
  sdk: "ai",
  prompt,
  variables: { question: "Where is my order?" },
});

Supported sdk targets:

ai
openai
anthropic

Source Map

src/prompts/createPrompt.ts
src/prompts/getPrompt.ts
src/prompts/listPrompts.ts
src/prompts/updatePrompt.ts
src/prompts/sdks/toSDK.ts
src/types/prompts.ts

⌘I