├── .gcloudignore ├── LICENSE ├── README.md ├── app.yaml ├── chatter.py ├── images └── Chatbot sentiment analysis.png ├── main.py ├── requirements.txt └── templates └── index.html /.gcloudignore: -------------------------------------------------------------------------------- 1 | # This file specifies files that are *not* uploaded to Google Cloud 2 | # using gcloud. It follows the same syntax as .gitignore, with the addition of 3 | # "#!include" directives (which insert the entries of the given .gitignore-style 4 | # file at that point). 5 | # 6 | # For more information, run: 7 | # $ gcloud topic gcloudignore 8 | # 9 | .gcloudignore 10 | # If you would like to upload your .git directory, .gitignore file or files 11 | # from your .gitignore file, remove the corresponding line 12 | # below: 13 | .git 14 | .gitignore 15 | 16 | # Python pycache: 17 | __pycache__/ 18 | # Ignored by the build system 19 | /setup.cfg -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2023 MongoDB Inc. 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Generative AI Customer Service Chatbot 2 | 3 | This is a demo of a customer service chatbot using Generative AI through Google Cloud's Vertex AI PaLM APIs. The app also leverages MongoDB Atlas Search to look for relevant answers in a MongoDB Atlas database. Finally, the app can detect dissatisfied customers with sentiment analysis. 4 | 5 | Screenshot of the ‘Customer Service Chatbot’ app showing the sentiment analysis of a customer request 6 | 7 | 8 | ## Quickstart 9 | 10 | 1. MongoDB Atlas setup 11 | * Deploy a new MongoDB database cluster in your Atlas account. You can use the free M0 tier for this demo. 12 | * Create a `XYZ-Corp` database. 13 | * Create a `Customer` collection in the `XYZ-Corp` database and insert the following document. 14 | ```json 15 | { 16 | "customer_id":"111", 17 | "conversation":[], 18 | "Name":"Venkatesh Shanbhag" 19 | } 20 | ``` 21 | * Create an `Insurance` collection in the `XYZ-Corp` database and insert the following document. 22 | ```json 23 | { 24 | "context":"You are a Customer support agent with name Sara working for XYZ-corp.\nIt does provides property Insurance. Sara will not reply for any queries regarding other types of insurance.\nThe company covers insurance of properties like - Hospitals, offices, shops, apartments.\nMax insurance covered will decline over period of time.\nXYZ-Corp only covers Fire and Earthquake hazard insurance. \nYou are allowed to provide only the details regarding the company itself.\nDo not repond with sentiment in any of the responses.", 25 | "type":"Intro" 26 | } 27 | ``` 28 | * Create a `Claims` collection in the `XYZ-Corp` database and insert the following document. 29 | ```json 30 | { 31 | "claim_number":"12345", 32 | "Name":"Venkatesh Shanbhag", 33 | "Claim_amount":{"$numberLong":"10000"}, 34 | "Currency":"USD", 35 | "Claim_status":"In progress","customer_id":"111" 36 | } 37 | ``` 38 | * Create an Atlas Search index with the name `default` on the `Claims` collection using the default settings. Follow the Atlas Search documentation: https://www.mongodb.com/docs/atlas/atlas-search/create-index/. 39 | * A small knowledge base is available on chat-search collection. Insert below documents to MongoDB. In real life scenerio instead of text vectors are stored of the text embeddings and search is performed based in vector. 40 | 41 | ```json lines 42 | {"question":"claim","Answer":"Please provide 5 digit claim number"} 43 | {"question":"Not resolved","Answer":"Do you want to connect to an Agent for further assistence"} 44 | {"question":"status of a claim","Answer":"Please provide 5 digit claim number"} 45 | {"question":"Company Policy","Answer":"1. Architects fees / Debris clearance\nFollowing a valid claim for damage under\nbuildings Causes below, we will also pay:\n• Architects, surveyors, consulting engineers\nand legal fees, but not fees for preparing a\nclaim;\n• the cost of clearing debris from the site or\ndemolishing or shoring up the buildings;\n• the cost to comply with government or local\nauthority requirements but not if the order\npredates the loss or damage.\n2. Emergency services forced entry\nLoss or damage to the buildings caused when\nthe fire, police or ambulance service has to force\nan entry to the buildings because of an\nemergency or perceived emergency involving\nyou or your family.\n3. Moving Home\nIf you have entered into a contract to sell the\nhome, the person buying it will have the full\nprotection of your policy for the buildings up to\nthe date of completion of the purchase, as long\nas the home is not covered by any other\ninsurance.\n4. Keys & locks\nIf your keys are lost or stolen we will pay up to\nthe limit for any one claim for the cost of\nreplacing keys and locks or lock mechanisms to:\n• external doors and windows of the home\n(but not to a garage or outbuildings);\n• a safe within the home;\n• an alarm protecting the home.\nLimit – please refer to your schedule\n5. Alternative Accommodation\nWe will pay you up to the limit for any one claim\nfor the reasonable cost of alternative\naccommodation for you, your family and your\ndomestic pets when your home cannot be lived\nin due to loss or damage covered by this policy..\nLimit – please refer to your schedule"} 46 | {"question":"Proof of income","Answer":"This document may become necessary whenever the sum\nproposed is very high. Normally a sum proposed which is seven\nto eight times of the declared income is acceptable for\ninsurance. But proposals do come to the insurer when the\nknown source of income of the proposer is much less compared\nto the amount of insurance desired. A service holder normally\ndoes not face this problem as his sources of income are\nverifiable.\nIn case of business people, the assessed income is at times\nmuch less compared to what is a desirable income for the\namount of insurance desired. In such cases the insurer at\ntimes calls for assessed income tax returns, or Chartered\nAccountant’s certificate etc. Such precautions are necessary\nto eliminate the possibility of moral hazard."} 47 | {"question":"Not good","Answer":"Do you want to connect via call to a Customer care representative?"} 48 | {"question":"bad experience","Answer":"Do you want to connect via call to a Customer care representative?"} 49 | ``` 50 | 51 | 3. Google Cloud setup 52 | 53 | * Set the Google Cloud project name. 54 | 55 | ```commandline 56 | gcloud config set project 57 | ``` 58 | 59 | * Clone the repository. 60 | 61 | ```commandline 62 | git clone https://github.com/mongodb-developer/Google-Cloud-Generative-AI-Chatbot.git 63 | ``` 64 | 65 | * Update the MongoDB Atlas database connection string and the Google Cloud project name in `main.py`. 66 | 67 | * Run the application. 68 | 69 | ```commandline 70 | python3 main.py 71 | ``` 72 | 73 | 74 | ## Contributors ✨ 75 | 76 | 77 | 78 | 79 | 80 | 86 | 87 |
81 | 82 |
83 | Venkatesh Shanbhag 84 |

