Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Scroll export button
scopecurrent
template-id0fa09813-8b86-460a-aa1d-ef450a80e9ce
quick-starttrue
add-onScroll PDF Exporter

Info

This Guide describes how to integrate ChatGPT with Wildix. 

Created: February 2023

Permalink: https://wildix.atlassian.net/wiki/x/AQBxC

Table of Contents

Introduction

...

  • Chatbot integrated in WebRTC Kite Chatbot - you can use it a personal assistance in Collaboration/ x-bees or use it as a Kite chatbot for external users 
  • Speech To Text (STT) integration 

Related sources:

...

  1. Download the archivehttps://drive.google.com/file/d/1QM3nW0e2Wuo7FD2Gs168loOAMa8s47Dn/view?usp=share_link
  2. Open the archive, navigate to /kite-xmpp-bot-master/app and open config.js with an editor of your choice 

    Replace the following values with your own:

    • domain: 'XXXXXX.wildixin.com' - domain name of the PBX
    • service: 'xmpps://XXXXXX.wildixin.com:443', - domain name of the PBX 
    • username: 'XXXX', - Kitebot user extension number, do not change it
    • password: 'XXXXXXXXXXXX' - Kitebot user password
    • authorization: 'Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', - ChatGPT authorization token
    • organization: 'org-XXXXXXXXXXXXXXXXXXXXXXXXX', – ChatGPT organization ID
    • model: 'text-davinci-003', - this parameter specifies which GPT model to use for generating text. In this case, the model is set to 'text-davinci-003', which refers to the most advanced and powerful model available in OpenAI's GPT series of models
    • temperature: 0.1, - this parameter controls the "creativity" of the generated text by specifying how much randomness should be introduced into the model's output
    • externalmaxtokens: 250, - response token limit for Kite users contacting the chatbot
    • internalmaxtokens: 500  - response token limit for internal users contacting the chatbot
  3. Upload the archive to the /home/admin/ directory using WinSCP or any alternative SFTP client

    |
  4. Connect to the web terminal. Log in as the super user via the su command, password wildix
  5. Install nodejs: 

    Code Block
    apt-get install nodejs


  6. Unzip the archive: 

    Code Block
    unzip /home/admin/kite-xmpp-bot-master.zip 


  7. Copy the chatbot folder to /mnt/backups: 

    Code Block
    cp -r ./kite-xmpp-bot-master /mnt/backups/


  8. Move the chatbot.service.txt file to the appropriate directory and enable chatbot as a service to run in the background, then start the service: 

    Code Block
    cp /mnt/backups/kite-xmpp-bot-master/chatbot.service.txt /etc/systemd/system/chatbot.service
    systemctl enable chatbot.service 
    systemctl daemon-reload
    systemctl start chatbot.service


  9. Verify that the chatbot is running by either running the ps command:

    Code Block
    ps aux | grep node


    Or simply send the bot a message 

...

  1. Set STT & TTS language
  2. Set DIAL_OPTIONS -> g to continue Dialplan execution after the Speech to text application, this allows looping the Dialplan to potentially answer multiple questions
  3. Speech to text application that plays the voice prompt and captures the user’s response converting it to text. An in-depth guide for the Speech to Text dialplan application: https://wildix.atlassian.net/wiki/spaces/DOC/pages/30281834/Dialplan+applications+-+Admin+Guide#Dialplanapplications-AdminGuide-SpeechtoTextSTT Dialplan application: Dialplan applications Admin Guide
  4. NoOp(${RECOGNITION_RESULT}) - a debug application that shows the result of speech recognition, can be safely removed
  5. Set(RECOGNITION_RESULT=${SHELL(echo "${RECOGNITION_RESULT}" | tr -d \'):0:-1}) - this sets the RECOGNITION_RESULT variable to the value of the RECOGNITION_RESULT channel variable, with any single quotes removed. The :0:-1 substring removes the newline character
  6. ExecIf($[ "${SHELL(echo '${RECOGNITION_RESULT}' | grep -i 'price'):0:-1}"!="" ]?Set(PROMPT_ENGINEERING=Only respond with price in numerical format.)) - this checks if the RECOGNITION_RESULT variable contains the word "price" (case-insensitive), and if so, sets the PROMPT_ENGINEERING variable to the given string. This is a simple example of conditional prompt engineering that can be used with this setup
  7. Set(chatGPT=${SHELL(curl https://api.openai.com/v1/completions -H "Content-Type: application/json" -H "Authorization: Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -d '{"model": "text-davinci-003", "prompt": "${RECOGNITION_RESULT}. ${PROMPT_ENGINEERING}", "temperature": 0.5, "max_tokens": 500}'):0:-1}) - this sends an HTTP request to the OpenAI ChatGPT API to generate a response based on the RECOGNITION_RESULT and PROMPT_ENGINEERING variables. The resulting JSON string is assigned to the ChatGPT variable. text-davinci-003 is the model name, you can learn more about ChatGPT models by watching the dedicated Tech talk webinar or in the OpenAI documentation 
  8. Set(PrettyChatGPT=${JSONPRETTY(chatGPT)}) - this formats the ChatGPT variable as pretty-printed JSON and assigns the result to the PrettyChatGPT variable
  9. Set(result=${SHELL(echo "${PrettyChatGPT}" | grep -oP '(?<=nn).*'):0:-2}) -this extracts the response text from the PrettyChatGPT variable by using grep to search for the text following the nn field in the JSON output
  10. Play sound -> ${result}. End of response. - this uses the text in the result variable to generate text to speech message and play back the response from chatGPT API to the caller, appending “End of response” to mark the end of response, which is something you can change to your preference

...