By default, users can access the AI assistant by using the floating Ask AI button in the bottom-right corner or through the Search modal in the top navigation bar.
Use the aiAssistant configuration to:
- hide the AI search function
- add suggested pages to the search modal
- set the built-in prompt text
- add an Ask AI button
The aiAssistant option also supports page-level configuration using front matter.
| Option | Type | Description |
|---|---|---|
| hide | boolean | Hides the AI search button when set to true. Default: true. |
| prompt | string | Built-in instructions for AI search. Applied to all AI searches in the project and not visible to users. Use to set greeting, tone, or other answer conditions. |
| suggestions | [string] | List of suggestions displayed in the AI search interface. |
| trigger | Trigger button | Configures the Ask AI floating button. |
| Option | Type | Description |
|---|---|---|
| hide | boolean | Hides the trigger button when set to true. Default: false. |
| inputType | string | Type of UI component used to render trigger button. Possible values: button, icon. Default: button. |
| inputIcon | string | Icon of the trigger button component. Possible values: redocly, sparkles, chat. Default: sparkles. |
Data usage and privacy: Curious how AI Search uses your data? Redocly AI Search runs in inference-only mode and does not train or fine-tune AI models on your content. For details, see the AI Search data usage FAQ.
AI search and Typesense search indexes are only built on the production branch. Changes to search configuration or content exclusions, like the excludeFromSearch front matter option, may not immediately appear in search results until the next production build.
Display the AI search button with a custom prompt:
aiAssistant:
hide: false
prompt: Speak only in rhymesSet AI search suggestions:
aiAssistant:
hide: false
suggestions:
- How to create a new API?
- What is Redocly?
- How to manage an organization?
aiAssistant:
trigger:
hide: false
inputType: button
inputIcon: redocly