85 |
88 | 89 | 90 | 91 | 92 | ## Disclaimer 93 | 94 | Use at your own risk; not a supported MongoDB product 95 | -------------------------------------------------------------------------------- /app.yaml: -------------------------------------------------------------------------------- 1 | runtime: python39 2 | 3 | handlers: 4 | # This configures Google App Engine to serve the files in the app's static 5 | # directory. 6 | - url: /static 7 | static_dir: static 8 | 9 | # This handler routes all requests not caught above to your main app. It is 10 | # required when static routes are defined, but can be omitted (along with 11 | # the entire handlers section) when there are no static files defined. 12 | - url: /.* 13 | script: auto -------------------------------------------------------------------------------- /chatter.py: -------------------------------------------------------------------------------- 1 | import vertexai 2 | from vertexai.preview.language_models import ChatModel, TextGenerationModel 3 | 4 | 5 | def predict_large_language_model_sample( 6 | project_id: str, 7 | model_name: str, 8 | temperature: float, 9 | max_output_tokens: int, 10 | top_p: float, 11 | top_k: int, 12 | location: str = "us-central1", 13 | ): 14 | """Predict using a Large Language Model.""" 15 | vertexai.init(project=project_id, location=location) 16 | chat_model = ChatModel.from_pretrained(model_name) 17 | parameters = { 18 | "temperature": temperature, 19 | "max_output_tokens": max_output_tokens, 20 | "top_p": top_p, 21 | "top_k": top_k, 22 | } 23 | return chat_model, parameters 24 | 25 | 26 | def predict_large_language_model_sentiment( 27 | project_id: str, 28 | model_name: str, 29 | temperature: float, 30 | max_decode_steps: int, 31 | top_p: float, 32 | top_k: int, 33 | content: str, 34 | location: str = "us-central1", 35 | tuned_model_name: str = "", 36 | ): 37 | """Predict using a Large Language Model.""" 38 | vertexai.init(project=project_id, location=location) 39 | model = TextGenerationModel.from_pretrained(model_name) 40 | if tuned_model_name: 41 | model = model.get_tuned_model(tuned_model_name) 42 | response = model.predict( 43 | content, 44 | temperature=temperature, 45 | max_output_tokens=max_decode_steps, 46 | top_k=top_k, 47 | top_p=top_p, ) 48 | return response.text 49 | 50 | 51 | def chat_with_model(parameters, question, chat): 52 | conversation = {"question": question} 53 | response = chat.send_message(question, **parameters) 54 | print(response.text) 55 | conversation["response"] = response.text 56 | return response.text, conversation 57 | 58 | 59 | def connect_cluster(srv): 60 | import pymongo 61 | client = pymongo.MongoClient( 62 | srv, 63 | tlsAllowInvalidCertificates=True) 64 | return client 65 | 66 | 67 | def query_db(client, db_name, col_name, doc): 68 | db = client[db_name] 69 | col = db[col_name] 70 | x = col.find_one(doc) 71 | return x 72 | 73 | 74 | def upsert_db(client, db_name, col_name, doc, customer_id): 75 | db = client[db_name] 76 | col = db[col_name] 77 | col.update_one({"customer_id": customer_id}, {"$push": {"conversation": doc}}) 78 | 79 | 80 | def insert_record(client, db_name, col_name, doc, customer_id): 81 | db = client[db_name] 82 | col = db[col_name] 83 | col.insert_one({"customer_id": customer_id, "conversation": ""}) 84 | 85 | 86 | def search_mongoDB_chat_base(db, col,client, question): 87 | db = client[db] 88 | col = db[col] 89 | response = col.aggregate([{'$search': {'index': 'default', 'text': {'query': question, 'path': 'question'}}}, {'$limit': 1}]) 90 | return response 91 | 92 | 93 | def search_mongoDB_claim(db, col,client, question): 94 | db = client[db] 95 | col = db[col] 96 | response = col.aggregate([{'$search': {'index': 'default', 'text': {'query': question, 'path': 'claim_number'}}}, {'$limit': 1}]) 97 | return response 98 | -------------------------------------------------------------------------------- /images/Chatbot sentiment analysis.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mongodb-developer/Google-Cloud-Generative-AI-Chatbot/ee98d3ed6af45a97a00358baeed064b798f3a300/images/Chatbot sentiment analysis.png -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, request, render_template 2 | 3 | import chatter 4 | from vertexai.preview.language_models import InputOutputTextPair 5 | 6 | conversation = [] 7 | 8 | app = Flask(__name__) 9 | 10 | # Constants 11 | customer_id = "111" 12 | db_name = "XYZ-Corp" 13 | srv = "mongodb+srv://venkatesh:ashwin123@freetier.kxcgwh2.mongodb.net/?retryWrites=true&w=majority" 14 | project_name = "gcp-pov" 15 | # MongoDB initialization 16 | conn = chatter.connect_cluster(srv) 17 | intro_context = chatter.query_db(conn, db_name, "Insurance", {"type": "Intro"}) 18 | try: 19 | saved_conversation = chatter.query_db(conn, db_name, "Customer", {"customer_id": customer_id}) 20 | except: 21 | chatter.insert_record(conn, db_name, "Customer", {"customer_id": customer_id}) 22 | 23 | # Set Chat context and parameters 24 | context = intro_context["context"] 25 | chat_model, parameters = chatter.predict_large_language_model_sample(project_name, "chat-bison@001", 0.9, 100, 1, 40, 26 | "us-central1") 27 | 28 | if saved_conversation: 29 | for i in saved_conversation["conversation"]: 30 | conversation.append( 31 | InputOutputTextPair( 32 | input_text=i["question"], 33 | output_text=i["response"] 34 | ) 35 | ) 36 | 37 | chat = chat_model.start_chat( 38 | context=context, 39 | examples=conversation 40 | ) 41 | 42 | 43 | @app.route("/") 44 | def homepage(): 45 | return render_template("index.html") 46 | 47 | 48 | @app.route('/chat', methods=["GET", "POST"]) 49 | def chat_with_ai(): 50 | question = request.form['question'] 51 | sentiment = chatter.predict_large_language_model_sentiment(project_name, "text-bison@001", 0.2, 5, 0.8, 1, 52 | '''respond only with sentiment and sentiment score. If positive respond "Positive" and its sentiment score separated by space. if negative respond with "Negative" and its sentiment score separated by space. Reply with Positive for all numeric values. reply with Negative value lesser than -1 for customer inputs like 'Not satisfied' for input:''' + question + '''"Classify the sentiment of the message:"''', 53 | "us-central1") 54 | claim_details = "" 55 | if len(question) == 5 and question.isnumeric(): 56 | search_results = chatter.search_mongoDB_claim("XYZ-Corp", "Claims", conn, question) 57 | for i in search_results: 58 | claim_details = i 59 | if claim_details: 60 | claim_details = str(claim_details["claim_number"]) + " " + claim_details["Claim_status"] + " " + str(claim_details["Claim_amount"]) 61 | question = question + " " + claim_details 62 | else: 63 | question = "can not find the claim that you are looking for" 64 | search_response = chatter.search_mongoDB_chat_base("XYZ-Corp", "chat-search", conn, question) 65 | 66 | for item in search_response: 67 | question = question + " " + item["Answer"] 68 | 69 | if sentiment.split(" ")[0] == "Negative" and float(sentiment.split(" ")[1]) < -1: 70 | question = question + ": respond with abstract of the answer: Do you want to connect with the customer " \ 71 | "service representative? " 72 | response_text, conversation = chatter.chat_with_model(parameters, question + ". Sentiment:" + sentiment, chat) 73 | conversation["sentiment"] = sentiment 74 | chatter.upsert_db(conn, db_name, "Customer", conversation, customer_id) 75 | return response_text + " -- " + str(sentiment) 76 | 77 | 78 | app.run(debug=True) 79 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | flask~=2.2.5 2 | google-cloud-aiplatform 3 | pymongo 4 | gunicorn 5 | -------------------------------------------------------------------------------- /templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Chatter - Chatbot 6 | 7 | 8 | 9 | 159 | 160 | 161 |
162 |
163 |
164 | Chatter : XYZ-Corp 165 |
166 |
167 | 168 |
169 |
170 | 171 |
172 |
173 |
177 | 178 |
179 |
180 |
Sara
181 |
19:00
182 |
183 | 184 |
185 | Hi, welcome to Chatter! How may I help you today? 186 |
187 |
188 |
189 | 190 |
191 | 192 |
193 | 194 | 195 |
196 |
197 | 198 | 291 | 292 | 293 | 294 | --------------------------------------------------------------------------------