Thursday, September 12, 2024

the ONLYOFFICE Docs case examine

Must read


With synthetic intelligence taking deep roots round our lives and making it simpler for us to do a number of issues, an increasing number of software program builders, IT corporations and start-ups are on the lookout for methods to combine state-of-the-art AI expertise into their merchandise to get the leap over their opponents.

Many fashionable CRM platforms, e-mail purchasers, private assistants, video editors, venture administration applications and other forms of software program instruments now come geared up with AI assistants permitting their customers to work quicker and be extra productive.

Workplace software program isn’t an exception. The thought of integrating synthetic intelligence into digital doc workflows has been successful the minds of workplace software program builders over the previous couple of years and now there are a number of fascinating integration examples that considerably change the best way individuals work with workplace information.

On this article, we are going to check out essentially the most profitable examples of symbiosis between synthetic intelligence and workplace software program, and look at the method of integrating an AI assistant into an workplace package deal by means of the instance of ONLYOFFICE Docs, an open-source workplace suite.

AI and workplace software program: greatest integration examples

The market of workplace software program is extremely aggressive, and it’s an evident incontrovertible fact that the most important companies at all times have a bonus over different gamers. Nonetheless, even small corporations and impartial builders can provide you with elegant options bringing the facility of synthetic intelligence into the universe of doc modifying and collaboration. 

Here’s a fast overview of a few of the hottest workplace packages with built-in AI assistants out there available on the market:

  • Microsoft 365. The Redmond big introduced its personal AI software often called Copilot in March 2023. It combines the facility of huge language fashions (LLMs) and makes it simpler for customers to work with the Microsoft 365 apps, together with Groups, Outlook and Edge. Copilot is deeply built-in into the Microsoft ecosystem and permits you to write and edit textual content content material in Phrase, analyze traits and create complete information visualizations in Excel, and create spectacular shows based mostly in your prompts in PowerPoint. Copilot for Microsoft 365 is out there with a paid subscription.
  • WPS Workplace. Microsoft Workplace’s competitor from China, WPS Workplace, has an AI assistant known as WPS AI. It’s a generative AI software that permits customers to generate textual content content material, summarize giant paperwork, analyze information, extract outlines from PDFs and create assembly drafts. WPS AI can be utilized in textual content paperwork and PDF information and affords a free trial with a restricted set of options. To entry its full performance, you have to buy one of many paid variations.
  • Google Workspace. The Google company has an AI-powered assistant for its productiveness apps known as Gemini. This software is constructed into Docs, Sheets and Slides permitting you to put in writing numerous sorts of content material and generate photographs in textual content paperwork, create tables and formulation in spreadsheets, and generate new slides with photographs and content material in shows. Gemini for Google Workspace is out there as a paid add-on. Apparently, the Google Workspace Market additionally affords completely different AI assistants developed by third-party builders for Docs, Sheets and Slides however it is best to strive them at your individual threat.
  • Zoho WorkDrive. This on-line content material collaboration platform and storage has an IA integration characteristic known as Zia. It’s an AI-based writing assistant out there in some Zoho merchandise, together with Zoho Author. Utilizing Zia, you possibly can examine your content material for spelling and grammar errors and enhance its readability. The principle goal of this software is that will help you write concisely and clearly. Zia can also generate new content material and pictures. It’s not out there without spending a dime.

Taking every little thing into consideration, the next conclusion appears evident: the most well-liked workplace suites present glorious AI integration choices however nearly all of them are paid.

Now let’s discover the case of ONLYOFFICE Docs, an open-source workplace package deal, that gives sturdy AI capabilities based mostly on ChatGPT and uncover how this integration works.

ONLYOFFICE Docs and AI: a quick overview

ONLYOFFICE Docs is an open-source and free workplace suite for textual content paperwork, spreadsheets, shows, fillable varieties and PDF information. The suite has a self-hosted model for native deployment and a cloud-based model for a fast begin. There’s additionally a desktop consumer for Linux, Home windows and macOS and cell apps for Android and iOS. The supply code of the ONLYOFFICE suite is out there on GitHub.

ONLYOFFICE Docs has an open API, which makes it attainable to combine the editors with third-party companies. Such integrations work by way of plugins, particular add-ons that convey new capabilities and options. Amongst dozens of ready-to-use plugins for the ONLYOFFICE suite, you could find those who allow the facility of synthetic intelligence. Extra exactly, these are the plugins for ChatGPT and Zhipu Copilot. 

ChatGPT menu in ONLYOFFICE Docs

Each ChatGPT and Zhipu Copilot are accessible within the ONLYOFFICE editor’s interface by way of separate plugins that may be put in and deleted with just a few clicks by way of the Plugin Supervisor. These plugins are formally developed and maintained by the ONLYOFFICE workforce. As all different plugins, they’re out there without spending a dime.

