Function InputField

invokeai/app/invocations/fields.py:611–815

Creates an input field for an invocation. This is a wrapper for Pydantic's [Field](https://docs.pydantic.dev/latest/api/fields/#pydantic.fields.Field) that adds a few extra parameters to support graph execution and the node editor UI. If the field is a `ModelIdentifierField`, use

(
    # copied from pydantic's Field
    # TODO: Can we support default_factory?
    default: Any = _Unset,
    default_factory: Callable[[], Any] | None = _Unset,
    title: str | None = _Unset,
    description: str | None = _Unset,
    pattern: str | None = _Unset,
    strict: bool | None = _Unset,
    gt: float | None = _Unset,
    ge: float | None = _Unset,
    lt: float | None = _Unset,
    le: float | None = _Unset,
    multiple_of: float | None = _Unset,
    allow_inf_nan: bool | None = _Unset,
    max_digits: int | None = _Unset,
    decimal_places: int | None = _Unset,
    min_length: int | None = _Unset,
    max_length: int | None = _Unset,
    # custom
    input: Input = Input.Any,
    ui_type: Optional[UIType] = None,
    ui_component: Optional[UIComponent] = None,
    ui_hidden: Optional[bool] = None,
    ui_order: Optional[int] = None,
    ui_choice_labels: Optional[dict[str, str]] = None,
    ui_model_base: Optional[BaseModelType | list[BaseModelType]] = None,
    ui_model_type: Optional[ModelType | list[ModelType]] = None,
    ui_model_variant: Optional[ClipVariantType | ModelVariantType | list[ClipVariantType | ModelVariantType]] = None,
    ui_model_format: Optional[ModelFormat | list[ModelFormat]] = None,
    ui_model_provider_id: Optional[str | list[str]] = None,
)

def InputField(
    # copied from pydantic's Field
    # TODO: Can we support default_factory?
    default: Any = _Unset,
    default_factory: Callable[[], Any] | None = _Unset,
    title: str | None = _Unset,
    description: str | None = _Unset,
    pattern: str | None = _Unset,
    strict: bool | None = _Unset,
    gt: float | None = _Unset,
    ge: float | None = _Unset,
    lt: float | None = _Unset,
    le: float | None = _Unset,
    multiple_of: float | None = _Unset,
    allow_inf_nan: bool | None = _Unset,
    max_digits: int | None = _Unset,
    decimal_places: int | None = _Unset,
    min_length: int | None = _Unset,
    max_length: int | None = _Unset,
    # custom
    input: Input = Input.Any,
    ui_type: Optional[UIType] = None,
    ui_component: Optional[UIComponent] = None,
    ui_hidden: Optional[bool] = None,
    ui_order: Optional[int] = None,
    ui_choice_labels: Optional[dict[str, str]] = None,
    ui_model_base: Optional[BaseModelType | list[BaseModelType]] = None,
    ui_model_type: Optional[ModelType | list[ModelType]] = None,
    ui_model_variant: Optional[ClipVariantType | ModelVariantType | list[ClipVariantType | ModelVariantType]] = None,
    ui_model_format: Optional[ModelFormat | list[ModelFormat]] = None,
    ui_model_provider_id: Optional[str | list[str]] = None,
) -> Any:
    """
    Creates an input field for an invocation.

    This is a wrapper for Pydantic's [Field](https://docs.pydantic.dev/latest/api/fields/#pydantic.fields.Field)
    that adds a few extra parameters to support graph execution and the node editor UI.

    If the field is a `ModelIdentifierField`, use the `ui_model_[base|type|variant|format]` args to filter the model list
    in the Workflow Editor. Otherwise, use `ui_type` to provide extra type hints for the UI.

    Don't use both `ui_type` and `ui_model_[base|type|variant|format]` - if both are provided, a warning will be
    logged and `ui_type` will be ignored.

    Args:
        input: The kind of input this field requires.
        - `Input.Direct` means a value must be provided on instantiation.
        - `Input.Connection` means the value must be provided by a connection.
        - `Input.Any` means either will do.

        ui_type: Optionally provides an extra type hint for the UI. In some situations, the field's type is not enough
        to infer the correct UI type. For example, Scheduler fields are enums, but we want to render a special scheduler
        dropdown in the UI. Use `UIType.Scheduler` to indicate this.

        ui_component: Optionally specifies a specific component to use in the UI. The UI will always render a suitable
        component, but sometimes you want something different than the default. For example, a `string` field will
        default to a single-line input, but you may want a multi-line textarea instead. In this case, you could use
        `UIComponent.Textarea`.