feat: Response Bot using GPT and Webpage Sources #7518

sojan-official · 2023-07-13T17:47:21Z

About

This PR lets you associate response sources to an inbox, ie: external webpages, which would be parsed by Chatwoot automatically. This information is then supplied to GPT to automatically triage customer queries

Testing the changes

Enable the feature: creates the tables and enables the extensions ( tables for this feature is managed separately from migrations )

Features::ResponseBotService.new.enable_in_installation
# enable feature for inbox account where you are testing
Inbox.find(id).account.enable_features('response_bot')

Add the OPENAI_API_KEY to your environment variable
Associate knowledge source / documents to an inbox using the following API call

## change the inbox id and API token in payload
## change the source and document links if  you wish


curl  -X POST \
  'http://localhost:3000/api/v1/accounts/1/response_sources' \
  --header 'Accept: */*' \
  --header 'User-Agent: Thunder Client (https://www.thunderclient.com)' \
  --header 'api_access_token: <your API token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "response_source": {
    "name": "Chatwoot HelpCenter",
    "source_link": "https://www.chatwoot.com/help-center",
    "inbox_id":   '<your inbox id>',
    "response_documents_attributes": [
      { "document_link": "https://www.chatwoot.com/docs/self-hosted/deployment/architecture" },
      { "document_link": "https://www.chatwoot.com/docs/self-hosted/deployment/requirements"},
      { "document_link": "https://www.chatwoot.com/docs/self-hosted/deployment/troubleshooting"},
      { "document_link": "https://www.chatwoot.com/docs/contributing-guide"},
      { "document_link": "https://www.chatwoot.com/docs/contributing-guide/chatwoot-apis"},
      { "document_link": "https://www.chatwoot.com/docs/contributing-guide/code-of-conduct"}
    ]
  }
}
'


#### body payload
{
  "response_source": {
    "name": "Chatwoot HelpCenter",
    "source_link": "https://www.chatwoot.com/help-center",
    "inbox_id": 2,
    "response_documents_attributes": [
      { "document_link": "https://www.chatwoot.com/docs/self-hosted/deployment/architecture" },
      { "document_link": "https://www.chatwoot.com/docs/self-hosted/deployment/requirements"},
      { "document_link": "https://www.chatwoot.com/docs/self-hosted/deployment/troubleshooting"},
      { "document_link": "https://www.chatwoot.com/docs/contributing-guide"},
      { "document_link": "https://www.chatwoot.com/docs/contributing-guide/chatwoot-apis"},
      { "document_link": "https://www.chatwoot.com/docs/contributing-guide/code-of-conduct"}
    ]
  }
}

Check the console / db to see if Responses are generated and try Chating on the widget

Follow up from spike: #7162

- add `vector` column using pgvector gem - add service to generate, store and search support article embeddings

ref: https://linear.app/chatwoot/issue/CW-1830/

…nse-sources-with-embeddings

# Conflicts: # .env.example # Gemfile # db/schema.rb

netlify · 2023-07-13T17:47:28Z

✅ Deploy Preview for chatwoot-storybook canceled.

Name	Link
🔨 Latest commit	`acf5b66`
🔍 Latest deploy log	https://app.netlify.com/sites/chatwoot-storybook/deploys/64ba93f694f0fc0008868df1

This commit introduces the ability to associate response sources to an inbox, allowing external webpages to be parsed by Chatwoot. The parsed data is converted into embeddings for use with GPT models when managing customer queries. The implementation relies on the `pgvector` extension for PostgreSQL. Database migrations related to this feature are handled separately by `Features::ResponseBotService`. A future update will integrate these migrations into the default rails migrations, once compatibility with Postgres extensions across all self-hosted installation options is confirmed. Additionally, a new GitHub action has been added to the CI pipeline to ensure the execution of specs related to this feature.

github-actions · 2023-08-20T16:05:18Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

sojan-official added 18 commits May 22, 2023 20:27

poc: Search support articles via OpenAI embeddings

3cbbc3a

- add `vector` column using pgvector gem - add service to generate, store and search support article embeddings

Merge branch 'develop' into spike/CW-1690-embeddings-for-articles

fe86e78

Chore: basic prototype

3e0a71d

chore: GPT bot with article recommendations

8fbfe44

ref: https://linear.app/chatwoot/issue/CW-1830/

Merge branch 'develop' into spike/CW-1690-embeddings-for-articles

44a24bb

chore: minor formatting

cdaa40b

Merge branch 'develop' into spike/CW-1690-embeddings-for-articles

a728bb2

Merge branch 'develop' into spike/CW-1690-embeddings-for-articles

f26649a

chore: Response Sources

c921aec

Merge branch 'spike/CW-1690-embeddings-for-articles' into chore/respo…

ce872de

…nse-sources-with-embeddings

chore: fi

870d2e6

chore: clean up

41a7a25

chore: clean up

a732ec1

Merge branch 'develop' into chore/response-sources-with-embeddings

78814eb

# Conflicts: # .env.example # Gemfile # db/schema.rb

chore: fix

bf6d69a

chore: endpoint to create sources

dc01127

chor: fixes

590cff4

chore: The bot

11a16a8

sojan-official and others added 11 commits July 13, 2023 20:49

chore: reoder gemfile

6510886

chore: fix

cc61674

chore: APIs for add and remove documents

b7c7b09

Chore: clean up

ada6c9c

Merge branch 'develop' into chore/response-sources-with-embeddings

3729a9f

chore: fixes

dfa9b27

Merge branch 'develop' into chore/response-sources-with-embeddings

fce44b7

chore: clean up

c459f42

chore: clean up

98e3ae0

chore: refactor

f63feff

Merge branch 'develop' into chore/response-sources-with-embeddings

fec1e8a

pranavrajs and others added 2 commits July 19, 2023 12:51

Merge branch 'develop' into chore/response-sources-with-embeddings

30a2009

chore: add feature lock

3ca3f9d

sojan-official mentioned this pull request Jul 20, 2023

spike: Search support articles via OpenAI embeddings #7162

Closed

1 task

sojan-official added 3 commits July 20, 2023 20:23

chore: clean up

4538d35

chore: fix specs

1db6b2a

Merge branch 'develop' into chore/response-sources-with-embeddings

e99a8ee

sojan-official marked this pull request as ready for review July 21, 2023 12:09

sojan-official added 7 commits July 21, 2023 15:15

chore: fix code climate

4b05257

chore: fix specs

45a2754

chore: test latest postgres

455df91

chore: tests

ede19fe

chore: update

441da57

Empty-Commit

fe86348

chore: clean up

acf5b66

sojan-official merged commit 480f348 into develop Jul 21, 2023

sojan-official deleted the chore/response-sources-with-embeddings branch July 21, 2023 15:11

github-actions bot locked as resolved and limited conversation to collaborators Aug 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Response Bot using GPT and Webpage Sources #7518

feat: Response Bot using GPT and Webpage Sources #7518

sojan-official commented Jul 13, 2023 •

edited

Loading

netlify bot commented Jul 13, 2023 •

edited

Loading

github-actions bot commented Aug 20, 2023

feat: Response Bot using GPT and Webpage Sources #7518

feat: Response Bot using GPT and Webpage Sources #7518

Conversation

sojan-official commented Jul 13, 2023 • edited Loading

About

Testing the changes

netlify bot commented Jul 13, 2023 • edited Loading

✅ Deploy Preview for chatwoot-storybook canceled.

github-actions bot commented Aug 20, 2023

sojan-official commented Jul 13, 2023 •

edited

Loading

netlify bot commented Jul 13, 2023 •

edited

Loading