Interface OpenAIPromptVersionInput

interface OpenAIPromptVersionInput {
    description?: string;
    invocationParameters?: {
        frequency_penalty?: number;
        max_completion_tokens?: number;
        max_tokens?: number;
        presence_penalty?: number;
        reasoning_effort?: "minimal" | "low" | "medium" | "high";
        seed?: number;
        temperature?: number;
        top_p?: number;
    };
    modelName: string;
    modelProvider: "OPENAI";
    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: | null
                | string
                | number
                | boolean
                | { [key: string]: unknown }
                | unknown[];
                type: "tool_result";
            }
        )[];
        role: | "user"
        | "assistant"
        | "model"
        | "ai"
        | "tool"
        | "system"
        | "developer";
    }[];
    templateFormat?: "NONE"
    | "MUSTACHE"
    | "F_STRING";
}

Hierarchy

  • PromptVersionInputBase
    • OpenAIPromptVersionInput

Properties

description? invocationParameters? modelName modelProvider template templateFormat?

Properties

Optionaldescription

description?: string

The description of the prompt version.

OptionalinvocationParameters

invocationParameters?: {
    frequency_penalty?: number;
    max_completion_tokens?: number;
    max_tokens?: number;
    presence_penalty?: number;
    reasoning_effort?: "minimal" | "low" | "medium" | "high";
    seed?: number;
    temperature?: number;
    top_p?: number;
}

Type declaration

  • Optionalfrequency_penalty?: number

    Frequency Penalty

  • Optionalmax_completion_tokens?: number

    Max Completion Tokens

  • Optionalmax_tokens?: number

    Max Tokens

  • Optionalpresence_penalty?: number

    Presence Penalty

  • Optionalreasoning_effort?: "minimal" | "low" | "medium" | "high"

    Reasoning Effort

  • Optionalseed?: number

    Seed

  • Optionaltemperature?: number

    Temperature

  • Optionaltop_p?: number

    Top P

modelName

modelName: string

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

modelProvider

modelProvider: "OPENAI"

template

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

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

    Content

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

    Role

OptionaltemplateFormat

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

The format of the template.

Default

"MUSTACHE"

Settings

Member Visibility

On This Page

Properties