OpenAI Alert! Plug Sample #11 - Next-generation chatbots, Zobot + ChatGPT Assistant

Hi Everyone!

We have great news for all AI enthusiasts and ChatGPT users! The much anticipated Zobot integration with ChatGPT Assistant is now available with Plugs.

OpenAI has introduced 'ChatGPT Assistants' to customize GPT models as per your requirement. These Assistants work based on your data, instruction, files, functions and more, making it more susceptible to your needs. With Assistant, your SalesIQ bot can be more powereful than ever, providing contextual assistance to your audience with data specifically exclusive for your business.

Please ensure to have a ChatGPT Assistant in your OpenAI Platform to use this Plug.

Here's what the SalesIQ chatbot-Assistant brings to the table:

Targeted Responses: Your bot will be entirely specific to your business, ensuring a tailored experience for your audience, rather than relying on global data.
Omnichannel Availability: Bot works across all channels, including your mobile app, Website, Facebook, Instagram, WhatsApp, Telegram, and LINE.
Human-like conversations: Engage your audience with natural, engaging interactions that feel human.
Always-on availability: Provide 24/7 customer support with your bot, ready to engage with users anytime.

In this post, we will learn how to create a plug and connect your trained ChatGPT Assistant with your bot.

Are you new to SalesIQ? Click here to know about SalesIQ's chatbots and plugs.

Plug Overview

The ChatGPT Assistant functions based on threads. Initially, you create a thread, add a message to it, and run the message to receive the Assistant's response. So, to integrate ChatGPT Assistant with the Codeless bot builder, we need two plugs.

Plug 1 - To create a thread (thread ID) using OpenAI API keys.
Plug 2 - To add a message to the thread using the thread ID, create a run and get the ChatGPT assistance's response.

Help guide to know more about how ChatGPT assistant works

How to build this Plug?

Step 1 - [Plug 1] Creating a thread for the visitor/user

On your SalesIQ dashboard, navigate to Settings > Developers > Plugs > click on Add.
Provide your plug a name, and description, and select the Platform as SalesIQ Scripts. Here, we call this plug as ChatGPTAssistantsCreateThread.
The first step in building the plug is defining the parameters. This plug aims to create a thread and get the thread ID as output. So, only the output parameter (threadID) is needed here.

Copy the code below and paste it into your plug builder. Then, make the following changes.

In line #2, replace your api_key (Navigate to the OpenAI developer section and click on API keys to create a new one)

//ChatGPT api key
api_key = "paste-your-api_key";
//Header parameters
headers = Map();
headers.put("Authorization","Bearer " + api_key);
headers.put("Content-Type","application/json");
headers.put("OpenAI-Beta","assistants=v2");
//This param is needed to use the V2 assistant apis
// The following webhook will create a thread and return the thread id
response = invokeurl
[
url :"https://api.openai.com/v1/threads"
type :POST
headers:headers
];
response_json = response.toMap();
thread_id = response_json.get("id");
response.put("threadID",thread_id);
return response;

Then, click Save, preview the plug and Publish it.

Reference: OpenAI's Create a thread API

Step 2 - [Plug 2] Add a message to thread and get response

From the previous plug, we will get the thread ID as output.
Create a new plug, here we call this plug as ChatGPTAssistantsCreateRuns.
Pass the thread ID and the user/visitor input as input parameters.
Once the plug is executed, we will get the ChatGPT Assistance's response, which is the output parameter.

Input Parameters

Name: threadID | Type: String
Name: userInput | Type: String

Output Parameters

Name: assistantReply | Type: String

Copy the code below and paste it into your plug builder. Then, make the following changes.

In line #2, replace your api_key (Navigate to the OpenAI developer section and click on API keys to create a new one.)
In line #3, replace your chatGPT_assistant_id (Navigate to the OpenAI developer scetion > Assistants > choose your Assistant and copy the Assistance ID.

