Type alias CustomPlaceholder

CustomPlaceholder: {
    categories: number[];
    description: string;
    example: string;
    hintRepresentation: string;
    name: string;
    type: number;
    value: string;
}

A custom placeholder stored in custom_placeholders.json.

Type declaration

  • categories: number[]

    The category of the placeholder, used to inform design decisions.

  • description: string

    A description of the placeholder shown when the placeholder is detected in a prompt.

  • example: string

    An example usage of the placeholder, shown when the placeholder is detected in a prompt.

  • hintRepresentation: string

    A friendlier name for the placeholder, shown as the "name" of the placeholder when the placeholder is detected in a prompt.

  • name: string

    The name of the placeholder, used as a REGEX pattern to detect the placeholder.

  • type: number

    The type of the placeholder, used to inform design decisions.

  • value: string

    The text to replace the placeholder with. Can include other placeholders, which will be replaced before the custom placeholder is applied.

Generated using TypeDoc