yr.select

select(
    *options,
    instruction: str | None = None,
    name: str = 'Selection',
    on_wire: bool = False,
    **kwargs,
) → str

Use the active LLM to choose between a set of options.

Parameters

*options
type: str | Option = ()

One or more option labels or Option instances.

instruction
type: str | None = None

Instruction text to describe the purpose of this selection.

name
type: str = 'Selection'

Name for the generated class (default: "Selection").

on_wire
type: bool = False

Whether the field should be included in the LLM context (default: False).

**kwargs
type: object

Additional keyword arguments passed to the model fill method.

Returns

type: str

The selected option

Raises

ValueError

If fewer than two options are provided or labels are not unique.