Edit online

AI Positron Assistant Pane

The AI Positron Assistant side-view that is currently accessible on our online demo website provides various ways to use ChatGPT while editing or reviewing content. It has a comprehensive set of AI-powered actions to help writers use AI-generated content.

Using the AI Positron Assistant Pane

When you first open the pane, you need to use the Connect button to sign in. A user drop-down menu will be available in the top-right corner of the view. This drop-down contains a My account option that opens a webpage where you can see your current subscription package and credit status and an action to Disconnect from the service.

Figure 1. AI Positron Assistant Pane

The AI actions that are available can be found in the Actions drop-down menu at the top of the pane. When an action is triggered, the main box within the pane presents the response from the server based on the particular action.

You can also start chatting with the AI directly in the chat box at the bottom of the pane, without invoking an action. In this case, if there is content selected in the editor when a chat is initiated, the selection is passed to the AI along with the document type as context for the conversation.

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. This launches a file comparison tool where you can clearly see the differences between your current content and the changes being proposed by the AI. You can choose to accept some or all of the proposed changes and click the Apply button at the bottom to insert the response at the cursor location.
  • Copy - Copies the response to the system clipboard.

To clear the information, click the New Chat button in the top-right corner of the view. You can also use the History drop-down toolbar button to select and continue previous conversations or actions.

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 edit your message by clicking the Edit button that appears to the right of your message in the response area. You would then edit your message and click Submit to regenerate the response. For multiple edited messages, you can use the Next/Previous buttons to navigate between chat threads.

You can use the Attach image, XML, or text file button to attach one or more images or other documents (in XML or text format) to the chat message. The AI will use the selected resource for additional context for the conversation.

You can use the Favorites drop-down button to store a favorite prompt during the editing session.
Important: By default, favorites are not persistent in the demo Web Author web site. Content Management Systems that integrate Web Author can add two predefined variables (using JavaScript to the global window object) that point to operations used to store and retrieve persistent strings. Example:
window.POSITRON_RETRIEVE_OPERATION = "package.name.RetrieveOperation";
window.POSITRON_STORE_OPERATION ="package.name.StoreOperation";
with the RetrieveOperation implemented like this (for example):
@WebappRestSafe
@WebappCompatible
public class RetrieveOperation extends AuthorOperationWithResult {
  @Override
  public String doOperation(AuthorDocumentModel model, ArgumentsMap args)
      throws IllegalArgumentException, AuthorOperationException {
    return cmsPropertiesMap.getProperty(model.getUserId() + "." + args.getArgumentValue("key"));
  }
}
and StoreOperation implemented like this (for example):
@WebappRestSafe
@WebappCompatible
public class StoreOperation extends AuthorOperationWithResult {
  @Override
  public String doOperation(AuthorDocumentModel model, ArgumentsMap args)
      throws IllegalArgumentException, AuthorOperationException {
    cmsPropertiesMap.setProperty(model.getUserId() + "." + args.getArgumentValue("key"), (String) args.getArgumentValue("value"));
    return null;
  }
}

AI Actions

The following AI-powered actions are available in the Actions drop-down menu at the top of the AI Positron Assistant pane:

Accessibility
  • Generate Image Alternate Text - Generates an alternate text for a DITA XML image that is selected in the main editing area.
Content Generation
  • 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).

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.
  • Improve Structure - Improves the selected DITA XML content by adding additional structure or inline elements.
  • 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.
Review
  • Proof Read Add comments over content which has logical consistency problems, grammar spelling mistakes or is hard to read and comprehend.
  • Resolve Comments - Change the selected content based on the comment suggestions and then remove the comments.
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.

Intelligent Agents
  • Split Topic - Analyzes the current DITA XML topic based on modular document development best practices. If the topic is too large or contains multiple subjects, the AI may split it into several topic files. References to the new topics are also added in the DITA map that is currently open in the DITA Maps Manager.
  • Expand Draft - Enhances a draft of a DITA XML topic by refining the content, adding markup that is consistent with similar topics, and generating documentation based on the referenced images using Vision support. The AI looks for similar content in topics gathered from the related links or in WebHelp output with the Oxygen Feedback component deployed for search functionality.
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.

AI Server Requests and Credits

Each user has a limit to the number of requests that are sent to the AI server each month and this is managed through the use of credits.