@arizeai/phoenix-client/src/types/prompts.ts

A client for the Phoenix API

import { components } from "../__generated__/api/v1";

/**
 * Supported prompt model providers
 */
export type PromptModelProvider =
  | "OPENAI"
  | "AZURE_OPENAI"
  | "ANTHROPIC"
  | "GOOGLE"
  | "DEEPSEEK"
  | "XAI"
  | "OLLAMA"
  | "AWS";

/**
 * Supported prompt provider SDKs
 *
 * These are possible sdk formats for prompt templates
 */
export type PromptProviderSDKs =
  | "PHOENIX"
  | "AZURE_OPENAI"
  | "OPENAI"
  | "ANTHROPIC"
  | "VERCEL_AI";

/**
 * The role of a prompt chat message
 */
export type PromptChatMessageRole = "user" | "system" | "ai" | "tool";

/**
 * Selector for a prompt by id.
 */
export interface GetPromptByIdSelector {
  promptId: string;
}

/**
 * Selector for a prompt by name.
 */
export interface GetPromptByNameSelector {
  name: string;
}

/**
 * Selector for a prompt by version id.
 */
export interface GetPromptByVersionSelector {
  versionId: string;
}

/**
 * Selector for a named prompt by tag.
 */
export interface GetPromptByTagSelector {
  tag: string;
  name: string;
}

/**
 * A prompt like object.
 *
 * Can be a prompt id, a prompt name, a prompt version id, or a prompt name + tag.
 */
export type PromptSelector =
  | GetPromptByIdSelector
  | GetPromptByNameSelector
  | GetPromptByVersionSelector
  | GetPromptByTagSelector;

/**
 * The prompt data needed to create a prompt.
 */
export type PromptData = components["schemas"]["PromptData"];

/**
 * The prompt version type from the API.
 *
 * aka the prompt at a specific point in time
 */
export type PromptVersion = components["schemas"]["PromptVersion"];

/**
 * The prompt version data needed to create a prompt version.
 */
export type PromptVersionData = components["schemas"]["PromptVersionData"];

/**
 * The invocation parameters for a prompt version for OpenAI.
 */
export type OpenAIInvocationParameters =
  components["schemas"]["PromptOpenAIInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for Azure OpenAI.
 */
export type AzureOpenAIInvocationParameters =
  components["schemas"]["PromptAzureOpenAIInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for Anthropic.
 */
export type AnthropicInvocationParameters =
  components["schemas"]["PromptAnthropicInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for Google.
 */
export type GoogleInvocationParameters =
  components["schemas"]["PromptGoogleInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for DeepSeek.
 */
export type DeepSeekInvocationParameters =
  components["schemas"]["PromptDeepSeekInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for xAI.
 */
export type XAIInvocationParameters =
  components["schemas"]["PromptXAIInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for Ollama.
 */
export type OllamaInvocationParameters =
  components["schemas"]["PromptOllamaInvocationParametersContent"];

/**
 * The invocation parameters for a prompt version for AWS.
 */
export type AwsInvocationParameters =
  components["schemas"]["PromptAwsInvocationParametersContent"];

/**
 * The format of the prompt template message(s).
 */
export type PromptTemplateFormat = PromptVersion["template_format"];

/**
 * Extracts the chat message type from the prompt template who may be a StringTemplate or ChatTemplate.
 */
export type PromptChatMessage = Extract<
  PromptVersion["template"],
  { messages: unknown[] }
>["messages"][number];

/**
 * Extracts the chat message part type from the prompt chat message.
 */
export type PromptChatMessagePart =
  | components["schemas"]["TextContentPart"]
  | components["schemas"]["ToolCallContentPart"]
  | components["schemas"]["ToolResultContentPart"];

/**
 * The Phoenix prompt tool type from the API.
 */
export type PromptTool = components["schemas"]["PromptTools"]["tools"][number];

/**
 * The Phoenix prompt tool choice type from the API.
 */
export type PromptToolChoice = NonNullable<
  components["schemas"]["PromptTools"]["tool_choice"]
>;
/**
 * The Phoenix prompt output schema type from the API.
 */
export type PromptResponseFormat =
  components["schemas"]["PromptResponseFormatJSONSchema"];

/**
 * The prompt type from the API.
 */
export type Prompt = components["schemas"]["Prompt"];