Projects

Tune Answers with FAQs

Note
Note
Prefer a visual walkthrough? Check out this video.

Overview

Inkeep managed FAQs let you add question-answer pairs to your AI assistant knowledge base. FAQs can be used for two scenarios:

  • Tuning Answers: You can use FAQs to correct or "tune" answers from the AI assistant. FAQs are treated as high priority sources of truth for the AI assistant that "override" what it may see in other content sources or how it responds.
  • Document Private Knowledge: Sometimes, there is knowledge you want the AI assistant to know but doesn't easily belong in your docs or public content. You can treat Inkeep's FAQs as a private set of FAQs for your AI assistant.
Note
Note

Most customers do not find the need to tune answers. Inkeep is designed to be accurate and be clear and transparent when it's unsure. If you do see poor answers, we suggest checking if there's missing information, conflicting information, or ambiguous terms in the underlying documentation or supporting content. Fixing this often resolves issues and is beneficial to both the AI and end-users.

Accessing FAQs

  1. Open the Inkeep Dashboard
  2. Select your project
  3. Click Tune AI with FAQs in the sidebar

Managing FAQs

Create an FAQ

  1. Click +New FAQ in the top-right corner
  2. Fill in the fields:
    • Question: (Required) The primary question to match. Matches don't have to be exact.
    • Alternative questions: (Optional) Add variations of how users might ask similar questions for which the same answer applies.
    • Answer: (Required) Your preferred response
    • External URL: (Optional) Link to reference material or source of answer. This is not shown to users, it's used for internal tracking.
  3. Confirm Is enabled? is toggled for the FAQ to be active
  4. Click Save

View and Edit

From the Tune AI with FAQs tab, you can search, edit, and enable or disable FAQs.

Best Practices

Writing Effective FAQs

  • Be Specific: Target precise questions rather than broad topics
  • Keep it Concise: Provide clear, direct answers
  • Stay Current: Regularly review and update content

FAQ Sources

The Tune AI with FAQs tab is actually a consolidated list of all FAQs across all "Custom FAQs" sources.

A Custom FAQs source may come from:

  1. Default for Project: Whenever a project is created, there is a default Tuning FAQs source also created for the project.
  2. Manual Creation: Created directly from the Sources management UI.
  3. Support Tickets: Created whenever a Support Copilot integration is created. The Ticket into FAQ feature will save FAQs to this source.

Project Scope

You may enable a Custom FAQs source to be used across more than one project if you'd like. To do so, enable the source in the corresponding projects.

On this page