In this blog post we will incorporate ChatGPT functionality into ONLYOFFICE macro

AI technology has significantly improved over several years and become an essential part of our daily lives. Today we will incorporate this high-tech functionality into our document writing routine. In this blog post, we will show you how to build a macro that will generate an entire essay with ChatGPT API.

<img decoding="async" loading="lazy" class="aligncenter wp-image-54458" src="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro.png" alt="Use ONLYOFFICE macro to generate an essay with ChatGPT" width="736" height="371" srcset="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro.png 1472w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro-300x151.png 300w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro-1024x516.png 1024w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro-768x387.png 768w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro-634x320.png 634w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/Illustration_blog_chatGpt_essay_macro-353x178.png 353w" sizes="(max-width: 736px) 100vw, 736px" />
<h2>About ChatGPT</h2>
ChatGPT is an innovative AI chatbot developed by OpenAI that can converse naturally. Its dialogue design allows it to respond to follow-up questions, recognize its errors, generate text, and dispute incorrect statements. The model is trained to follow the instruction in a prompt and provide a detailed response.
OpenAI provides a free trial API that facilitates integrating into various applications. For convenience purposes, we will get access to OpenAI API through the RapidAPI platform. To connect to the  OpenAI API directly, visit the official <a href="https://platform.openai.com/docs/api-reference/introduction" target="_blank" rel="noopener">documentation page</a>.
<h2>About RapidAPI</h2>
RapidAPI is a comprehensive platform for developers to discover, connect to, and manage APIs. It contains a directory of over 10,000 APIs, including popular ones like Google Maps, Twilio, Stripe, and YouTube. Users can search for APIs, try out free trials, and subscribe to APIs and services. RapidAPI also offers a dashboard to monitor API subscriptions, usage, and performance, as well as access support. Additionally, RapidAPI enables developers to create their APIs and monetize them.
<h2>Forming the API request</h2>
In our project, we incorporated the <a href="https://rapidapi.com/florianbreut/api/you-chat-gpt" target="_blank" rel="noopener">You Chat GPT</a> API by FB/florianbreut. Currently, it’s offers a freemium plan that starts with a basic package of 100 requests a month. It will be sufficient to test our macro.
The interface of the RapidAPI platform generates request code snippets in various languages. In our case choices will be JavaScriot and a fetch function:
<img decoding="async" loading="lazy" class="img-popup aligncenter wp-image-54266 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPILanguage-1.png" alt="Use ONLYOFFICE macro to generate an essay with ChatGPT" width="730" height="331" srcset="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPILanguage-1.png 730w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPILanguage-1-300x136.png 300w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPILanguage-1-353x160.png 353w" sizes="(max-width: 730px) 100vw, 730px" />
Also, we can tweak the request parameters. In particular, we can change the request body. The API offers 4 request options, depending on the OpenAI model:
<ol>
<li>Write Code</li>
<li>Explain Anything</li>
<li>Time Response Constraint</li>
<li>Formatted Answer</li>
</ol>
The Formatted Answer option is perfectly suited for essay generation. So we pick it and change the max_response_time parameter to 20 seconds. This will give the OpenAI more time to generate the answer:
<img decoding="async" loading="lazy" class="img-popup aligncenter wp-image-54252" src="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPIRequestBody.png" alt="Use ONLYOFFICE macro to generate an essay with ChatGPT" width="736" height="364" srcset="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPIRequestBody.png 728w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPIRequestBody-300x148.png 300w, https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/RapidAPIRequestBody-353x175.png 353w" sizes="(max-width: 736px) 100vw, 736px" />
<h2>Building the macro</h2>
Now let’s incorporate this fetch request into our macro!
First, we create a global variable that will store the response:
<pre class="theme:github font:monospace lang:js decode:true">let essay;
</pre>
Then we add the request options and set the topic of the essay by changing the question parameter in the request body:
<pre class="theme:github font:monospace lang:js decode:true ">const options = {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'X-RapidAPI-Key': '&lt;yourRapidAPIkey&gt;',
    'X-RapidAPI-Host': 'you-chat-gpt.p.rapidapi.com'
  },
  body: '{"question":"write an essay on the benefits of using ONLYOFFICE products","max_response_time":20}'
};
</pre>
After that, we define the insertEssay function. This function contains ONLYOFFICE API methods that insert the generated essay into the document.
First, we target the active document and create a paragraph where the text will be added:
<pre class="theme:github lang:js decode:true">function insertEssay() {
  const oDocument = Api.GetDocument();
 const oParagraph = Api.CreateParagraph();
  
}
</pre>
Then we add the generated essay to the paragraph and insert it with the <a href="https://api.onlyoffice.com/docbuilder/textdocumentapi/apidocument/insertcontent" target="_blank" rel="noopener">InsertContent </a>method.  We also pass in the &#8220;KeepTextOnly” parameter to prevent any possible formatting issues:
<pre class="theme:github font:monospace lang:js decode:true"> function insertEssay() {
  const oDocument = Api.GetDocument();
 const oParagraph = Api.CreateParagraph();
 oParagraph.AddText(essay);
  oDocument.InsertContent([oParagraph], { "KeepTextOnly": true })
  
</pre>
We also incorporate the handleFetchResponse function. It extracts the answer from the response and fires the insertEssay function to insert it into the document:
<pre class="theme:github font:monospace lang:js decode:true ">function handleFetchResponse(response) {
  return response.json().then(json =&gt; {
    essay = json.answer;
    insertEssay();
  });
}
</pre>
And we make a fetch request to the server:
<pre class="theme:github font:monospace lang:js decode:true ">fetch('https://you-chat-gpt.p.rapidapi.com/', options)
  .then(handleFetchResponse);

</pre>
The entire macro code is the following:
<pre class="theme:github font:monospace lang:js decode:true">(function()
{ 
let essay;
const options = {
 method: 'POST',
 headers: {
 'content-type': 'application/json',
 'X-RapidAPI-Key': '&lt;yourRapidAPIkey&gt;',
 'X-RapidAPI-Host': 'you-chat-gpt.p.rapidapi.com'
 },
 body: '{"question":"write an essay on the benefits of using ONLYOFFICE products","max_response_time":20}'
};

function insertEssay() {
 const oDocument = Api.GetDocument();
 const oParagraph = Api.CreateParagraph();
 oParagraph.AddText(essay);
 oDocument.InsertContent([oParagraph], { "KeepTextOnly": true });
}

function handleFetchResponse(response) {
 return response.json().then(json =&gt; {
 essay = json.answer;
 insertEssay();
 });
}

fetch('https://you-chat-gpt.p.rapidapi.com/', options)
 .then(handleFetchResponse);
})();</pre>
Now let’s run our macro and see how it works!
<div style="width: 640px;" class="wp-video">
<video class="wp-video-shortcode" id="video-54180-1" width="640" height="310" preload="metadata" controls="controls"><source type="video/webm" src="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/version2.webm?_=1" /><a href="https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/version2.webm">https://static-blog.onlyoffice.com/wp-content/uploads/2023/02/version2.webm</a></video></div>
Note!
<ul>
<li>This macro is only operational in the online version of the editors.</li>
<li>To get 100 free requests, subscribe to <a href="https://rapidapi.com/florianbreut/api/you-chat-gpt" target="_blank" rel="noopener">You Chat GPT</a> API and use your RapidAPI key.</li>
<li>It takes approximately 30 seconds to process the request before inserting it into the document.</li>
<li>Press the space to insert the text.</li>
</ul>
We hope that this macro will bring new fascinating AI technologies into your workflow and alleviate tedious routine tasks. We urge developers to take advantage of the possibilities that our API methods offer and build their macros. Our macros are written in JavaScript, making them highly functional and adaptive.
If you have any inquiries or suggestions, please don&#8217;t hesitate to reach out. We are open to hearing your ideas and are eager to collaborate with you. Best of luck in your exploratory endeavors!
<div class="useful-links">
<h3>Useful links</h3>
<a href="https://api.onlyoffice.com/docbuilder/textdocumentapi" target="_blank" rel="noopener">ONLYOFFICE text document API</a>
<a href="https://rapidapi.com/florianbreut/api/you-chat-gpt" target="_blank" rel="noopener">You Chat GPT API </a>
<a href="https://platform.openai.com/docs/api-reference/introduction" target="_blank" rel="noopener">OpenAI API documentation page</a>
<a href="https://wpblog.onlyoffice.com/2022/09/monitor-air-quality-data-with-onlyoffice-macro/?utm_source=blog&#038;utm_medium=article+&#038;utm_id=chatgpt_document_macro" target="_blank" rel="noopener">Another case of using RapidAPI with ONLYOFFICE macros</a>
<a href="https://wpblog.onlyoffice.com//2023/02/chatgpt-plugin-in-onlyoffice-docs/?utm_source=blog&amp;utm_medium=article+&amp;utm_id=chatgpt_document_macro" target="_blank" rel="noopener">Introducing the ChatGPT plugin in ONLYOFFICE Docs</a>
</div>
&nbsp;

Use ONLYOFFICE macro to generate an essay with ChatGPT

Recent posts

Use ONLYOFFICE macro to analyze spreadsheet data

Back to school 2023 with ONLYOFFICE: discounts for education

Best AI writers 2023