End User Guide: AI-Assisted Editor for Tiny in Open LMS

Saha Torres
Updated

Available_on_EDU.png

Introduction

Welcome to the AI-Assisted Editor for Tiny in Open LMS! This tool brings AI-powered assistance right into your content editor, helping Administrators and Teachers create, modify, and manage content across the platform with ease. Whether you’re composing announcements, drafting posts, or editing course materials, the AI Assistant streamlines your workflow, allowing you to generate text based on your prompts.

Main Feature: Generating Text with AI

At the core of the AI-Assisted Editor is the ability to generate text based on user requests. Simply click the AI Assistant icon in the toolbar, and a text field will display where you can interact with the AI by entering your prompt. Once the AI generates the content, you can:

  • Regenerate the text to get a different version.
  • Place it in the editor to be used in your post activity description etc.

This function allows for creative flexibility, empowering you to produce high-quality content quickly and effortlessly.

Additional Features:

  • Summarize Information: Quickly condense complex content into short, digestible summaries.
  • Create Tables: Automatically generate tables from existing text in seconds.
  • Expand Content: Enrich your content by expanding brief text with added detail and context.
  • Generate Bullet Points: Organize ideas into clear, concise bullet points.
  • Grammar Review: Ensure your writing is error-free with AI-powered grammar checks.
  • Change Tone: Easily adjust the tone of your writing to suit your audience—from formal to casual.
  • Adjust Style: Modify the writing style to meet your content needs.
  • Translate Text: Translate your content into 13 languages to reach a global audience.

Note: This plugin requires API keys to function. Follow the steps below to generate and configure your API keys.

 

Getting Started with the AI-Assisted Editor

The AI-Assisted Editor is enabled by default on all Open LMS EDU sites. If you don’t see the plugin available in your editor toolbar, please raise a support ticket so it can be activated for your site.

 

1. Obtaining API Keys for Your Preferred AI Provider

To use AI features, you’ll need an API key from at least one of the supported providers. Open LMS currently supports:

  • OpenAI

  • Anthropic

  • Gemini

  • DeepSeek

Follow the steps below based on your chosen provider(s):

OpenAI:
Go to the OpenAI Platform.
Sign in and follow the instructions to generate your API key.
Add credits to your OpenAI account, as usage is based on a pay-per-request model.

Anthropic:
Visit the Anthropic Console.
Generate your API key and review their usage and billing documentation.

Gemini (by Google):
Visit the Google AI Studio for Gemini.
Follow their instructions to obtain an API key for Gemini models.

DeepSeek:
Go to the DeepSeek Developer Portal (or equivalent).
Sign up or log in to your account.
Generate your API key from the console.
Review their documentation for usage limits, pricing, and billing options.

⚠️ Note: You can configure one or multiple providers at the same time and switch between them as needed.

2. Configuring the Plugin via Centralized AI Settings

AI provider configuration and feature toggling are handled through a centralized Open LMS AI settings page.

To configure:

  1. Log in to your Open LMS site as an administrator.

  2. Navigate to:
    Site administration > Open LMS > Open LMS AI
    Or go to:
    <your site>/admin/settings.php?section=openlms_ai

  3. In this settings page, you can:

    • Select the AI provider(s) you want to use.

    • Paste the corresponding API key(s) into the provided fields.

    • Enable AI-powered features such as the Tiny AI Editor

  4. Save your changes to activate AI functionality across your platform.

If you were already using OpenAI in earlier versions, your existing API configuration will be automatically migrated to this new settings page.

How to Use the AI-Assisted Editor

1. Generating Text Based on User Requests

This is the main feature of the AI Assistant, allowing you to generate content simply by interacting with the AI.

How to Use:

  1. Click the AI Assistant Icon in the Tiny toolbar.
  2. A text field will display where you can enter your request (prompt).
    • For example, you could ask the AI to “Generate an introduction for my course on history.”
  3. The AI will process your request and generate the text.
  4. Once the text is displayed, you can:
    • Regenerate if you want another version.
    • Insert the generated content into the editor by selecting the top arrow icon.

This feature enables you to generate new content based on your input, helping you create personalized, on-demand text efficiently.

2. Summarizing Content

You can quickly summarize lengthy information into concise versions.

How to Use:

  1. Highlight the text you want to summarize.
  2. Click the AI Assistant icon in the toolbar.
  3. Select Summarize.
  4. The AI will automatically generate a brief summary and insert it into your content.

3. Creating Dynamic Tables

Let the AI transform text into organized tables.

How to Use:

  1. Write or select the text you want to convert into a table.
  2. Click the AI Assistant icon and choose Create Table.
  3. The AI will generate a table and insert it into the editor.

4. Expanding Content

If your content needs more depth or detail, the AI can expand your writing.

How to Use:

  1. Highlight the text you want to expand.
  2. Click the AI Assistant icon and select Expand.
  3. The AI will add additional information to enrich your content.

5. Generating Bullet Points

Organize your thoughts and ideas by turning them into bullet points.

How to Use:

  1. Type a paragraph or list of ideas.
  2. Click the AI Assistant icon and choose Bullet Points.
  3. The AI will convert the text into a structured list of bullet points.

6. Reviewing Grammar

Ensure your writing is polished by using the AI to check grammar and spelling.

How to Use:

  1. Write or highlight the content you want to review.
  2. Click the AI Assistant icon and select Review Grammar.
  3. The AI will suggest corrections and improvements for your text.

7. Changing the Tone of Your Content

Easily adjust the tone of your writing to suit different audiences.

How to Use:

  1. Highlight your content.
  2. Click the AI Assistant icon and choose Change Tone.
  3. Select the tone you want (e.g., formal, casual), and the AI will rewrite your content accordingly.

8. Adjusting the Style

Modify the style of your content to match specific needs.

How to Use:

  1. Highlight the text you want to adjust.
  2. Click the AI Assistant icon and choose Adjust Style.
  3. The AI will change the style of your content as per your selection (e.g., professional, academic).

9. Translating Text into Multiple Languages

Translate your content into 13 different languages with ease.

How to Use:

  1. Highlight the text you want to translate.
  2. Click the AI Assistant icon and select Translate.
  3. Choose the target language, and the AI will provide a translated version of the content.

 

Troubleshooting

Issue: AI Assistant Not Appearing in the Toolbar

  • Possible Cause: The plugin may not be enabled.
  • Solution: Raise a support ticket to have the plugin activated for your site.

Issue: API Key Errors

  • Possible Cause: The API key might not be configured or might be incorrect.
  • Solution: Double-check your API key and ensure it is correctly entered in the settings at: <your site>/admin/settings.php?section=openlms_ai

Issue: Credit Usage 

  • Explanation: AI providers operates on a credit system based on API usage. Ensure your account has sufficient credits to prevent service interruptions.
Was this article helpful?
1 out of 1 found this helpful