Tools and RAG

Tools and RAG Preferences

Various settings related to the use of tools for retrieval augmented generation can be configured in the Retrieval-Augmented Generation (RAG) preferences page (click the Settings button in the header and go to Retrieval-Augmented Generation (RAG)).
Enable tools
Enables the use of tools for retrieval-augmented generation and for writing content in the project.
Enable project-based RAG
Enables retrieval-augmented generation based on similar content obtained from the current open project. Actions and chat interactions generate content give more precise and meaningful responses when this setting is enabled. It is enabled by default. The available tools used for RAG are listed in the text box.
The AI actions that use RAG are:
  • Generate Documentation Draft
  • New DITA Topic
  • Expand Draft
  • Create Topics
Ask for confirmation
When selected (default), the end user is asked to confirm whenever each specific project-based RAG tool is about to be processed.
Content retrieval token limit
Specifies a limitation for the upper amount of project content that may be sent to the AI engine to enhance responses and tune them based on the currently open project.
Enable external RAG sources
Enables the use of external retrieval augmented generation sources.
Oxygen Feedback site token

When the Oxygen Feedback product is used to provide search functionality for a web site generated from the DITA XML project, its search system can be used to retrieve related content. In the Oxygen Feedback administrative interface, find the installation instructions for the site version that you want to use (click the Installation button on your version's tile in the Site Version page). The installation information contains a unique deploymentToken value that can be copied and pasted into the Oxygen Feedback site token field.

Oxygen Feedback site description
A description for this external content retrieval site that is passed to the AI engine to help it decide whether or not the external source is used.
Enable writing content in project
Allows tools that can be used by the AI to write content in the current project. The available tools used for this purpose are listed in the text box.
Limit read/write access to
Allows you to restrict the locations where tools can read and write content. You can specify these locations as a comma-separated list of resource paths. By default, read and write access is restricted to the project directory and the directory of the current root map.