Interface ResponsePrompt

Reference to a prompt template and its variables. Learn more.

interface ResponsePrompt {
    id: string;
    variables?: null | {
        [key: string]:
            | string
            | ResponseInputText
            | ResponseInputImage
            | ResponseInputFile;
    };
    version?: null | string;
}

Properties

id variables? version?

Properties

id

id: string

The unique identifier of the prompt template to use.

Optionalvariables

variables?: null | {
    [key: string]:
        | string
        | ResponseInputText
        | ResponseInputImage
        | ResponseInputFile;
}

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Optionalversion

version?: null | string

Optional version of the prompt template.

Settings

Member Visibility

On This Page

Properties