Discourse AI - Helper

Documentation Site Management
, ,
1

:bookmark: This guide explains how to set up and use the Helper feature of the Discourse AI plugin, including its capabilities and configuration options.

:person_raising_hand: Required user level: Administrator

Helper assists users in community interaction, such as creating topics, writing posts, and reading content. It’s designed to enhance user productivity and improve the overall quality of contributions.

Features

Within composer

:information_source: Note: In this demonstration, there was already written content in the composer.

Helper offers several features when creating new topics or replies:

  • Generating topic titles, tags, and categories based on the content
  • Proofreading text - including grammar and spelling checks
    • Windows keyboard shortcut: CTRLALTP
    • MacOS keyboard shortcut: ⌘⌥ P
  • Translating selected text to the forum’s default language
  • Creating Markdown tables
  • Custom prompts for various text transformations
  • Viewing and managing AI-suggested changes
  • AI-powered captions for any uploaded images
  • Turn any written dates to markdown-friendly Smart dates

While reading topics and posts

When browsing the forum, Helper can:

  • Translate selected text to the user’s interface language
  • Explain the meaning of the selected text within the context of the topic
  • Proofreading text - including grammar and spelling checks
  • Custom prompts for various text transformations
  • Helper - Automatic chat threads titles

Enabling Helper

Prerequisites

You must configure at least one Large Language Model (LLM) from a provider.

To get started you can configure them through the Discourse AI - Large Language Model (LLM) settings page.

Configuration

  1. Navigate to Admin → Settings → Discourse AI
  2. Ensure the discourse ai enabled setting is checked
  3. Filter settings by ai helper
  4. Enable the Helper feature by checking composer ai helper enabled
  5. Select your preferred LLM in the ai_helper_model setting
  6. Use ai helper allowed groups to restrict Composer Helper usage
  7. Use post ai helper allowed groups to limit Post Helper feature access

Customizing Helper features

You can selectively enable or disable specific Helper features using the ai_helper_enabled_features setting. Available options include:

  • suggestions: Controls suggestion buttons for titles, categories, and tags
  • context_menu: Manages the menu for custom prompts, translation, and proofreading
  • image_caption: Turns on AI-powered image captions through auto caption or “Caption with AI” button

Technical FAQ

Unable to see the AI button next to the title, tag, or category?

  • AI Helper within composer requires a minimum of 10 words in the composer to appear and function.

How does the “Explain” feature work?

  • Explain uses the topic title, post content, and selected text as context for the LLM to generate output.

What are some uses of custom prompts?

  • Custom prompts can be used for various purposes, such as changing tone or translating to specific languages.

How accurate are Helper’s translations?

  • While generally reliable, translations may be less accurate for uncommon languages.

Caveats

  • We recommend limiting Helper access to specific user groups to help control costs associated with third-party LLM providers.

Last edited by @Saif 2024-12-31T03:33:55Z

Last checked by @hugh 2024-08-06T02:33:06Z

Check documentPerform check on document:
7 Likes
2

Sorry I can’t give this topic a like at present. :slightly_frowning_face: Don’t take that to mean I don’t like what the AI is doing, I think that part is great.

The video started from a Draft and most users will start from New Topic so it was a bit confusing for me when I tried this on the OpenAI forum where this is active thinking it should work.

When I started with New Topic I had to enter the title, select a category, skipped adding tags and add two lines in the post before the magic AI options appeared.

image

Then after adding more text the AI buttons appeared.

image

I do find the post quite useful and you did a nice job, just needs some clarification for users not use to this technology.

3

Side note:

In the early days of the Discourse AI there was the ability to have the AI generate a new title for the topic based on the existing text. I used this often as a category moderator when they titles ran long, think wrapped around when viewing in a list. Then the way to do this vanished; I may have missed how it was supposed to be done but now it is back with this.

As a category moderator one can not edit a post and the AI option is next to the title for changing.

Was looking for that in the announcement, might be worth a mention. :wink:

The following post contains some screenshots.

1 Like
4

Hey @EricGT so the video I put in a note that says that the content is already there. It was trying to make the demo video as short and succinct as possible.

I have the following documented for that reason!

1 Like
5

Little update on this one…

You can now select/deselect AI helper features using the setting ai_helper_enabled_features: :partying_face:

ai helper enabled features
ai helper enabled features1318×146 8.38 KB

3 Likes
6

image
image1180×362 26.6 KB

 ai_helper_model: We couldn't get a response from this model. Check your settings first.

What could be the problem? I’ve identified the Open AI key.

7

Is your OpenAI API key working? Can you issue a request for that same model from your PC?

2 Likes
8

It seems like it’s showing as unused in the OpenAI dashboard. But could it be because the configuration wasn’t completed? How can I verify this on my local machine?

9

What features are available, and what does each one do?

1 Like
10

The AI helper in the composer encompasses three main features including suggestions, context_menu, and image_caption

The setting allows us to have granular control of the AI helper by being able to enable/disable those main features.

  1. suggestions refers to the the suggestion buttons that appear in the composer next to the title/category/tags. Clicking the suggestion button can suggest topic titles, category, tags, etc.
  2. context_menu refers the the menu that appears when you select a portion of text in the composer, i.e. the menu that pops up with the custom prompt/translate/proofread/etc
  3. image_caption refers to the “Caption with AI” button that appears when you hover over an uploaded image in the composer preview. This allows you to generate a caption based on the contents of the image.
1 Like
11

Instead of a setting for which features are enabled, how about a setting for each, for which groups each is enabled for (if any)?

12

And actually, also… could the context menu items be separated? Ideally the same suggestion — list of groups for each.

15

I think eventually we would like to move to a system to provide more granular control of features within AI Helper and in other AI features, something in the radar for the future

1 Like
16

I think “translate to English” is outdated.

Now it’s translate to user’s interface language

Now it’s translate to forum’s default language

3 Likes
17

Is there any way do add additional prompt or instructions to the translation prompt?

In our case we want to offer translations EN->DE and add the instruction to use the informal you (Du) instead of the formal (Sie) you by default.

18

6 posts were split to a new topic: Will RAG Support PDF Files in the Future?

19

Really wanted to use strike-through with the text but can’t edit the post.

The first post is really nice and quite useful, so I gave it a thumbs up. I really do appreciate the extra effort put into your post and look forward to reading more.

1 Like