Oxygen AI Positron Assistant

To manually install this add-on, follow this procedure:

1. Go to Help > Install new add-ons to open an add-on selection dialog box. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu.
   Note: If you have issues connecting to the default update site, you can download the add-on package, unzip it, then use the Browse for local files action in the Install new add-ons dialog box to locate the downloaded addon.xml file.
2. Select the Oxygen AI Positron Assistant add-on and click Next.
   Important: There are two different iterations of the add-on and you can only have one or the other installed at once:

   • Oxygen AI Positron Assistant - The regular version of the add-on.
   • Oxygen AI Positron Assistant (Enterprise) - This Enterprise version is for those who want to connect to their own OpenAI or MS Azure OpenAI account.
3. Read the end-user license agreement. Then select the I accept all terms of the end-user license agreement option and click Finish.
4. Restart the application.

The progress and results of triggering an action are displayed in the main chat pane:

Content Generation

• Generate Documentation Draft - Generates a documentation draft of a DITA XML topic based on a configuration file that fine tunes the generation process by specifying the context, audience, summary, instructions, images, and a similar topic to help the AI generate the draft content.
• New DITA Topic - Generates a DITA XML topic based on a text description entered in a popup dialog box.
• Update Content Based on Images - Updates the content of a DITA XML topic based on the images that it references.
• Continue Writing - Generates additional text based on the content preceding the cursor position.

• Short Description - Generates a short description ( inside a <shortdesc> element) based on a summary of the selected text (or the entire document if there is no selection). You can configure the style and the approximate number of sentences to be generated.

• Index Terms - Generates a <keywords> element that contains index terms obtained from the selected text (or the entire document if there is no selection).

• Follow Instructions (available when editing schemas, XSLT stylesheets, and Schematron files) - Replaces the selected instructions with content generated based on them.

Rewrite

• Correct Grammar - Generates a suggestion for correcting the grammar and spelling within the selected content.
• Improve Readability - Modifies the selected content to improve readability and fix grammar/spelling errors. If you hover the mouse prompt over this button, a Settings button becomes available in the top-right corner. Clicking the Settings button opens a pop-up window where you can choose the writing level of the content to be generated. You can choose between: 5th grade (Very Easy), 8th grade (Plain English), and College (Advanced).
• Use Active Voice - Generates a suggestion for replacing the selected content with content that has been converted from passive to active voice.
• Itemize - Generates a suggestion for converting the selected content into a list of items.
• Join Items - Generates a suggestion for converting the selected list of items into a paragraph.

Overview

• Answer Questions - Generates answers to questions that the AI finds within the selected content (or the entire document if there is no selection).
• Generate Questions - Generates a list of five questions that are answered within the selected content (or the entire document if there is no selection).
• Summarize - Generates a summary of the selected content (or the entire document if there is no selection).
• Readability - Generates suggestions for changing the selected content (or the entire document if there is no selection) to improve its general readability.

Translation

• English, French, German, Japanese - These actions translate the selected text to the target language, while preserving the original XML markup.
• Other... - This action behaves like the previous ones, but it allows you to provide the target language. You can either choose from the predefined values or type another one.

Marketing

• Release Notes - Creates release notes based on a set of features or issue ticket numbers with optional descriptions.
• Marketing Post - Creates a marketing post based on a list of ideas or release notes.
• Improve SEO - Rewrites the content to enhance search engine optimization.
• Pain-Agitate-Solution - Rewrites the content using a marketing style based on the Pain-Agitate-Solution framework.
• Features-Advantages-Benefits - Rewrites the content using a marketing style based on the Features-Advantages-Benefits framework.

There is also a user drop-down menu at the top-right corner of the AI Positron Assistant view that contains the following:

• My account - Opens a webpage where you can see your current subscription package and credit status.
• Disconnect - Disconnects Oxygen from the Oxygen Positron Service.
• Preferences - Opens the Oxygen AI Positron Assistant preferences page where you can configure the AI Positron service address and provide a Context for the user that the AI will use to create more relevant and personalized responses.

The response is received from the server in streaming mode (the AI sends chunks of the response as it is being generated rather than waiting to send the entire response after it is generated). Once the entire response is received from the server, the following actions are available under the response:

• Insert/Replace - Inserts the response at the cursor location within the document (or replaces the selected content).
• Preview - Allows you to preview the content that would be inserted at the cursor location within the document.
• Copy - Copies the response to the system clipboard.

You can use the bottom pane to refine the response by sending a message to the AI platform and it will generate a new response based upon your message. You can create your own favorite prompts and use supported variables to specify the content that is sent to the platform. You can use the Favorites drop-down button to store a favorite prompt. You can use the Insert Variables drop-down button to select one of the supported variables:

• ${selection} - Expands to the currently selected content.
• ${selection-original} - Expands to the currently selected content. If the current selected content contains track changes, they are rejected, resulting in the original version of the text.
• ${selection-final} - Expands to the currently selected content. If the current selected content contains track changes, they are accepted, resulting in the final version of the text.
• ${document} - Expands to the content of the entire document.
• ${attach(filePath)} - Attaches a specified image (in png or jpeg format) or an XML or text file to the conversation. You can also attach files in an easier way by using the dedicated Attach action.

The simplest form of the configuration file would only contain the title and summary that will be used by the AI as a starting point:

<?xml version="1.0" encoding="UTF-8"?>
<doc-draft>
  <title>Generate Documentation Draft</title>
  <instructions>
    <draft-summary>The new "Generate Documentation Draft" action was added to the 
"Content Generation" category and can be used to draft a DITA documentation topic
using AI and a configuration file.</draft-summary>
  </instructions>
</doc-draft>

Other data elements can be used to further configure the drafting process, such as the context, target audience, instructions, images, and a similar topic.

<?xml version="1.0" encoding="UTF-8"?>
<doc-draft>
  <title>Generate Documentation Draft</title>
  <context>I am working on the user manual of a software application called Oxygen XML Editor,
 used for authoring and publishing XML content.</context>
  <prolog>
    <metadata>
      <audience>The audience of our user manual is very wide and includes 
people without a technical background.</audience>
    </metadata>
  </prolog>
  <instructions>
    <draft-summary>We have a new action in the contextual menu of the Project side-view,
 called "Format and Indent...",
 that can be used to pretty print multiple files at once. The action is available in both 
the Oxygen XML Editor stand-alone distribution and the Eclipse plug-in.</draft-summary>
    <instruction>Analyze the following image and document the dialog box
 and all its components.</instruction>
    <image href="format-and-indent-files.png"/>
    <instruction>Also add a DITA "note" element that mentions the fact that this feature 
is not available for XQuery files.</instruction>
  </instructions>
  <relationship-context>
    <similar-topic href="spell-check-in-files.dita"/>
  </relationship-context>
</doc-draft>

Various settings can be configured in Options > Preferences > Plugins > Oxygen AI Positron Assistant:

Context

The context provides useful information about the user to the AI and is used in each action and chat request to create more relevant and personalized responses.

Actions section

Load default actions

Specifies if default actions are loaded.

Additional actions folder

You can use this option to specify a local folder where you have stored additional actions.

Actions to exclude

You can specify a comma-separated list of IDs for the actions that should no longer be presented in the list of available actions. Use the menu to the right of the text field to choose the actions to exclude.

XPath Functions section

Enable XPath Functions

Enables the use of AI-specific XPath functions in Oxygen XML Editor when applying Schematron validation or XSLT transformations. This feature is disabled by default.

Cache responses and reuse them for identical prompts

If enabled (default), responses for identical requests are stored (cached), resulting in fewer requests being sent to the AI server and faster completion times. A Clear cache button located to the right of this option can be used to clear the cache.

Cache size

Specifies a maximum limit for the cache size.

Notify me when the number of requests exceeds

You can select this option and specify a number of AI requests that when exceeded, a confirmation dialog box is displayed asking if you want to continue using the XPath AI functions. If you select "No" for the answer, the XPath functions will be disabled.

Various service-related connection settings can be configured in Options > Preferences > Plugins > Oxygen AI Positron Assistant > AI Service Configuration:

AI Positron Service address

Currently, there is only one public platform that provides this service.

Default model

The default model is used for the chat pane and for actions that do not explicitly specify a fixed model. Each chosen model consumes a certain number of credits per token.

The most simple action defines an action id, title, type, and context:

