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.
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.

Once you log in to the server, the following actions for generating content are available in the AI Positron Assistant side view, in the AI Positron Assistant submenu within the contextual menu, and in the AI main menu. The progress and results of triggering an action are displayed in the AI Positron Chat view:

Content Generation

• New DITA Topic - Generates a DITA XML topic based on a text description entered in a popup dialog box.
• 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.
• 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

The actions in this category translate the selected text to the target language (English, German, French, Japanese), while preserving the original XML markup.

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

• Usage status - Opens a dialog box that displays your usage information.
• 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 in the AI Positron Chat view (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.
• ${document} - Expands to the content of the entire document.

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

AI Positron Service address

Currently, there is only one public platform providing this service.

Load default actions

Specifies if default actions are loaded.

AI actions folder

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

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.

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

[
    {
        "id": "my.action.id",
        "title": "Improve Grammar",
        "type": "replace-selection-with-fragment",
        "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",
     "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"
      }
    ]
  }
]

ai:transform-content(instruction, content)

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

The function has two string parameters:

• instruction - The OpenAI instruction to be performed on the content.
• 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, 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.
• content - The content to be validation.

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>