//ChatGPT api key
api_key = "paste-your-api_key";
chatGPT_assistant_id = "asst_4DuWZxC0RNagq0b8pnml4ZPf";
//Header parameters
headers = Map();
headers.put("Authorization","Bearer " + api_key);
headers.put("Content-Type","application/json");
headers.put("OpenAI-Beta","assistants=v2");
//Get the thread ID from the plug input parameters
thread_id = session.get("threadID").get("value");
user_input = session.get("userInput").get("value");
info thread_id;
info user_input;
// Messages API call
requestBody = Map();
requestBody.put("role","user");
requestBody.put("content",user_input);
jsonRequestBody = requestBody.toString();
// The following webhook posts a message to the conversation thread
response = invokeurl
[
url :"https://api.openai.com/v1/threads/" + thread_id + "/messages"
type :POST
parameters:jsonRequestBody
headers:headers
];
info response;
// Runs API call
requestBody = Map();
requestBody.put("assistant_id",chatGPT_assistant_id);
jsonRequestBody = requestBody.toString();
// The following runs the thread which inturn generates a response once the thread is completed
response = invokeurl
[
url :"https://api.openai.com/v1/threads/" + thread_id + "/runs"
type :POST
parameters:jsonRequestBody
headers:headers
];
response_json = response.toMap();
run_id = response_json.get("id");
run_status = "queued";
retry_count = {1,2,3,4,5};
for each retry in retry_count
{
if(run_status != "completed")
{
// The above executed run takes few seconds to complete. Hence a considerable time has to be left before the run is completed and the messages are fetched from the thread can be fetched. Here we wait for 3 seconds assuming the run gets complete within 3 seconds
getUrl("https://httpstat.us/200?sleep=3000");
response = invokeurl
[
url :"https://api.openai.com/v1/threads/" + thread_id + "/runs/" + run_id
type :GET
headers:headers
];
response_json = response.toMap();
run_status = response_json.get("status");
}
}
// The following webhook fetches the messages from the thread
getmsg_url = "https://api.openai.com/v1/threads/" + thread_id + "/messages";
response = invokeurl
[
url :getmsg_url
type :GET
headers:headers
];
info response;
response_json = response.toMap();
// Getting the last message from the thread messages list which is the assistant response for the user input.
assistant_response = response_json.get("data").get("0").get("content").get("0").get("text").get("value");
info assistant_response;
response = Map();
response.put("assistantReply",assistant_response);
return response;

Then, click Save, preview the plug and Publish it.

Reference: OpenAI's Create message API, Create run API, Retrieve thread API, List messages API

Step 3 - Adding plugs to the Codeless bot builder

Navigate to Settings > Bot > Add, provide the necessary information, and select Codeless Bot as the bot platform. You can also open an existing bot.
Next, click on Plugs under Action cards, select the first plug (ChatGPTAssistantsCreateThread), and provide a name to save the output (thread_id).

Use the visitor fields card, click save in bot context, and provide a name to store the visit
Then, select Plug 2 (ChatGPTAssistantsCreateRuns) and pass the value for the parameters

thread_id (Input) - The output of the previous Plug
user_input (Input) - The visitor's question/input from visitor fields card.
assistant_reply (Output) - The final response from the ChatGPT assistance.

Finally, use any response/input card to display the response to the visitor by typing the % to get the context variable (%assistant_reply%) in the message text box. Here, the button card is used along with the follow-up actions.

Note:

The ChatGPT Assistant APIs are still in beta, so it's better to have a fallback flow in the bot until they are stable.
Manage the plug failure instances within the plug failure leg by directing your users to operators using the "Forward to Operator" card or use the "Busy response" card to get the user's question, put them on the missed chats. Additionally, you can also "Send Email" card to notify yourself about the user's inquiry.

The buttons, "I've another question", is used to get next question from the visitor. Use a Go To card and route it to visitor fields card to ask next question.

Related links:

I hope this was helpful. Please feel free to comment if you have any questions. I'll be happy to help you.

Best regards

Sasidar Thandapani

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Sticky Posts
Qualify Potential Leads Automatically with SalesIQ Chatbots
Your website may have a lot of visitors every day, but are you struggling to identify your potential leads? You may not know who your ideal leads are just by looking at a website visitor, right? To qualify a lead, you need to know their needs, interests,
OpenAI Alert! Plug Sample #11 - Next-generation chatbots, Zobot + ChatGPT Assistant
Hi Everyone! We have great news for all AI enthusiasts and ChatGPT users! The much anticipated Zobot integration with ChatGPT Assistant is now available with Plugs. OpenAI has introduced 'ChatGPT Assistants' to customize GPT models as per your requirement.
Get live insights on business performance with the SalesIQ TV App - Now available for Apple and Android TVs!
Hello everyone! Let's start with a question - What do you think is the key to a thriving business? Yes, I hear you. It's all about the customers. Success in business often starts with understanding customer needs. But wouldn't you agree that achieving
Deprecation of Google Drive and Sheets connections in Scripts (Deluge)
Hello Everyone, We have an important update for those using the Script (Deluge) platform to build chatbots, widgets, and forms. Google has alerted us about sensitive scopes within the Google Drive and Google Sheets default connections in Deluge. As a
Plug Sample #10 - Simplify Ticket Management (Zoho Desk) with Chatbots
Hi everyone! We're here with another simple yet effective plug for your chatbot to integrate with Zoho Desk. When a customer reports an issue/request during chat, it's logged as a ticket on Desk. When they return for updates, you end up searching through