Changes

• add vector column using pgvector gem
• nearest neighbour search using neighbour gem : https://github.com/ankane/neighbor
• add service to generate, store and search support article embeddings

TODO

• Pass context to GPT for article suggestions in Chat

Setting up the POC

• Ensure support for vector extension in your postgres installation: ref: https://github.com/pgvector/pgvector
• Run migrations in the branch and create appropriate tables
• Enable OpenAI integration Hook in Chatwoot
• Load some support articles using the following script or any custom method

  • ## Sample FAQs Generated by GPT
    faqs = [
      { title: "502 bad gateway in nginx server", 
        content: "This issue may arise when trying to install Chatwoot from scratch using Linux in Digital Ocean. The same repository in git and a change in the line that on \"install.sh\" could potentially solve the issue."
      },
      { title: "Configure Litespeed to serve as a frontend proxy for chatwoot or any docker",
        content: "When docker chatwoot is fully activated, there might be a need to convert Litespeed (as part of a Cpanel installation) to a frontend proxy. This requires specific settings to be configured."
      },
      { title: "Error with deploy Chatwoot in Heroku: Free dynos are no longer available", 
        content: "This error might appear even when subscribed to an Eco subscription. It suggests an error in scaling dynos, and might require subscribing to Eco to get the application up and running."
      },
      { title: "send message via chatwoot api - String does not have #dig method", 
        content: "Sending an interactive message via PHP and chatwoot api might cause this issue. Understanding the structure of interactive messages in the Chatwoot API documentation can help resolve this."
      },
      { title: "chatwoot api - create message", 
        content: "Sending a message with the chatwoot api involves following the instructions in the API documentation. If the message isn't sending, the code might need to be debugged or adjusted."
      },
      { title: "chatwoot - welcome message from dialogflow", 
        content: "If using the chatwoot widget, which is connected to dialogflow, you might want to send a dialogflow message when the user writes the first message. If there is no response from the welcome intent, further investigation is needed."
      },
      { title: "Chatwoot - Send attachments - NodeJS", 
        content: "Sending files through the ChatWoot API might present challenges. This often involves using a specific framework and making requests using \"HttpService\"."
      },
      { title: "Rails: Error running rake due to different ruby version", 
        content: "This error can occur when using a self-hosted chatwoot installation on AWS using Ubuntu, especially when upgrading the chatwoot version and precompiling the assets. The issue is often due to Ruby version mismatches."
      },
      { title: "Windows WSL: systemctl restart chatwoot.target not working", 
        content: "After installing chatwoot from the official documentation, you might encounter issues with restarting chatwoot. This is often due to the system not being booted with systemd as init."
      },
      { title: "What is the value proposition of Chatwoot?", 
        content: "Chatwoot has been incredibly helpful for our business. We love how it integrates with our existing tools and they continue to add more features."
      },
      { title: "How does Chatwoot integrate with other platforms?", 
        content: "Chatwoot is a great product. It helps us manage customer conversations from different platforms like WhatsApp, Facebook, Twitter, etc."
      },
      { title: "How frequently does Chatwoot release new features?", 
        content: "We've been using Chatwoot for a while now and they've been adding new features and integrations regularly."
      },
      { title: "Is Chatwoot a good tool for customer support?", 
        content: "Very good tool for customer support. It's great to have all customer queries from different channels all in one place."
      },
      { title: "Can I use Chatwoot for my small business?", 
        content: "I've been using Chatwoot for my small business. It's very helpful and I highly recommend it."
      },
      { title: "How does Chatwoot help in tracking client conversations?", 
        content: "I've been using Chatwoot for a few months now and it's been incredibly helpful to keep track of client conversations."
      },
      { title: "What are the benefits of using Chatwoot for customer support?", 
        content: "Chatwoot is a simple, yet powerful tool. It has made a big difference to our customer support."
      },
      { title: "How does Chatwoot help in managing customer conversations?", 
        content: "Chatwoot is a great tool for managing customer conversations. It's easy to use and has a lot of features."
      },
      { title: "Can I integrate Chatwoot with my existing CRM?", 
        content: "Yes, Chatwoot can be integrated with various CRM platforms to manage and streamline your customer conversations."
      },
      { title: "Is Chatwoot mobile-friendly?", 
        content: "Absolutely, Chatwoot is designed to be responsive and can be used on various devices including mobiles, tablets, and desktops."
      },
      { title: "Does Chatwoot support multi-language?", 
        content: "Yes, Chatwoot is a multilingual platform. It supports multiple languages to help businesses connect with their customers globally."
      },
      { title: "How secure is Chatwoot?", 
        content: "Security is a top priority for Chatwoot. It follows best security practices to ensure the safety and privacy of your customer conversations."
      },
      { title: "What is the pricing for Chatwoot?", 
        content: "Chatwoot offers different pricing tiers based on your business needs. You can check the official Chatwoot website for detailed pricing information."
      },
      { title: "Can I customize Chatwoot for my business?", 
        content: "Yes, Chatwoot offers various customization options to align with your business branding and customer support needs."
      },
      { title: "Does Chatwoot offer analytics?", 
        content: "Yes, Chatwoot offers robust analytics to help you understand your customer interactions better and improve your customer support."
      },
      { title: "Can Chatwoot handle high volume of customer messages?", 
        content: "Chatwoot is designed to handle a high volume of customer messages seamlessly, ensuring that your customer support is efficient and reliable."
      },
      { title: "Does Chatwoot have an API?", 
        content: "Yes, Chatwoot offers a well-documented API that you can use to integrate Chatwoot's functionality into your own applications or workflows."
      },
      { title: "How can I migrate my data to Chatwoot?", 
        content: "Chatwoot provides tools and documentation to help you migrate your data from other platforms, making the transition as smooth as possible."
      }
    ]
    
    
    # load your portal here
    portal = Account.first.portals.first
    # Create articles with sample data
    faqs.each do |faq|
      article = Article.create(title: faq[:title], content: faq[:content], account_id: portal.account.id, portal_id: portal.id, author: portal.account.users.first, status: :published, category: portal.categories.first)
      article.save!
    end
    

• Generate embeddings for the articles and perform a search to view the results

  • hook = Integrations::Hook.first # Change this accordingly to fetch your openai integration hook
    # generates embeddings for articles in support center
    Integrations::Openai::EmbeddingsService.new(hook: hook).create_article_embeddings
    # Searches the articles and returns the results
    # change hello with your relevant keyword
    Integrations::Openai::EmbeddingsService.new(hook: hook).search_article_embeddings('cost of Chatwoot')
    
    ## map just title and content 
    Integrations::Openai::EmbeddingsService.new(hook: hook).search_article_embeddings('cost of Chatwoot').map{|a| [a.title, a.content[0..100]]}
    

Observations

• Results of a couple of searches over the embeddings of the sample faq data

• vector Extentions availability across different cloud providers. We will have to test it across installations
  • Hosted Providers pgvector/pgvector#54
  • https://gitlab.com/gitlab-org/gitlab/-/issues/404396#note_1342348028
  • there is a significant demand across all cloud providers, so it should be coming everywhere ( azure and aws already have this ) 🤞
  • other options : https://platform.openai.com/docs/guides/embeddings/how-can-i-retrieve-k-nearest-embedding-vectors-quickly