Skip to main content
Starters are suggestions to help your users get started with your assistant.
starters.py

Starters example

Starter Categories

You can group starters into categories that appear as clickable buttons. Users select a category to reveal its starters. Define categories with @cl.set_starter_categories:
starter_categories.py
StarterCategory accepts:
  • label (str) — the category button text
  • icon (str, optional) — URL for the category icon
  • starters (List[Starter]) — starters shown when the category is selected
The callback accepts the same optional parameters as @cl.set_starters: user, language, and chat_profile. All are optional — declare only what you need.
profile_categories.py
The chat_profile parameter is available since version 2.11.1.
When both @cl.set_starters and @cl.set_starter_categories are defined, categories take precedence.
Since version 2.10.0.

With Localization

The @cl.set_starters callback accepts an optional language parameter, allowing you to return localized starters based on the user’s language.
localized_starters.py

With Chat Profiles

Starters also work with Chat Profiles. You can define different starters for different chat profiles.
starters_with_chat_profiles.py