With this extension you won't need to pay anything to third party except OpenAI for contextual search based on your personal data.
You can see ChatGPT chat running on https://doc.livehelperchat.com/ it can answer questions only related to Live Helper Chat documentation.
How it works?
- Account at https://platform.openai.com is created
- Background worker is used https://github.com/LiveHelperChat/lhc-php-resque
- Vector store is created and attached to assistant
- To vector store files from https://github.com/LiveHelperChat/doc were uploaded
- Added support for empty first visitor message on chat start. Rest API call now uses
{not_emtpy_*
feature. - Meta data for a Run is stored within chat, because there can be no message during run. E.g first run on chat start
- Because of this chat
Bot
andRest API
calls were modified.
- Because of this chat
Required version since this - https://github.com/LiveHelperChat/livehelperchat/commit/5b2f0b25404dfe8bf56a15d5031086de3622c496
Updates
- Multiple tools call support.
ScheduleRun
Rest API call will use"parallel_tool_calls": false,
argument - Bot now has example how to have multiple tools calls with arguments
Make sure you have most recent Rest API and Bot versions also version with this commit https://github.com/LiveHelperChat/livehelperchat/commit/6e9ecaa573902adc082204799fec98f7796d81d9
Initial release
- Min 4.51v Live Helper Chat version.
- At the moment Polling workflow is supported only.
- Account at https://platform.openai.com/docs/overview
System configuration -> Live Help Configuration -> Chat configuration -> Misc
Make sure you unheckReopen chat functionality enabled
andAllow user to reopen closed chats?
. This is required because if chat is reopened we can be in the middle of previous task.
- Install https://github.com/LiveHelperChat/lhc-php-resque
- Modify Bot triggers and where you see
Rest APi
call response checkSend Rest API Call in the background if we are not already in it
.
After clone or download put it under
extension/chatgpt
- don't forget to lowercase a folder
Activate extension in main settings file lhc_web/settings/settings.ini.php
extension section chatgpt by Adding lines:
'extensions' => array ( 'chatgpt' ),
Execute queries from
doc/install.sql
Or execute command
php cron.php -s site_admin -e chatgpt -c cron/update_structure
Navigate to back office and click clear cache
Under left Modules you will find ChatGPT
click it.
- Click
ChatGPT Bot integration settings
- Now just paste
Project API Key
andAssistant ID
from https://platform.openai.com and clickCreate/Update Rest API/Bot
Now you can just assign newly created bot to your department or modify bot to the way you want.
In a ScheduleRun
Rest API call you can have something like {is_empty__args.chat.chat_variables_array.is_logged}
which checks that chat variable is set.
{
"assistant_id": "asst_UAJYImd9WyXlRGNOa0bcTAgD",
"parallel_tool_calls": false
{is_empty__args.chat.chat_variables_array.is_logged}
,"tools":[]
, "additional_instructions":"Visitor is not logged in and functions calls are not enable to him. You can answer questions only from documentation. Ask him to login to get personal account information. You can get personal information once visitor is logged in."
{/is_empty}
{not_empty__msg_url},"additional_messages" : [{"role" : "user", "content" : {{msg_url}} }]{/not_empty}
}
- Click
ChatGPT Setting for answers suggesting
Project API Key
andAssistant ID
can be different than Bot- Fer reply predictions to work you have to activate bot from
Setup as a bot
step. We use some of the Rest API calls.
Have only Enable reply prediction tab in chat UI
checked.
Have Automatically suggest answers based on visitor messages
Video tutorial and use case - https://youtu.be/X9W99obVj8Q
Please refer to this manual https://doc.livehelperchat.com/docs/bot/chatgpt-integration
Phone number can be evening and morning as an example.
Chat GPT function definition
{
"name": "post-update-phone-number",
"description": "Updates the phone number for a player.",
"strict": true,
"parameters": {
"type": "object",
"required": [
"phone",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of phone number (e.g., 'morning','evening').",
"enum": [
"evening_phone",
"morning_phone"
]
},
"phone": {
"type": "string",
"description": "The new phone number to be updated."
}
},
"additionalProperties": false
}
}
Live Helper Chat
Chat GPT function definition
{
"name": "get_withdrawals",
"description": "Retrieves a list of withdrawals for a visitor.",
"strict": true,
"parameters": {
"type": "object",
"required": [],
"properties": {},
"additionalProperties": false
}
}
Live Helper Chat side. You can also as visitor can ask to return only last 3 items.