ChatGPT plugin within the ONLYOFFICE Plugin Supervisor

To make these plugins work, you have to specify an API key supplied by the corresponding platform. Relating to ChatGPT, you could find a sound API key within the settings of your OpenAI account. 

API keys part within the settings of an OpenAI account

Whenever you enter a sound API key within the ChatGPT plugin and allow it by way of the Plugins tab, you’ll have entry to the next options by way of the context menu, which makes it simpler to work with texts*:

  • Technology of textual content content material based mostly in your prompts;
  • Creation of photographs in numerous resolutions;
  • Translation to a number of languages, together with English, Spanish, Italian, Chinese language, German, French, and many others.;
  • Phrase evaluation;
  • Extraction of key phrases;
  • Textual content summarization;
  • Textual content manipulation;
  • Correction of spelling and grammar errors;
  • Communication with the chatbot.

The Zhipu Copilot plugin supplies related writing help options in ONLYOFFICE Docs and is designed for Chinese language-speaking customers as a result of it’s based mostly on a localized data base.

In ONLYOFFICE Docs, you possibly can work together with the ChatGPT service not solely in textual content paperwork but additionally in spreadsheets and shows, so you possibly can carry out numerous duties reminiscent of information evaluation and discovering info in your slides.

Now that you understand what ChatGPT and Zhipu copilot can do for you whenever you work on workplace information, let’s take a deeper have a look at the ChatGPT plugin to see the way it works and what key components its supply code contains.

Word: the ONLYOFFICE builders assume no accountability for the accuracy or reliability of the knowledge supplied by ChatGPT and ZhiPu Copilot.

Construction of the ChatGPT plugin

The ChatGPT plugin consists of 5 directories, with the HTML information saved individually within the root listing. Here’s a fast overview of every file with code samples:

1. index.html: For the reason that plugin operates as a background plugin, it doesn’t require a person interface. The index.html file references all of the scripts, code information, and stylesheets, guaranteeing they’re utilized when the plugin is activated.

<head>

<meta charset="UTF-8" />

<title>OpenAI</title>

<script sort="textual content/javascript" src="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.js"></script>

<script sort="textual content/javascript" src="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins-ui.js"></script>

<hyperlink rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">

<script sort="textual content/javascript" src="https://www.sitepoint.com/artificial-intelligence-into-office-software-with-onlyoffice-docs/scripts/desktop.js"></script>

<script sort="textual content/javascript">

if (!/MSIE d|Trident.*rv:/.check(navigator.userAgent)) {

doc.write("<script sort="textual content/javascript" src="https://www.sitepoint.com/artificial-intelligence-into-office-software-with-onlyoffice-docs/vendor/GPT-3-Encoder/encoder.js"></script>");

doc.write("<script sort="textual content/javascript" src="https://www.sitepoint.com/artificial-intelligence-into-office-software-with-onlyoffice-docs/scripts/code.js"></script>");

} else {

doc.write("<script sort="textual content/javascript" src="https://www.sitepoint.com/artificial-intelligence-into-office-software-with-onlyoffice-docs/scripts/code_ie.js"></script>");

}

</script>

</head>

Code contained in the <head> tag of index.html file

2. chat.html: This file defines the HTML construction for the chatbox that seems when you choose the chat possibility within the ChatGPT plugin.

3. Different HTML information: The basis listing comprises extra HTML information for numerous error messages and logs. These information are designed to deal with circumstances reminiscent of inadequate tokens or invalid requests, to verify the plugin responds appropriately to completely different situations.

Overview of the assets listing

The assets listing primarily contains two parts: CSS kinds and pictures for various modes.

1. CSS Sub-directory: This comprises kinds.css and customized.css. Each stylesheets apply CSS to varied parts all through the plugin.

2. Picture Directories: The second part contains the next:

  • gentle comprises photographs optimized for light-themed editors;
  • darkish comprises photographs optimized for dark-themed editors;
  • icons contains icons in numerous side ratios and sizes for various show settings and themes.

These above-mentioned assets make sure that the ChatGPT plugin features nicely throughout completely different editor themes and resolutions.

Overview of the scripts listing

The code.js file comprises the core logic for the plugin that integrates numerous functionalities powered by the OpenAI API. Let’s undergo this file in additional element:

1. Initialization and Setup:

  • The plugin initializes variables, together with an API key, mannequin settings, and UI components.
  • The checkApiKey technique retrieves the OpenAI API key from native storage.
perform checkApiKey() {

ApiKey = localStorage.getItem('OpenAIApiKey') || '';

if (!ApiKey.size) {

bHasKey = false;

} else {

bHasKey = true;

}

};

A code snippet from checkApiKey() technique

2. Context Menu Technology:

  • The getContextMenuItems() technique dynamically generates context menu objects based mostly on the kind of choice within the doc (e.g., textual content choice, photographs, shapes, hyperlinks, and many others.).
  • If the API secret is current, extra choices like spelling and grammar correction, textual content rewriting, translation, and picture technology are added to the context menu of the plugin.
  • This technique additionally features a logic to examine for the presence of photographs within the doc and an possibility for producing picture variations.
perform getContextMenuItems(choices) {

hyperlink = null;

checkApiKey();

let settings = {

guid: window.Asc.plugin.guid,

objects: [

{

id : 'ChatGPT',

text : generateText('ChatGPT'),

items : [] 

}

]

};

A code snippet from getContextMenuItems() technique

3. Occasion Dealing with:

  • The plugin attaches occasion handlers for context menu actions. For instance, the onContextMenuShow() occasion triggers the show of the customized context menu and performs extra checks, reminiscent of retrieving the present phrase.
  • The onSettings() occasion handler opens a settings modal dialogue when the settings menu merchandise is clicked, and extra.

4. Utility Strategies:

  • Helper strategies like generateText() for textual content translation, showError() for error show, and isEmpyText() for textual content validation are included within the code.js file as nicely.
  • The createSettings() technique creates a UI container displaying token info and a settings button.
perform createSettings(textual content, tokens, sort, isNoBlockedAction) {

let url;

let settings = {

mannequin : mannequin,

max_tokens : maxLen - tokens.size

};

if (settings.max_tokens < 100) {

console.error(new Error('This request is simply too massive!'));

return;

}

A code snippet from createSettings() technique

The following file is chat.js. It manages the logic for the chatbox, which may be initialized by right-clicking anyplace within the doc. It really works together with the chat.html file to make sure the chatbox’s construction and performance are applied accurately.

perform createMessage(textual content, sort) {

let chat = doc.getElementById('chat');

let message = sort ? doc.createElement('div') : doc.getElementById('loading');

let textMes = doc.createElement('span');

textMes.classList.add('form-control', 'span_message');

textMes.innerText = textual content;

chat.scrollTop = chat.scrollHeight;

if (sort) {

message.classList.add('user_message');

chat.appendChild(message);

sendMessage(textual content);

} else {

message.id = '';

message.innerText="";

}

message.appendChild(textMes);

};

Code snippet of the createMessage() technique from the chat.js file

Now just a few phrases in regards to the settings.js file. It manages the settings part of the plugin. That is the place customers enter their API keys. This file additionally validates the API key entered by the person.

perform createError(error) ;

perform createLoader() {

if (!window.Asc.plugin.theme)

window.Asc.plugin.theme = {sort: 'gentle'};

$('#loader-container').removeClass( "hidden" );

loader && (loader.take away ? loader.take away() : $('#loader-container')[0].removeChild(loader));

loader = showLoader($('#loader-container')[0], loadMessage);

};

Code snippets of createError() and createLoader() strategies from the settings.js file

There are additionally another .js information within the scripts listing that primarily embody JavaScript for error prompts (as talked about earlier within the HTML part). Moreover, some information comprise JavaScript triggers for various environments the place the plugin is likely to be used (desktop model, cloud model, and many others.).

Translations listing

This listing comprises translation information for various languages, every represented by a .json file. Utilizing the onTranslate() technique, the plugin checks this listing, identifies the file similar to the system’s language and retrieves the mandatory translated textual content.

This mechanism ensures that the plugin can dynamically adapt to varied languages, offering a localized and user-friendly expertise.

File construction within the translations listing

The seller and the licenses listing

The seller listing homes the code and useful resource information for the third-party libraries used within the plugin. This listing ensures that each one exterior dependencies are neatly organized and simply accessible. 

File structure in the vendor and the licenses directory
File construction within the vendor and the licenses listing

This listing has three parts:

1. OpenAI (Chat GPT BPE Encoder Scripts): these scripts are important for encoding and decoding the textual content returned by the GPT engine.

2. Select2 Library Scripts: this can be a highly effective library that enhances the plugin’s person interface by offering customizable choose containers, making the plugin simpler to make use of.

3. jQuery Base File: jQuery simplifies HTML doc traversal and manipulation, occasion dealing with, and animation, making the UI extra dynamic and responsive.

This was an in depth overview of the ChatGPT plugin created by the ONLYOFFICE builders for his or her workplace suite. If you wish to discover the plugin’s code intimately and the strategies it makes use of, you possibly can take a loot at this GitHub web page.

Utilizing the identical rules and the ONLYOFFICE API, you possibly can construct a plugin for some other AI-based writing assistant and use its capabilities throughout the interface of an workplace suite. 



Supply hyperlink

More articles

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Latest article