Edit online

Extending Functionality Using Add-ons (Enterprise)

The Oxygen AI Positron Assistant Enterprise add-on offers advanced options for developers to extend its functionality. Below is an overview of the main extension points available:

AI Connectors Extension
This extension point lets developers build an add-on that adds an AI connector to the Oxygen AI Positron Assistant Enterprise. It enables connections with AI providers not covered by our built-in options.
To create a connector, follow these steps:
  1. Add oxygen-ai-positron-api as a dependency in your plugin project's pom.xml:
    <dependency>
      <groupId>com.oxygenxml</groupId>
      <artifactId>oxygen-ai-positron-api</artifactId>
      <version>6.0.0</version>
      <scope>provided</scope>
    </dependency>
  2. Implement the ro.sync.exml.plugin.ai.AIConnectorsPluginExtension interface in your plugin's libraries.
  3. In the plugin descriptor file, define the <extension> element that points to the implementation of your classes:
    <extension type="AIConnectors" class="my.pack.CustomAIConnectorsProviderPluginExtension"/>
A sample plugin is available to show how to create a connector for a custom AI service that uses a REST API to provide OpenAI chat completions. You can find it here: https://github.com/oxygenxml/oxygen-ai-positron-custom-connector-addon
Note:
The AIConnectors extension type can be implemented starting with version 27.1 of Oxygen XML
AI Functions Extension
The AI Functions extension point lets developers add their own custom callback functions or replace the built-in ones. This makes it possible to create custom interactions with AI engines.
To implement a function, follow these steps:
  1. Implement the ro.sync.exml.plugin.ai.AIFunctionsPluginExtension interface in your plugin's libraries.
  2. In the plugin descriptor file, define the <extension> element that points to the implementation of your classes:
    <extension type="AIFunctions" class="my.pack.CustomAIFunctionsProviderPluginExtension"/>
Note:
The AIFunctions extension point can be implemented starting with version 27.0 of Oxygen XML