Semantic Kernel JavaScript
    Preparing search index...

    Class InputVariable

    Represents an input variable for prompt functions.

    Index

    Constructors

    constructor

    Properties

    _name allowDangerouslySetContent default? isRequired jsonSchema?

    Accessors

    description name

    Constructors

    • Parameters

      • __namedParameters: {
            allowDangerouslySetContent?: boolean;
            defaultValue?: unknown;
            description?: string;
            isRequired?: boolean;
            jsonSchema?: string;
            name: string;
        }

      Returns InputVariable

    Properties

    _name

    _name: string
    allowDangerouslySetContent: boolean

    Indicates whether to handle the variable value as potentially dangerous content.

    default?: unknown

    Default value for the variable.

    isRequired: boolean

    Indicates whether the variable is considered required.

    jsonSchema?: string

    JSON Schema describing this variable.

    Accessors

    • get description(): string

      Gets or sets the name of the variable.

      Returns string

    • set description(value: string): void

      Gets or sets a description of the variable.

      Parameters

      • value: string

      Returns void

    • get name(): string

      Gets or sets the name of the variable.

      Returns string

    • set name(value: string): void

      Gets or sets the name of the variable.

      Parameters

      • value: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors