Arize Phoenix TS
    Preparing search index...

    Function createPrompt

    • Create a prompt and store it in Phoenix.

      If a prompt with the same name exists, a new version of the prompt will be appended to the history.

      Parameters

      • params: CreatePromptParams

        The parameters to create a prompt, including optional metadata.

      Returns Promise<
          {
              description?: string
              | null;
              id: string;
              invocation_parameters:
                  | {
                      anthropic: {
                          max_tokens: number;
                          stop_sequences?: string[];
                          temperature?: number;
                          thinking?: | { type: "disabled" }
                          | { budget_tokens: number; type: "enabled" };
                          top_p?: number;
                      };
                      type: "anthropic";
                  }
                  | {
                      aws: { max_tokens?: number; temperature?: number; top_p?: number };
                      type: "aws";
                  }
                  | {
                      azure_openai: {
                          frequency_penalty?: number;
                          max_completion_tokens?: number;
                          max_tokens?: number;
                          presence_penalty?: number;
                          reasoning_effort?: | "none"
                          | "minimal"
                          | "low"
                          | "medium"
                          | "high"
                          | "xhigh";
                          seed?: number;
                          temperature?: number;
                          top_p?: number;
                      };
                      type: "azure_openai";
                  }
                  | {
                      deepseek: {
                          frequency_penalty?: number;
                          max_completion_tokens?: number;
                          max_tokens?: number;
                          presence_penalty?: number;
                          reasoning_effort?: | "none"
                          | "minimal"
                          | "low"
                          | "medium"
                          | "high"
                          | "xhigh";
                          seed?: number;
                          temperature?: number;
                          top_p?: number;
                      };
                      type: "deepseek";
                  }
                  | {
                      google: {
                          frequency_penalty?: number;
                          max_output_tokens?: number;
                          presence_penalty?: number;
                          stop_sequences?: string[];
                          temperature?: number;
                          top_k?: number;
                          top_p?: number;
                      };
                      type: "google";
                  }
                  | {
                      ollama: {
                          frequency_penalty?: number;
                          max_completion_tokens?: number;
                          max_tokens?: number;
                          presence_penalty?: number;
                          reasoning_effort?: | "none"
                          | "minimal"
                          | "low"
                          | "medium"
                          | "high"
                          | "xhigh";
                          seed?: number;
                          temperature?: number;
                          top_p?: number;
                      };
                      type: "ollama";
                  }
                  | {
                      openai: {
                          frequency_penalty?: number;
                          max_completion_tokens?: number;
                          max_tokens?: number;
                          presence_penalty?: number;
                          reasoning_effort?: | "none"
                          | "minimal"
                          | "low"
                          | "medium"
                          | "high"
                          | "xhigh";
                          seed?: number;
                          temperature?: number;
                          top_p?: number;
                      };
                      type: "openai";
                  }
                  | {
                      type: "xai";
                      xai: {
                          frequency_penalty?: number;
                          max_completion_tokens?: number;
                          max_tokens?: number;
                          presence_penalty?: number;
                          reasoning_effort?: | "none"
                          | "minimal"
                          | "low"
                          | "medium"
                          | "high"
                          | "xhigh";
                          seed?: number;
                          temperature?: number;
                          top_p?: number;
                      };
                  };
              model_name: string;
              model_provider: | "OPENAI"
              | "AZURE_OPENAI"
              | "ANTHROPIC"
              | "GOOGLE"
              | "DEEPSEEK"
              | "XAI"
              | "OLLAMA"
              | "AWS";
              response_format?: | {
                  json_schema: {
                      description?: string;
                      name: string;
                      schema?: { [key: string]: unknown };
                      strict?: boolean;
                  };
                  type: "json_schema";
              }
              | null;
              template: | {
                  messages: {
                      content: | string
                      | (
                          | { text: string; type: "text" }
                          | {
                              tool_call: { arguments: ...; name: ...; type: ... };
                              tool_call_id: string;
                              type: "tool_call";
                          }
                          | {
                              tool_call_id: string;
                              tool_result: (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                              type: "tool_result";
                          }
                      )[];
                      role: | "user"
                      | "assistant"
                      | "model"
                      | "ai"
                      | "tool"
                      | "system"
                      | "developer";
                  }[];
                  type: "chat";
              }
              | { template: string; type: "string" };
              template_format: "NONE" | "MUSTACHE" | "F_STRING";
              template_type: "STR" | "CHAT";
              tools?:
                  | {
                      disable_parallel_tool_calls?: boolean;
                      tool_choice?: | { type: "none" }
                      | { type: "one_or_more" }
                      | { function_name: string; type: "specific_function" }
                      | { type: "zero_or_more" };
                      tools: {
                          function: {
                              description?: string;
                              name: string;
                              parameters?: { [key: string]: unknown };
                              strict?: boolean;
                          };
                          type: "function";
                      }[];
                      type: "tools";
                  }
                  | null;
          },
      >

      The created prompt version.

      await createPrompt({
        name: "my-prompt",
        description: "A helpful prompt",
        metadata: { environment: "production", team: "ai" },
        version: promptVersion({
          modelProvider: "OPENAI",
          modelName: "gpt-4",
          template: [{ role: "user", content: "Hello {{name}}" }]
        })
      });

    Settings

    Member Visibility