Table of Contents

Features

Neos offers AI features that you can easily add to your clusters. This guide explains how to enable them.

Each feature will use an AI model you have defined in Neos Studio. You need to configure the API key (and optionally the API endpoint) for this model. Refer to the configuration documentation.

This feature activates a button in the quick search field of the filter bar, allowing the user to enter the filter in natural language.

dotnet user-secrets set "AI:SmartSearchModel" "[Your chosen model]" --id "[Your cluster root namespace].AspNetCore"
Note

The LLM model generates an oData filter string from the natural language data. Only oData filters supported by the entity view can be generated. For example, a filter on a collection or reference not included in the entity view will not be generated correctly.

Note

We recommend using OpenAI GPT models.

Smart localizable string translation

This feature activates a "Translate" button in the modal of Localizable String inputs, which automatically fills in values for languages not entered.

dotnet user-secrets set "AI:SmartLocalizableStringModel" "[Your chosen model]" --id "[Your cluster root namespace].AspNetCore"

Auto-suggest

This feature automatically suggests property values when users modify related fields. For example, when entering a city name, the system can suggest the corresponding postal code.

dotnet user-secrets set "AI:AutoSuggestModel" "[Your chosen model]" --id "[Your cluster root namespace].AspNetCore"

Configure auto-suggest prompts at the UI view property level using AIAutoSuggestPrompt and AIAutoSuggestTriggers metadata:

- Name: PostalCode
  AIAutoSuggestPrompt: Suggest a postal code based on the city {{ city }}
  AIAutoSuggestTriggers:
  - City

For detailed configuration options and advanced usage, see Auto-suggest.