Oxygen AI Positron Assistant 3.0

September 5, 2024

The Oxygen AI Positron Assistant add-on is a powerful tool that helps users increase their productivity by providing support for using AI-generated content. Version 3.0 continues to increase the efficiency of using the tool and the quality of the AI responses through the implementation of a project Retrieval-Augmented Generation (RAG) process, various interface improvements, and additional AI-powered actions.

There are changes in:

Retrieval-Augmented Generation (RAG)

Retrieve Project Information to Provide More Context to the AI

When using the AI Positron Assistant add-on with Oxygen versions 26.1 or newer, certain actions (New DITA Topic, Add Structured Content, Generate Documentation Draft) now leverage the Retrieval-Augmented Generation (RAG) process. This output optimization process enhances the AI's responses by using information from the current project opened in the Project view to enrich the AI context for you to receive more meaningful and project-targeted responses.

RAG is also enabled by default for all chat sessions within the AI Positron Assistant. If you wish to configure the various RAG-specific settings, you can access the new Retrieval-Augmented Generation (RAG) preferences page.

Retrieve Project Information to Provide More Context to the AI

Function Calls

Within the definition of custom actions, you can reference existing functions that are called by the AI engine to interact with the application. This gives actions more context information and allows for more accurate answers to be constructed by the AI. The current available reference values for pre-defined function calls are:
  • get_related_content_from_project - Retrieves content from the user's local project based on given key words. It is limited to return a maximum of 50k characters and works with Oxygen version 26.1 or newer.
  • get_related_resources_overview_from_project and get_content_for_document_id - Retrieves an overview of a maximum of 5 documents that each contain an ID along with the most relevant information from each document (usually titles, key words, short descriptions). The second function can be called by the AI to retrieve the content of a certain document. It is also limited to return a maximum of 50k characters and works with Oxygen version 26.1 or newer.
  • get_current_document_plain_text_content - Obtains all text without markup from the current document open in the editor.
  • get_current_document_marked_up_content - Obtains all text with markup from the current document open in the editor.
  • get_content_around_caret - Obtains size-limited content around the current cursor location within the document open in the editor.

For more information about the function calls, see Oxygen AI Positron Assistant - Function Calls.

Interface Improvements

AI Positron Assistant Widget

For documents that are open in the Author visual editing mode, there is an AI Positron Assistant drop-down widget in the top-right corner of the editor. It offers a very quick and convenient way of accessing useful AI actions to create and improve the structure and content in the current document. The drop-down list can also be accessed while editing by using the Ctrl - Alt - Enter (Windows) or Ctrl - Enter (Mac) keyboard shortcuts. In this case, the drop-down list is displayed in a floating dialog box close to the text cursor location, making the functionality even more efficient.
AI Positron Assistant Widget

In-place AI Prompt Input Field

The AI Positron Assistant drop-down widget contains a helpful Rewrite content action that opens a floating input box close to the text cursor location where you can provide the AI with instructions on how to rewrite the selected content (or the current paragraph if there is no current selection).
New Floating Input Box to Provide Instructions to AI

Regenerate Response

After you receive a response from the AI, you now have the option to ask the AI to regenerate another answer. With OpenAI, you can also decide which engine model to employ when regenerating the response. For more information, see Oxygen AI Positron Assistant - Response Actions.
Regenerate Response

Preview Responses When Using AI Features in Text Mode

When using AI actions while working on your documents in the Text mode, you now have the ability to preview the AI-generated response before inserting the changes in the document.
Preview Responses When Using AI Features in Text Mode

Access Quick Assist Actions From Vertical Stripe Icon

Custom user-defined AI actions can now be configured to appear as Quick Assist fixes in the editor. To access these actions, you simply click the light bulb icon located on the vertical navigation stripe. This feature offers you convenience by providing direct access to frequently used fixes without the need to navigate through menus, and supports customization to better suit your workflow and preferences.
Access Quick Assist Actions From Vertical Stripe Icon

Easily Choose Between AI Models

The AI model used for each particular action or chat session can easily be changed from the convenient drop-down list located in the toolbar of the AI Positron Assistant view. The default model is now GPT-4o, which is an advanced model that provides better results but is more expensive than other models, so it is quite helpful to have a very quick and easy way of changing it for actions that may not require advanced results.

Additionally, the chat panel now specifies which AI model was used for each response.

Easily Change the AI Models

AI Models

GPT-4o-mini AI Model

The GPT-4o-mini AI model was added to the list of available models. According to the OpenAI documentation, it is the most advanced one in the "small models category" and also the least expensive model. You can choose to use this new model on a case-by-case basis or you can configure the connection settings to make it the default model used for all actions.

Improved Credit Usage Efficiency

The credit system has been updated to enhance cost efficiency. Now, input tokens and output tokens are treated differently when calculating consumed credits, with input tokens being less expensive than output tokens.

AI-Powered Actions

Proofread Action

When editing DITA XML documents, a new Proofread AI action is now available (in the Review category) to help you identify potential issues in your content. The AI will proceed to add comments in the content regarding logical consistency problems, grammar or spelling mistakes, or readability and comprehension issues.
Proofread Action

Resolve Comments Action

Another new AI action titled Resolve Comments was added in the Review category that enables the AI to change the selected content based on the suggestions found within comments. It then also removes the comments, saving you time in the cleanup process. The action becomes available when working with DITA XML documents.

Improve Structure Action

A new Improve Structure AI action (in the Rewrite category) can be used when working with DITA XML documents to instruct the AI to improve the selected DITA XML content by adding additional structure or inline elements.
Improve Structure Action

Add Structured Content Action

In the Content Generation category, a new Add Structured Content AI action was implemented that enables you to continue the content from a DITA XML document with additional structured content generated based upon similar content from the current project (if available). This helps the AI with context and leads to more accurate and higher quality results.

Web Author

Edit Messages Sent to AI

You can edit your message that you send to the AI by clicking a convenient edit button that appears to the right of your message in the response area. Once you submit your edited message, the AI regenerates the response. This streamlines the process of fine-tuning the results to suit your needs.
Edit Messages Sent to AI

Selected Content Sent to AI for Context

When directly initiating a new chat with the AI (without invoking an action), any content selected in the main editor area is automatically passed as context for the conversation. This feature allows you to effortlessly process content within the editor.

Improve Structure Action

A new Improve Structure AI action can be used to instruct the AI to improve the selected DITA XML content by adding additional structure or inline elements.
Improve Structure Action

Proofread Action

When editing DITA XML documents in Oxygen XML Web Author, a new Proofread AI action is now available to aid you in identifying potential issues in your content. The AI will then proceed to add comments in the content regarding logical consistency problems, grammar or spelling mistakes, or readability and comprehension issues.
Proofread Action

Resolve Comments Action

A new Resolve Comments AI action was implemented in Oxygen XML Web Author as well, enabling the AI to modify selected content based on suggestions in the comments. It also automatically removes the comments, saving you time during the cleanup process. This action is available when working with DITA XML documents.

Generate Image Alternate Text AI Action

When editing DITA XML files, you can use the new Generate Image Alternate Text AI action to generate an alternate text for an image that is selected in the editing area.
Generate Image Alternate Text AI Action

Function Calls

Within the definition of custom actions, you can reference existing functions that are called by the AI engine to interact with the application. This gives actions more context information and allows for more accurate answers to be constructed by the AI. The current available reference values for pre-defined function calls for Web Author are:
  • get_current_document_plain_text_content - Obtains all text without markup from the current document open in the editor.
  • get_current_document_marked_up_content - Obtains all text with markup from the current document open in the editor.
  • get_text_around_caret - Obtains size-limited content around the current cursor location within the document open in the editor.

Oxygen AI Positron Assistant 2.1

June 12, 2024

The Oxygen AI Positron Assistant add-on is a powerful tool that helps users increase their productivity by providing support for using AI-generated content. Version 2.1 expands upon the enhancements of the previous version by adding the advanced multi-modal GPT-4o to the list of models to choose from, as well as the Microsoft Azure OpenAI Service connector now supporting authentication using Microsoft Entra ID.

New AI actions have been introduced in this version, allowing users to generate, document, or explain specific code, initiate a conversation with the AI regarding certain code, and create alternate text for images. Furthermore, version 2.1 also introduces three AI XML refactoring actions aimed to improve the efficiency for users working with DITA XML topics.

For Web Author users who integrate the Oxygen AI Positron Assistant Enterprise for Web Author plugin, the ability to filter the list of AI actions is now available.

There are changes in:

Optimization

GPT-4o Model

GPT-4o was added to the list of models to choose from in the Oxygen AI Positron Assistant preferences page. This is OpenAI's most advanced multi-modal (able to accept text or image inputs) model and it is faster and less expensive than the GPT-4 Turbo model.

When utilizing the Oxygen AI Positron Assistant Enterprise add-on, access to the GPT-4o model is possible when connected to the OpenAI platform.

Enhanced Microsoft Azure OpenAI Service Connector Using Microsoft Entra ID Authentication

For the Enterprise version of Oxygen AI Positron Assistant, the Microsoft Azure OpenAI Service connector now supports authentication using Microsoft Entra ID, offering improved security and flexibility. Environment variables can be used for various authentication methods, including service principal and username/password authentication.

AI-Powered Actions

Explain Code AI Action

The new Explain Code AI action (located in the Development category) can be used to generate an explanation of the code found in the current selection, at the cursor location, or in the whole document. This action is available for XSLT, Schematron, XSD, CSS, XQuery, JSON, and JSON Schema documents.

Chat About Code AI Action

The Chat about Code AI action (located in the Development category) is now available and enables users to start a conversation with the AI regarding the code found in the current selection, at the cursor location, or in the whole document. Utilizing this feature, users can easily optimize and rewrite code blocks with the help of the AI Positron Assistant, thus enhancing their overall coding experience and efficiency. This action is available for XSLT, Schematron, XSD, CSS, XQuery, JSON, and JSON Schema documents.

Document Code AI Action

The newly introduced Document Code AI action (located in the Development category) can be used to generate the documentation for selected content, the current node, or the entire document. The generated documentation can then be inserted as an XML comment before the documented code. This feature is applicable to XSLT, XSD, and Schematron documents.

Generate Code AI Action

The Generate Code AI action (located in the Development category) allows users to generate code for various editor types (such as XSLT, Schematron, XSD, CSS, XQuery, JSON, and JSON Schema) based on the instruction specified in a selected text from the editor or in a comment preceding the cursor location.

Generate Image Alternate Text AI Action

When editing DITA XML files, the new Generate Image Alternate Text AI action can be used to generate an alternate text for an image that is selected in the editing area.

AI XML Refactoring Actions

The AI Positron Assistant add-on introduces a new category titled AI in the application's XML Refactoring wizard. This category includes three new XML refactoring actions aimed to improve the efficiency for users working with DITA XML topics: Generate alternate text for images in DITA XML topics, Generate missing short descriptions in DITA XML topics, and Shorten existing short descriptions in DITA XML topics.

Web Author

Filter List of Available Actions for Web Author

Oxygen XML Web Author users who integrate the Oxygen AI Positron Assistant Enterprise for Web Author plugin now have the ability to filter the list of AI actions. An additional option has been included in the Preferences page, enabling users to specify which actions should no longer appear in the list of available actions.

Miscellaneous

Selected Content Sent to AI for Context

When directly initiating a new chat with the AI (without invoking an action), any content selected in the main editor area is automatically passed as context for the conversation. This feature allows users to effortlessly process content within the editor.

Oxygen AI Positron Assistant 2.0

April 23, 2024

The Oxygen AI Positron Assistant add-on is a powerful tool that helps users increase their productivity by providing support for using AI-generated content. Version 2.0 adds support for Vision models, allowing the AI to also read and interpret images and thus supporting more use cases. The new Generate Documentation Draft action makes it possible for users to provide instructions and images to help the AI engine create a draft DITA topic. Furthermore, this version also introduces an action that enables users to simply update the images from a topic and have the AI analyze the images and propose content updates.

Oxygen XML Web Author users can now benefit from the new Oxygen AI Positron Assistant Enterprise plugin. Moreover, the Oxygen XML Enterprise edition license for Oxygen XML Editor, Author, and Developer products now includes access to the Oxygen AI Positron Assistant Enterprise add-on at no extra cost.

Oxygen XML Enterprise Edition Includes Free Access to AI Positron Assistant Enterprise Add-on

An Oxygen XML Enterprise edition license for Oxygen XML Editor, Author, and Developer products now includes access to the Oxygen AI Positron Assistant Enterprise add-on at no extra cost. The subscription license for Oxygen AI Positron Assistant Enterprise add-on remains available for Oxygen Professional, Academic, and Personal edition users that want to use the AI Positron Assistant Enterprise Add-on.

Oxygen AI Positron Assistant Enterprise Connector for Anthropic Claude

The Enterprise version of the Oxygen AI Positron Assistant add-on introduces a new connector for Anthropic Claude, along with the existing connectors for OpenAI and Microsoft Azure OpenAI Service, thus allowing users to connect directly to Anthropic Claude as well.

Vision Support

With the newly added vision support, the AI can now read and interpret images, thus supporting more use cases such as generating a documentation draft by also considering the content of some images or suggesting changes to the content of a topic based on updated images. Images can be easily added to the prompts entered in the Chat window using a dedicated attach action. The vision support is available for both the version that uses the Positron Service, as well as in the Enterprise version of the add-on (if the configured engine has vision support).
Vision Support

Generate Documentation Drafts

A new action called Generate Documentation Draft is available that can be used to create a draft DITA topic. To control the draft generation process, users can specify the context for the new topic, instructions, and images that will be analyzed using the vision support in a dedicated drafting configuration file that gathers all this information. Oxygen provides a customized editing experience in the visual Author editing mode for these draft configuration files so you can easily create such files just by following the instructions from the visual editor.

Generate Documentation Drafts

Update the Content of a DITA Topic Based on the Images that it References

A new Update content based on images action can be used to update the content of a DITA XML topic. This action reads the images referenced in the topic and analyzes their content to identify any missing information from the documentation, and suggests an update to the topic content.
Update the Content of a DITA Topic Based on the Images that it References

Quick Assist Actions

Some of the most frequently used AI actions (e.g. Correct Grammar, Improve Readability, Use Active Voice) are now available as Quick Assist fixes in the editor by clicking the bulb located on the vertical navigation stripe.
Quick Assist Actions

Variables to Obtain Selection with Track Changes Accepted/Rejected

Two new variables may be used when you write prompts: ${selection-original}, which expands to the selected text with all track changes rejected, and ${selection-final}, which expands to the selected text with all track changes accepted. Using these variables, you can provide the AI with both the original and modified text and ask the AI engine to analyze the change. For instance, you can determine if the AI considers that the final version demonstrates improved readability.

Filter the List of Actions

You now have the ability to filter the list of actions to exclude those that you do not use. An option was added in the Oxygen AI Positron Assistant preferences page where you can specify which actions will no longer be presented in the list of available actions.

GPT-4 Turbo

The GPT-4 Turbo Preview model, which could be used by the AI Positron Assistant with the cloud-based Oxygen AI Positron Service or by the Enterprise add-on when connecting to OpenAI, was replaced with the final GPT-4 Turbo engine release.

Oxygen AI Positron Assistant Enterprise Plugin for Web Author

Oxygen XML Web Author users now have access to the new Oxygen AI Positron Assistant Enterprise plugin for Web Author. This plugin provides connectors for direct access to your own OpenAI account or AI service hosted on Microsoft Azure.

AI XPath Functions Updated to Allow Adding a Conversation History

The signatures of the AI XPath functions ai:transform-content and ai:verify-content were modified to allow adding a conversation history when the functions are used. You can add multiple pairs of user-agent data that will be passed to the AI as the history of the conversation. This can be used for more complex actions that need to also set a context for the AI operation.

Oxygen AI Positron Assistant 1.1

February 7, 2024

The Oxygen AI Positron Assistant add-on is a powerful tool that helps writers increase productivity by providing support for using AI-generated content with the Oxygen AI Positron service. Version 1.1 introduces a separate Enterprise version of the add-on for those who want to configure the service to use a company-specific AI service (OpenAI or Microsoft Azure OpenAI Service). Moreover, this update brings a selection of new document templates to help you create your own custom AI actions, and a new action was implemented that allows you to translate content into any language. The interface was enhanced to provide easier access to actions, alongside the introduction of various other user experience enhancements.

To try the Oxygen AI Positron Assistant for yourself, there is an option to start with a trial period. Additionally, there are several subscription plans to choose from to align with specific usage needs.

Oxygen AI Positron Assistant Enterprise

A separate Enterprise version of the Oxygen AI Positron Assistant add-on is now available for those who have an OpenAI account or an OpenAI service hosted on Microsoft Azure. This version of the add-on allows you to leverage your own personalized AI models. You can configure your company-specific AI service details in the new AI Service Configuration preferences page (Options->Preferences->Oxygen AI Positron Assistant->AI Service Configuration). Oxygen AI Positron Assistant Enterprise requires a subscription license key to operate.

Create Custom AI Actions

New document templates are available to help you easily create AI Positron custom actions. The AI Positron Custom Action file template contains a single custom action definition in JSON format and can be used to configure a single action, while the AI Positron Custom Actions List file template provides a convenient way of defining multiple actions inside the same file.

Translate Content to Any Language

A new action (named "Other") was added inside the Translation section and can be used to translate content into any desired language. You are able to choose from predefined values or type your own values.

AI Refactoring Available for Remote Resources

The AI Positron Assistant add-on contributes an AI Positron Refactoring action in the contextual menu (Refactoring->AI Positron Refactoring) of both the Project and DITA Maps Manager views that can be used to refactor multiple files at once. Now, this feature also works when applied on remote resources (for example, resources placed on WebDav servers or Content Management Systems).

Easier Access to Actions

The available AI actions are now displayed as buttons in the Oxygen AI Positron Assistant view when the chat is empty (in addition to being displayed in the Actions drop-down menu). This was meant to provide easier access to the actions.

XML Syntax Highlights

The chat pane now uses XML syntax highlights for XML code to help make it easier to see and understand the XML structure.

Introducing Oxygen AI Positron Assistant 1.0

November 10, 2023

The Oxygen AI Positron Assistant add-on is a powerful tool that helps writers increase productivity by providing support for using AI-generated content with the Oxygen AI Positron service. Once installed, writers can utilize AI-generated content to perform repetitive tasks, review grammar, generate structure and text, or propose changes to improve readability. It always keeps the writer in control, offering a visual diff comparison to help quickly identify proposed changes and understand how the AI-generated content will appear in the content and you have the ability to refine proposals by continuing the chat with the AI.

To try the Oxygen AI Positron Assistant for yourself, there is an option to start with a trial period. Additionally, there are several subscription plans to choose from to align with specific usage needs.

There are changes in:

AI-Powered Actions

AI Positron Actions

The AI Positron Assistant side-view and various menus offer an extensive array of AI-powered predefined actions that enable users to:

  • Generate content such as DITA topics, document fragments, short descriptions, and index terms.
  • Improve existing content in terms of grammar, readability, and the use of active voice.
  • Get various insights to understand how readable the content is and how it responds to questions.
  • Translate to various languages while preserving the XML structure.
  • Write better marketing content with support for generating press releases, marketing posts, applying marketing frameworks, and for enhancing search engine optimization.

Custom AI Actions

In addition to the built-in AI actions, it is possible to create your own custom actions. In the Oxygen AI Positron Assistant preferences page, you can define a reference to a folder that contains custom actions, which can be easily created using Oxygen's new file wizard. The benefit of this feature is that it provides you with a seamless way to create, organize, and manage your custom actions to effectively leverage the power of AI technology within Oxygen.

Additional Features

AI Chat

The AI Positron Chat allows you to conveniently track the progress and view the results of triggered actions, along with the responses received from the AI platform. With actions available to insert the response within the document, preview the response insertion, or copy the response to the clipboard, you have complete control over the AI-generated content before it is incorporated into your document. Additionally, you can further refine the responses by sending messages directly to the AI Positron platform. It also supports storing favorite prompts, you can edit previously sent prompts, and a History drop-down allows you to revisit previous conversations and continue where you left off.

AI Fixes for Validation Problems

When validation problems are displayed in Oxygen's Results pane, you can right-click on a problem and use the AI Positron Fix action to request assistance from the Oxygen AI Positron platform to resolve the issue. It will propose content that can be used to solve the problem.
Validation Fixes

AI Refactoring

Refactor one or more files at once using the AI Positron Refactoring action that makes it possible to leverage the power of AI to efficiently edit and manage the structure of documents within your project. This action allows you to either choose from a list of predefined actions or provide custom instructions for the AI to follow. Additionally, you can preview the proposed changes before accepting them. The action is available in the Refactoring submenu when right-clicking files in both the Project and DITA Maps Manager views.

Record Examples for a Set of Instructions

Streamline and automate repetitive tasks using the Record button (located in the top left corner of the AI Positron Assistant view). It enables you to provide a set of instructions and record a collection of examples directly in the editing area to assist the AI in better understanding the given instructions. You can then save the final result either as a favorite prompt or as an AI Positron action that can be easily accessed and reused in future interactions with the AI Positron Assistant.

Subscriptions

Subscription plans were implemented to provide an easy way for users to purchase additional credits. There are 3 different subscription options to choose from, depending on your usage. The Explorer option is good for covering daily tasks when predominantly using GPT-3.5, the Professional option is great for a balanced use of GPT-3.5 and GPT-4, while the Expert option is ideal for intensive use of GPT-4.

Customization

AI Positron Preferences

The Oxygen AI Positron Assistant preferences page (Options > Preferences > Plugins) provides options for configuring custom actions and defining a context used in each action and chat request. This ensures that the AI-generated content is more relevant and aligned with your requirements, enhancing the overall quality of the responses. Additionally, the preferences page includes an option to cache identical requests. This feature works by sending fewer requests to the AI server, resulting in a faster and more efficient process.

Change Default Model

The Oxygen AI Positron Assistant preferences page has an option for changing the default model (GPT-3.5, GPT-4, or GPT-4 Turbo) to use for the chat view and for actions that do not explicitly specify a model.

AI-based XPath Functions

The add-on contributes two XPath extension functions [ai:transform-content(instruction, content) and ai:verify-content(instruction, content)] that can be used from custom Schematron schemas or XML Refactoring actions to rephrase content or to perform validation checks on existing content.