Arize Phoenix TS
    Preparing search index...
    • A helper function to construct a prompt version declaratively.

      The output of this function can be used to create a prompt version in Phoenix.

      Parameters

      Returns {
          description?: string | null;
          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: string; name: string; type: "function" };
                          tool_call_id: string;
                          type: "tool_call";
                      }
                      | {
                          tool_call_id: string;
                          tool_result: | string
                          | number
                          | boolean
                          | { [key: ...]: ... }
                          | (...)[]
                          | null;
                          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;
      }

      Structured prompt version data, not yet persisted to Phoenix.

      • Optionaldescription?: string | null

        Description

      • 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;
                };
            }

        Invocation Parameters

      • model_name: string

        Model Name

      • model_provider:
            | "OPENAI"
            | "AZURE_OPENAI"
            | "ANTHROPIC"
            | "GOOGLE"
            | "DEEPSEEK"
            | "XAI"
            | "OLLAMA"
            | "AWS"
      • Optionalresponse_format?:
            | {
                json_schema: {
                    description?: string;
                    name: string;
                    schema?: { [key: string]: unknown };
                    strict?: boolean;
                };
                type: "json_schema";
            }
            | null

        Response Format

      • template:
            | {
                messages: {
                    content: | string
                    | (
                        | { text: string; type: "text" }
                        | {
                            tool_call: { arguments: string; name: string; type: "function" };
                            tool_call_id: string;
                            type: "tool_call";
                        }
                        | {
                            tool_call_id: string;
                            tool_result: | string
                            | number
                            | boolean
                            | { [key: ...]: ... }
                            | (...)[]
                            | null;
                            type: "tool_result";
                        }
                    )[];
                    role: | "user"
                    | "assistant"
                    | "model"
                    | "ai"
                    | "tool"
                    | "system"
                    | "developer";
                }[];
                type: "chat";
            }
            | { template: string; type: "string" }

        Template

      • template_format: "NONE" | "MUSTACHE" | "F_STRING"
      • template_type: "STR" | "CHAT"
      • Optionaltools?:
            | {
                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