{
    "id": "my.action.id",
    "title": "Improve Grammar",
    "type": "replace-selection-with-fragment",
    "input-type": "markup",
    "context": "Improve grammar in the following content preserving the XML markup:"
}

Defined actions can contain expandable parameters and their values can be customized before invoking the action:

{
   "id": "my.action.id",
   "title": "Improve Grammar",
   "type": "replace-selection-with-fragment",
   "input-type": "markup",
   "context": "${style} Improve grammar in the following content preserving the XML markup:",
   "expand-params":[
   {
           "name": "style",
           "label": "Style",
           "value": "",
           "alternate-values": ["Use active voice.", "Use passive voice."],
           "alternate-value-labels": ["Active voice", "Passive voice"],
           "choice-type": "single-choice"
    }
  ]
}

For example, if you want to add DITA markup to menu cascades, you can follow these steps:

1. Click the Record button.
2. In the Record examples for instructions dialog box, enter some instructions like: You are a technical writer. Add DITA markup to menu cascades.
3. Click Start recording.
4. Open a DITA topic that has a menu cascade without markup (for example: File > Export).
5. Edit the topic and add markup, transforming it to:

   <menucascade>
     <uicontrol>File</uicontrol>
     <uicontrol>Export</uicontrol>
   </menucascade>

6. Click the Record button again to stop the recording. The system generates the following instructions with examples:

   You are a technical writer. Add DITA markup to a menu cascades.
   ###
   Input:
           <p>File > Export</p>
   
   Output:
         <p><menucascade><uicontrol>File</uicontrol>
         <uicontrol>Export</uicontrol></menucascade></p>
   
   Input: ${selection}
   Output:
   

7. In the resulting dialog box, save the final result as either a Positron action or as a favorite chat prompt.

ai:transform-content(instruction, (user, agent,)* content)

Use this function from namespace http://www.oxygenxml.com/ai/function to automatically transform content using AI.

The function has the string parameters:

• instruction - The OpenAI instruction to be performed on the content.
• user, agent - You can add multiple pairs of user-agent data that will be passed to the AI as the history of the conversation.
• content - The content to be transformed.

It returns a string that represents the transformed content.

Here is an example of a custom Schematron schema that uses the transform-content function to correct the number of words used in a short description:

<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt3"
    xmlns:sqf="http://www.schematron-quickfix.com/validator/process">
    <sch:ns uri="http://www.oxygenxml.com/ai/function" prefix="ai"/>
    <sch:pattern>
        <sch:rule context="shortdesc">
            <sch:report test="count(tokenize(.,'\s+')) > 50" sqf:fix="rephrase">
      The phrase must contain less than 50 words.</sch:report>
            <sqf:fix id="rephrase">
                <sqf:description>
                    <sqf:title>Rephrase phrase to be less that 50 words</sqf:title>
                </sqf:description>
                <sqf:replace match="text()" select="ai:transform-content(
                'Reformulate phrase to be less that 50 words', .)"></sqf:replace>
            </sqf:fix>
        </sch:rule>
    </sch:pattern>
</sch:schema> 

ai:verify-content(instruction, (user, agent,)* content)

Use this function from namespace http://www.oxygenxml.com/ai/function to automatically validate content using AI.

The function has two string parameters:

• instruction - The OpenAI instruction to be performed on the content.
• user, agent - You can add multiple pairs of user-agent data that will be passed to the AI as the history of the conversation.
• content - The content to be validated.

It returns a boolean value that represents the result of the validation.

Here is an example of a custom Schematron schema that uses the verify-content function to check a short description for instances of a passive voice:

<sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt3"
  xmlns:sqf="http://www.schematron-quickfix.com/validator/process">
  <sch:ns uri="http://www.oxygenxml.com/ai/function" prefix="ai"/>    
  <sch:pattern>
    <sch:rule context="shortdesc">
      <sch:report test="ai:verify-content('Does the following content has passive voice?', .)"
            sqf:fix="rephrase">The phrase uses passive voice.</sch:report>
      <sqf:fix id="rephrase">
         <sqf:description><sqf:title>Rephrase text to be active voice</sqf:title>
</sqf:description>
         <sqf:replace match="text()"
                select="ai:transform-content('Rephrase text to be active voice', .)"/>
         </sqf:fix>
      </sch:rule>
  </sch:pattern>
</sch:schema>