Parameter Configuration (preview)

This feature is available from 2.2.0-beta-1 and currently in preview state and subject to change.

Common parameters for all parameter types are String name, String description, Boolean required, Boolean hidden and Object defaultValue. Additional parameters depend on the type of the parameter.

Parameter Types

Parameter Type Description

string

Basic text parameter type. Supports all common parameters.

prompt

Special string type for AI model prompts. Usually used to render a HyperPrompt field in the UI.

number

Numeric parameter type. Supports all common parameters plus optional min and max values.

enum

Parameter with predefined options. Requires an additional enumValues array defining the available choices.

link

Special string type for handling URLs or resource links. Usually used to render a Link field in the UI. Requires an additional chooserId and workspace parameter.

boolean

True/false parameter type. Supports all common parameters with boolean values.

object

Complex parameter type for nested configurations. Supports all common parameters. This is used for complex input parameters without any specific type.
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the AI Accelerator module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules