Edit online

Oxygen AI Positron Custom Connector Plugin for Web Author

The Oxygen AI Positron Custom Connector for Web Author plugin contributes a custom connector for the Oxygen AI Positron Assistant. The connector, named Custom AI Service, enables integration with a custom AI service that exposes a REST API, similar to OpenAI's chat-completion API. Unlike the built-in Open AI connector, this supports the OAuth Client Credentials Flow for authentication and offers more flexibility by letting you set query parameters.
Note:
The Oxygen AI Positron Custom Connector is compatible with Oxygen XML Web Author version 27.1.0 or newer.

Installation

You can download the plugin from here: Oxygen AI Positron Custom Connector Download.

You can then install the plugin in the Web Author or Content Fusion server to make the Custom AI Service connector available in Oxygen AI Positron Assistant Enterprise for Web Author plugin.

How to Use the Connector

When the Custom AI Service is selected from the AI Service administration page, the following options are available to configure the connector:

Base URL
The web address of the custom AI service. By default, it is https://api.openai.com/v1.
API Key
The API key necessary to work with the connector. If you do not specify an API key, the connector will try to use environmental variables or system properties to authenticate using the OAuth Client Credential Flow. These are the environmental variables or system properties that should be specified:
  • POSITRON_CONNECTOR_AUTH_DOMAIN: The domain for the authorization server (e.g., 'example-123abc.us.auth0.com'). This is not required if POSITRON_CONNECTOR_AUTH_TOKEN_URL is defined.
  • POSITRON_CONNECTOR_AUTH_CLIENT_ID: The ID of the requesting client.
  • POSITRON_CONNECTOR_AUTH_CLIENT_SECRET: The secret of the client.
  • POSITRON_CONNECTOR_AUTH_AUDIENCE: The audience for the token, typically the API or service you're accessing. Optional.
  • POSITRON_CONNECTOR_AUTH_ORGANIZATION: The organization name or identifier. Optional.
  • POSITRON_CONNECTOR_AUTH_SCOPE: The OAuth 2.0 scope to request when generating the access token. Optional.
  • POSITRON_CONNECTOR_AUTH_TOKEN_URL: Full URL to the token endpoint used to obtain the access token. When this variable is defined, it overrides the default behavior and is used directly for the OAuth token request. Example: https://your-okta-domain.com/oauth2/abc123/v1/token. If this variable is not set, the request URL is constructed automatically using the following pattern: https://<POSITRON_CONNECTOR_AUTH_DOMAIN>/oauth/token.

You can find more information about how you can find these values in Auth0 here: Auth0 Client Credentials Flow Parameters.

Model
The model to use.
Enable Text Moderation
This setting applies moderation to both the input text sent to the AI service and the response received from the AI service. It is enabled by default. By default, when executing an action using this connector, three requests are made:
  • A moderation on the input content request to configured_address/moderations.
  • A completion request to configured_address/chat/completions.
  • A moderation on content returned by the AI to configured_address/moderations.
Note:
If your AI service does not require moderation (for example, moderation is already made by the chat/completions endpoint), you can disable it by deselecting this option.
Enable Streaming
When this option is disabled, the connector will only execute requests without streaming to the AI service. It is useful when the AI service does not support streaming. It is enabled by default.
Extra Headers
Extra name/value parameters to set in the headers of the AI requests.