AI Writing Assistant
The AI Writing Assistant AddOn is only available for Superpowers and Enterprise plans.
AI Writing Assistant Overview
Use this AddOn to enable the AI Writing Assistant for your end users. This AddOn allows users to generate text within their designs using AI, helping them complete their designs faster and more efficiently. This AddOn integrates with OpenAI or Azure OpenAI as the providers for this feature.
With this feature, your end users will see a “Write with AI” button for Title, Paragraph, List, and Button content blocks. Beefree SDK processes your end users' prompts, sends them to your AI provider, and returns the response to the end user. They can then decide to apply or regenerate the response.
By integrating the AI Writing Assistant, you provide your end users with a powerful tool to complete their designs quickly, which helps them maintain a competitive edge. This AddOn is quick and simple to integrate.
The following image provides an example of how the AI Writing Assistant looks to your end user:
Visit our Integrated AI Assistant White label end user guide to learn more about how this feature works on the frontend for your application's end users.
Important: The OpenAI AddOn is now the AI Writing Assistant AddOn with the addition of a new provider: Azure OpenAI. You can use either OpenAI or Azure OpenAI to activate the AI Writing Assistant.
What is Azure OpenAI?
Azure OpenAI is a service offered by Microsoft Azure that provides access to OpenAI's language models, such as GPT-4, integrated within the Azure ecosystem. This integration allows users to leverage the robust cloud infrastructure, security, compliance, and scalability features of Azure, making it an attractive choice for enterprises seeking a seamless and secure AI solution.
How is it different from OpenAI?
OpenAI directly offers its models through its own API, which may be more straightforward for developers and small businesses looking for a quick, standalone implementation. The primary difference between the two lies in the integration and additional features provided by Azure, such as enhanced data privacy and the ability to easily combine with other Azure services. However, Azure OpenAI may require more familiarity with the Azure platform.
How to activate the AI Writing Assistant
This section discusses the prerequisites and steps you need to take to get started with this feature. You can watch the following How to change your AI provider | Beefree SDK video for visual steps on how to activate the AddOn and add or change providers. Or, you can continue reading the documentation in this section for a step-by-step breakdown of how to activate the AddOn and add or change providers.
Prerequisites
Azure OpenAI or OpenAI account and credentials
AI Writing Assistant AddOn enabled in the developer console
Switch Providers
Take the following steps to switch providers:
Log in to the Beefree SDK Developer Console.
Navigate to the application you'd like to use.
Navigate to the application's AddOns section.
Click on the Edit button for the AI Writing Assistant AddOn .
Click Manage providers.
Click Add provider.
Complete the required information*.
Click Save.
*The following information is required for each provider.
OpenAI | Azure OpenAI |
---|---|
|
|
Manage Providers
You can also manage your existing providers within the Developer Console. By taking the same steps mentioned in the Switch Providers section and navigating to your application's AddOns, you can manage your configured providers.
When managing your providers, you will have the following options:
Edit
Deactivate
Delete
Additional considerations
Azure OpenAI and OpenAI are the only provider options for the AI Writing Assistant.
Cognitive Vision is the provider for the Alt text generation with AI feature.
Customize the AddOn's Configuration
In certain scenarios, you may find the need to personalize both the user interface (UI) and the operational features of the AI Writing Assistant AddOn. This is particularly applicable when you want to achieve objectives such as:
Monitoring Token Usage for Cost Management: By tracking the number of tokens being used, you can effectively manage and regulate your expenses related to using the AI Writing Assistant AddOn. This becomes important when your usage is high, and you must keep a budget check. Learn more about tokens.
Controlling Access to the Prompt: You might want to limit who can access and manipulate the prompt. In a shared environment, for instance, you may want to restrict certain users from altering the prompt, which is crucial for maintaining consistency and avoiding unwanted changes.
Enabling Per User or Per Content Type: You might want to limit who can access the AI so you can up-sell the feature to end-users. Or, you may only want to enable the AI capability for specific content types, such as paragraphs vs. buttons.
Disabling Automatic Suggestions: The AI Writing Assistant AddOn can generate automatic suggestions at the prompt, which may not always be desirable. In such cases, you might want to disable this feature to have more control over the input and output at the prompt.
Token Upselling: The AI Writing Assistant AddOn can be configured to guide your end users to purchase additional tokens when they run out of available tokens. This feature is called Token Upselling.
We’ll cover all of these scenarios in the following sections as we discuss the settings and configuration options available for developers.
General Settings
Note: All settings are optional and may be refreshed, in real-time, via the configuration reload instance method (e.g. bee.loadConfig(settings)
) during the active session.
Currently, the following settings are supported:
Setting | Type | Description |
---|---|---|
| number | Display only value for the optional Display Usage Widget: The total tokens available for the user to consume during the session. If provided, |
| number | Display only value for the optional Display Usage Widget: The number of tokens that the addon user has consumed during the current session. If provided, |
| string | Display only value for the optional Display Usage Widget: The API reports token usage, but the host app may refer to tokens as words or any other nomenclature that makes sense to its users. Required when providing usage limits via |
| boolean | Set to true to lock the prompt. The chat interface will be disabled but allow previous answers to be applied. |
| boolean | Set to true to hide the suggestions popup. Set this to |
| boolean | A boolean that confirms whether or not the Token Upsell feature is enabled. |
| boolean | A boolean that confirms whether or not the AI-Generated Meta Tag fields feature is enabled |
AI Writing Assistant Configuration Example
Monitor Usage
With each prompt response, the addon will report the usage data provided by Azure OpenAI or OpenAI API via the editor’s onInfo
callback without storing or tracking the data.
Display Usage Widget
You may choose to track the end-user’s total usage through the aforementioned onInfo
callback if desired. Additionally, you may choose to show the usage data to the user via the built-in display widget. To activate the display usage widget, provide the usage data via the addon settings. Since the editor doesn’t track usage, you’ll need to refresh the values via the bee.loadConfig
method to keep the display widget data current.
See below for an example of how the UI will render when provided with the optional display usage widget.
Disable Prompts Per User
To enable the AI Writing Assistant AddOn, but disable the prompt per user, pass the isPromptDisabled
boolean parameter as true
.
The following example will disable the prompts for the user with an uid
of inactive-user
.
Disable AddOn Per User
To disable the AI Writing Assistant AddOn for a particular user, use the following configuration. Ensure the enabled
parameter is set to false
. To turn the AddOn back on for a user, edit the parameter to true
.
Disable AddOn Per Content Block Type
The AI Writing Assistant AddOn is available for the following content blocks:
Title
Paragraph
List
Button
You may utilize the Advanced Permissions configuration to disable AI Writing Assistant AddOn per content type.
The following example will disable the addon for the paragraph block:
Prompt Suggestions
The AI Writing Assistant AddOn includes preset prompt suggestions to facilitate the content creation process. These appear after the initial draft of your text has been formulated and whenever further refinement is needed. Please note that this function applies only when editing existing text through the AI prompt. The suggestions will not appear for placeholder text.
Here’s a simplified step-by-step guide on how to use suggestions, as shown below:
Start with your draft text added to the design area.
If you desire to adjust the tone to be more formal, for example, click on the paragraph, list, title, or button you want to modify.
Navigate to the ‘Write with AI’ option.
Click on the area designated for adding prompts.
You’ll notice the prompt suggestions popup.
Select the ‘Make it [desired tone]’ option, making sure to replace [desired tone] with a value (e.g., funny)
Click ‘Generate’.
The AI will then generate a revised version of your content, matching the tone you entered.
Customize Prompt Suggestions
Below are the preset prompt suggestions we have identified for the different content tiles, along with their corresponding translation key, in case you’d like to revise the prompt through our custom languages feature.
Paragraph
Label | Key |
---|---|
Spell-check the content | mailup-bee-common-component-ai.suggest-check-spelling |
Correct grammar mistakes in the content | mailup-bee-common-component-ai.correct-grammar |
Translate content to [language] | mailup-bee-common-component-ai.translate |
Make it [tone] without changing the format | mailup-bee-common-component-ai.adjust-tone |
Use Active Voice | mailup-bee-common-component-ai.use-active-voice |
Summarize the content | mailup-bee-common-component-ai.summarize-text |
Convert the content to the third person without changing the format | mailup-bee-common-component-ai.convert-third-person |
Button
Label | Key |
---|---|
Translate content to [language] | mailup-bee-common-component-ai.translate |
Make it [tone] | mailup-bee-common-component-ai.make-it-tone |
Use Active Voice | mailup-bee-common-component-ai.use-active-voice |
List
Label | Key |
---|---|
Spell-check the content | mailup-bee-common-component-ai.suggest-check-spelling |
Correct grammar mistakes and return the content | mailup-bee-common-component-ai.correct-grammar-list |
Translate content to [language] | mailup-bee-common-component-ai.translate |
Make it [tone] without changing the format | mailup-bee-common-component-ai.adjust-tone |
Use Active Voice | mailup-bee-common-component-ai.use-active-voice |
Title
Label | Key |
---|---|
Capitalize all letters | mailup-bee-common-component-ai.capitalize-text |
Capitalize the first letter of each word | mailup-bee-common-component-ai.capitalize-all-words |
Make it [number] words long | mailup-bee-common-component-ai.characters-length |
Make it [tone] without changing the format | mailup-bee-common-component-ai.adjust-tone |
Translate it to [language] | mailup-bee-common-component-ai.translate-heading |
Additional considerations
Prior to configuring the AI Writing Assistant AddOn, consider the following:
Scrolling behavior
Scrolling Behavior
This section will discuss how to manage an odd scrolling behavior related to the AI Writing Assistant AddOn. At times, the AI Writing Assistant side panel opens and requires the end user to scroll down to reach the prompting area.
The following image shows an example of this behavior:
If you encounter this behavior, take the following steps to avoid the need for scrolling to access the prompting area:
Navigate to your CSS code.
Change the height of your container using the
calc()
function as shown in the following examples:
This sets the height of the element to be the full height of its parent (100%
) minus 100px
, which accounts for an offset such as a footer.
This sets the height of the element to be exactly 100%
of its parent's height with no offset.
The calc()
function allows for mathematical expressions in CSS values, making it versatile for dynamic layouts.
Save your updated CSS.
You can now access the prompting section of the AI Writing Assistant on the front end without scrolling down the side panel.
The following image shows an example of this result:
AI Providers and Data Security
Visit our AI Providers and Data Security page to learn more about the flow of your end user's information from prompt creation to generated response.
Last updated