API Reference / agent / tools / discovery /

describe.py

Component introspection.

Functions

Func

execute_describe

Line 8
execute_describe(**kwargs) -> Dict[str, Any]

Describe a single component: its parameters, tags and description.

Backs the tuiml_describe tool. Resolves the name first as an algorithm in the component registry, then as a built-in dataset, then as a preprocessing / feature / splitting component tool.

Parameters

name
str
Name of the component to describe (arrives via **kwargs).

Returns

result
dict
On success: status ('success'), type, name, description and parameters (JSON Schema); algorithms also include tags and version, datasets include their info fields. On failure: status ('error'), error, suggestion, recovery_tool and recovery_params.