The in-app AI assistant
BattleTest ships with an AI assistant inside the app: the sparkle button in the bottom corner of any signed-in page. It answers questions about your account in plain language and links you to the right place to act.
What it can do
Section titled “What it can do”The assistant is grounded in two things: this documentation, and your own data (read through a small set of read-only tools scoped to your signed-in account). It can:
- Explain your findings and PR reviews: “why was this PR flagged?”, “what are my open critical findings?”, “summarise my last battletest.”
- Answer usage and limit questions: “am I close to a review limit?”, “how many in-depth reviews have I used this month?”.
- Explain how the product works: anything covered in these docs: risk scores, the finding lifecycle, PR review vs live application testing, notifications.
- Take you there: when doing something is the answer, it offers a button that deep-links to the exact page (a specific finding, your notification settings, source-control settings).
What it will not do
Section titled “What it will not do”- It reads targets, findings, battletest history, and change reviews in organisations where your role permits access, plus your legacy personal targets. It cannot read an organisation where you lack permission.
- It won’t invent specifics. Exact numbers, thresholds, tiers, and limits come from the documentation or your account data. If something isn’t documented, it says so rather than guessing.
- It isn’t a security scanner. It reports on battletests and PR reviews that have already run. It does not test your site itself.
Privacy
Section titled “Privacy”Conversations are tied to your user account and are used only to answer your questions. The assistant’s data tools are read-only and scoped to your signed-in identity, so it can never surface another customer’s findings or account. See Security & Data Handling for how BattleTest handles your data overall.
- Ask about your current situation directly: “my usage this month”, “my open findings on
example.com”, “my last three PR reviews.” The assistant looks these up rather than guessing. - If an answer needs an exact number that isn’t in the docs, the assistant tells you where in the app to find it.
- Prefer to use your own AI tools (Claude, Cursor, ChatGPT)? You can connect the BattleTest documentation to them directly: see Connect the docs to your AI tools.
Documentation index
Section titled “Documentation index”Raw documentation ships with the deployment. The assistant can search it without an embedding model.
For semantic search, configure an embedding model in Settings → Providers → AI models, then select Build index under Documentation index. The same action is available during setup. The build uses the configured model and may incur charges from that provider.
The index is stored in the deployment database and survives restarts. Ready means the saved index matches the shipped documentation and configured model. If either changes, select Rebuild index when Update available appears. Build failed offers a retry. A failed rebuild preserves the previously stored vectors; the assistant uses raw documentation until an index matches the current configuration.
Enterprise deployments do not build or rebuild the documentation index automatically on startup.