Ask AI

Your users can get instant answers about your product with Ask AI. The assistant uses your selected model, trained on your documentation, to deliver accurate, context-aware responses. It includes direct links to your docs, allowing users to explore topics in more detail.

---

End-User Preview

When your users interact with Ask AI, it’ll open the Assistant with your custom example questions and receive responses based on your configurations from the Admin panel. Responses will only reference any public pages. For Enterprise groups with public and private projects, Ask AI will provide info based on the users’ permission to view a project.

Configure

Customize the AI assistant’s tone, answer length, and forbidden to fit your branding. Set example questions for your end-users to see and select an available model that fits your needs.

Enterprise Groups

All configurations mentioned above are available for Enterprise projects in your Group Dashboard. Customizations at the group level will apply across all corresponding child projects.

Analytics

Dig into user questions, responses, and feedback to understand what your users are looking for—and how effectively the assistant is performing. You can view all analytics in the Ask AI dashboard under Settings. To share insights with your team, export the data as a CSV with custom date ranges. The export process may take some time depending on the data volume, but when ready, the download will immediately begin in your browser.

FAQ

What happens to my data?

Ask AI is powered by OpenAI’s APIs and the Markdown content along with API definitions are sent to them to generate answers to user questions. While OpenAI retains logs of these API requests for 30 days, no data is used to train their AI models.

Does Ask AI reference hidden pages?

No, hidden pages are nevere indexed by Ask AI. For Enterprise groups, only project content the user has access to is used to answer questions.

How quickly are changes added to Ask AI’s models?

Currently, new content is updated every 2 hours though this may change as we continue to develop Ask AI.

What tools are offered to monitor responses?

Logs for every question and answer are available in the admin dashboard. See Analytics above.

How can I try Ask AI?

You can test Ask AI on ReadMe’s docs or on your own docs as a trial.

I’m using the previous Ask AI experience. Where can I find these settings?

You can upgrade to the new experience from the configuration panel in the Ask AI panel. Upgrading is permanent and cannot be done.