API Reference / agent / tools / discovery /

list_components.py

Component listing.

Functions

Func

execute_list

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

List available components (algorithms, preprocessors, datasets, ...).

Backs the tuiml_list tool. Supports filtering, pagination, and a special category='custom' mode that lists user-created algorithms with their research-log summaries.

Parameters

category
str = 'all'
Component category to list ('all', 'algorithm', 'preprocessing', 'custom', ...). Arrives via **kwargs, like all parameters below.
search
str = None
Case-insensitive substring filter on name/description.
type
str = None
Algorithm type filter: 'classifier', 'regressor', 'clusterer', 'anomaly', 'associator', or 'timeseries'.
limit
int = 50
Maximum number of entries to return.
offset
int = 0
Pagination offset.
include_runs
bool = False
For category='custom': include per-version run details.

Returns

result
dict
On success: status ('success'), total, count, limit, offset, has_more, and components (each with name, description, category and, for algorithms, type and tags); category='custom' returns algorithms and a hint instead of components. On failure: status ('error'), error, error_type and suggestion.