Arize Phoenix TS
    Preparing search index...

    Interface AnthropicPromptVersionInput

    interface AnthropicPromptVersionInput {
        description?: string;
        invocationParameters: {
            extra_body?: { [key: string]: unknown };
            max_tokens: number;
            output_config?: { effort?: "low" | "medium" | "high" | "xhigh" | "max" };
            stop_sequences?: string[];
            temperature?: number;
            thinking?:
                | { type: "disabled" }
                | {
                    budget_tokens: number;
                    display?: "summarized" | "omitted";
                    type: "enabled";
                }
                | { display?: "summarized"
                | "omitted"; type: "adaptive" };
            top_p?: number;
        };
        metadata?: { [key: string]: unknown };
        modelName: string;
        modelProvider: "ANTHROPIC";
        template: {
            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
                        | unknown[]
                        | { [key: string]: unknown }
                        | null;
                        type: "tool_result";
                    }
                )[];
            role: | "assistant"
            | "system"
            | "developer"
            | "user"
            | "model"
            | "ai"
            | "tool";
        }[];
        templateFormat?: "NONE"
        | "MUSTACHE"
        | "F_STRING";
    }

    Hierarchy

    • PromptVersionInputBase
      • AnthropicPromptVersionInput
    Index
    description? invocationParameters metadata? modelName modelProvider template templateFormat?
    description?: string

    The description of the prompt version.

    invocationParameters: {
        extra_body?: { [key: string]: unknown };
        max_tokens: number;
        output_config?: { effort?: "low" | "medium" | "high" | "xhigh" | "max" };
        stop_sequences?: string[];
        temperature?: number;
        thinking?:
            | { type: "disabled" }
            | {
                budget_tokens: number;
                display?: "summarized" | "omitted";
                type: "enabled";
            }
            | { display?: "summarized"
            | "omitted"; type: "adaptive" };
        top_p?: number;
    }

    The invocation parameters for the prompt version. For Anthropic, the invocation parameters are required since max_tokens is required.

    Type Declaration

    • Optionalextra_body?: { [key: string]: unknown }

      Extra Body

    • max_tokens: number

      Max Tokens

    • Optionaloutput_config?: { effort?: "low" | "medium" | "high" | "xhigh" | "max" }
      • Optionaleffort?: "low" | "medium" | "high" | "xhigh" | "max"

        Effort

    • Optionalstop_sequences?: string[]

      Stop Sequences

    • Optionaltemperature?: number

      Temperature

    • Optionalthinking?:
          | { type: "disabled" }
          | {
              budget_tokens: number;
              display?: "summarized" | "omitted";
              type: "enabled";
          }
          | { display?: "summarized"
          | "omitted"; type: "adaptive" }

      Thinking

    • Optionaltop_p?: number

      Top P

    metadata?: { [key: string]: unknown }

    Optional metadata for the prompt version as a JSON object.

    { "agent": "support", "dependencies": ["retriever"] }
    modelName: string

    The name of the model to use for the prompt version.

    modelProvider: "ANTHROPIC"
    template: {
        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
                    | unknown[]
                    | { [key: string]: unknown }
                    | null;
                    type: "tool_result";
                }
            )[];
        role: | "assistant"
        | "system"
        | "developer"
        | "user"
        | "model"
        | "ai"
        | "tool";
    }[]

    The template for the prompt version. Currently only chat is supported.

    Type Declaration

    • 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
                  | unknown[]
                  | { [key: string]: unknown }
                  | null;
                  type: "tool_result";
              }
          )[]

      Content

    • role: "assistant" | "system" | "developer" | "user" | "model" | "ai" | "tool"

      Role

    templateFormat?: "NONE" | "MUSTACHE" | "F_STRING"

    The format of the template.

    "MUSTACHE"

    Settings
    Member Visibility

    On This Page
    Properties