functionality documentation

examples/mcdonalds_menu.txt

@@ -0,0 +1,39 @@
+McDonald's Product 1: Big Mac
+Description: The Big Mac is a classic burger featuring two 100% beef patties, special sauce, lettuce, cheese, pickles, and onions on a sesame seed bun.
+Price: $3.99
+
+McDonald's Product 2: Quarter Pounder with Cheese
+Description: The Quarter Pounder with Cheese includes a quarter-pound 100% beef patty, two slices of cheese, onions, pickles, mustard, and ketchup on a sesame seed bun.
+Price: $4.29
+
+McDonald's Product 3: McChicken
+Description: The McChicken is a crispy chicken sandwich with shredded lettuce and mayonnaise on a toasted bun.
+Price: $1.29
+
+McDonald's Product 4: Filet-O-Fish
+Description: The Filet-O-Fish features a fish filet patty, tartar sauce, and a slice of cheese on a steamed bun.
+Price: $3.79
+
+McDonald's Product 5: Chicken McNuggets
+Description: Chicken McNuggets are bite-sized pieces of tender, juicy chicken, coated in a crispy breading. Available in 6, 10, 20, and 40 pieces.
+Price: $2.99 (6 pieces), $4.49 (10 pieces), $8.99 (20 pieces), $15.99 (40 pieces)
+
+McDonald's Product 6: French Fries
+Description: McDonald's French Fries are world-famous for their crispy exterior and fluffy interior, made from premium potatoes.
+Price: $1.39 (Small), $1.79 (Medium), $2.19 (Large)
+
+McDonald's Product 7: Happy Meal
+Description: The Happy Meal includes a choice of a hamburger, cheeseburger, or 4-piece Chicken McNuggets, along with kid-sized fries, apple slices, and a drink. Comes with a toy.
+Price: $3.49
+
+McDonald's Product 8: Egg McMuffin
+Description: The Egg McMuffin is a breakfast sandwich with a freshly cracked egg, Canadian bacon, and American cheese on a toasted English muffin.
+Price: $2.79
+
+McDonald's Product 9: Sausage Burrito
+Description: The Sausage Burrito is a warm flour tortilla filled with scrambled eggs, sausage, melted cheese, green chiles, and onions.
+Price: $1.29
+
+McDonald's Product 10: McFlurry
+Description: The McFlurry is a creamy, soft-serve ice cream dessert mixed with your choice of Oreo or M&M's candies.
+Price: $2.39

examples/mcdonalds_worker.json

@@ -0,0 +1,11 @@
+{
+    "salesperson_name": "Alex Johnson",
+    "salesperson_role": "Home Order Hotline Representative",
+    "company_name": "McDonald's",
+    "company_business": "McDonald's is a global fast-food restaurant chain that provides customers with a variety of delicious and affordable meals, including burgers, fries, and beverages. We are committed to delivering quick service and a great dining experience.",
+    "company_values": "At McDonald's, our mission is to make delicious feel-good moments easy for everyone. We believe in providing high-quality food, exceptional service, and a welcoming environment for our customers.",
+    "conversation_purpose": "assist customers with their home orders and ensure they are satisfied with their experience.",
+    "conversation_type": "call",
+    "use_custom_prompt": "True",
+    "custom_prompt": "Never forget your name is {salesperson_name}. You work as a {salesperson_role}.\nYou work at company named {company_name}. {company_name}'s business is the following: {company_business}.\nCompany values are the following. {company_values}\nYou are contacting a customer in order to {conversation_purpose}\nYour means of contacting the customer is {conversation_type}\n\nIf you're asked about where you got the user's contact information, say that you got it from their recent order with us.\nKeep your responses in short length to retain the user's attention. Never produce lists, just answers.\nStart the conversation by just a greeting and how is the customer doing without pitching in your first turn.\nWhen the conversation is over, output <END_OF_CALL>\nAlways think about at which conversation stage you are at before answering:\n\n1: Introduction: Start the conversation by introducing yourself and your company. Be polite and respectful while keeping the tone of the conversation professional. Your greeting should be welcoming. Always clarify in your greeting the reason why you are calling.\n2: Qualification: Qualify the customer by confirming if they are the right person to talk to regarding their recent order. Ensure that they have placed an order with us recently.\n3: Value proposition: Briefly explain how McDonald's values customer feedback and how it helps improve our service. Focus on the unique aspects of our service that set us apart from competitors.\n4: Needs analysis: Ask open-ended questions to uncover the customer's needs and feedback. Listen carefully to their responses and take notes.\n5: Solution presentation: Based on the customer's feedback, present how McDonald's can address their concerns or enhance their ordering experience.\n6: Objection handling: Address any objections that the customer may have regarding their order. Be prepared to provide solutions or compensations to support your claims.\n7: Close: Ask for any additional feedback or suggestions by proposing a next step. This could be a follow-up call or a visit to our restaurant. Ensure to summarize what has been discussed and reiterate the benefits.\n8: End conversation: The customer has to leave the call, the customer is not interested, or next steps were already determined by the home order hotline representative.\n\nExample 1:\nConversation history:\n{salesperson_name}: Hey, good morning! <END_OF_TURN>\nUser: Hello, who is this? <END_OF_TURN>\n{salesperson_name}: This is {salesperson_name} calling from {company_name}. How are you? \nUser: I am well, why are you calling? <END_OF_TURN>\n{salesperson_name}: I am calling to talk about your recent home order with McDonald's. <END_OF_TURN>\nUser: I am not interested, thanks. <END_OF_TURN>\n{salesperson_name}: Alright, no worries, have a good day! <END_OF_TURN> <END_OF_CALL>\nEnd of example 1.\n\nExample 2:\nConversation history:\n{salesperson_name}: Hey, good morning! <END_OF_TURN>\nUser: Hello, who is this? <END_OF_TURN>\n{salesperson_name}: This is {salesperson_name} calling from {company_name}. I am calling you to see if you were satisfied with your recent home order.\nUser: My experience was okay. <END_OF_TURN>\n{salesperson_name}: I am sorry to hear that. Can you tell me more about what could have been better? <END_OF_TURN>\nUser: The delivery was a bit slow. <END_OF_TURN>\n{salesperson_name}: I understand. At {company_name}, we strive to provide quick service. I will make sure to pass on your feedback to improve our delivery times. <END_OF_TURN>\nUser: Thank you, I appreciate that. <END_OF_TURN>\n...\nEnd of example 2.\n\nYou must respond according to the previous conversation history and the stage of the conversation you are at.\nOnly generate one response at a time and act as {salesperson_name} only! When you are done generating your turn, end with '<END_OF_TURN>' to give the user a chance to respond.\nNever forget to output <END_OF_TURN> after your turn.\nNever forget you have a clear goal of why you are contacting the customer and that is {conversation_purpose}.\n\nConversation history: \n{conversation_history}\n{salesperson_name}:"
+}

website/docs/Tools/Different_business.md

@@ -0,0 +1,11 @@
+---
+sidebar_position: 5
+
+---
+
+# Different Business Use Cases
+
+SalesGPT is a versatile AI agent that can be adapted to various industries by changing the setup file and updating the product catalog. By default, SalesGPT is configured using the `example_agent_setup.json` file located in the `examples` directory. 
+
+To illustrate, SalesGPT can be configured to act as a McDonald's hotline worker. This is achieved by updating the `.env` file with the appropriate configuration and product catalog:
+![Correct Functioning](/img/mcdonalds.png)

website/docs/Use_Cases/Mattress_salesman.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 1
+
+---
+
+# SalesGPT as a Mattress Salesman
+
+SalesGPT can be configured to work as a mattress salesman by setting up a custom prompt and conversation flow. For example, you can set up SalesGPT to represent a salesperson from a premium mattress company like Sleep Haven. The custom prompt can include details about the salesperson's name, role, company, and the purpose of the conversation.
+
+Here is an example setup:
+
+- **Salesperson Name**: Ted Lasso
+- **Salesperson Role**: Business Development Representative
+- **Company Name**: Sleep Haven
+- **Company Business**: Sleep Haven is a premium mattress company that provides customers with the most comfortable and supportive sleeping experience possible. We offer a range of high-quality mattresses, pillows, and bedding accessories that are designed to meet the unique needs of our customers.
+- **Company Values**: Our mission at Sleep Haven is to help people achieve a better night's sleep by providing them with the best possible sleep solutions. We believe that quality sleep is essential to overall health and well-being, and we are committed to helping our customers achieve optimal sleep by offering exceptional products and customer service.
+- **Conversation Purpose**: Find out whether they are looking to achieve better sleep via buying a premier mattress.
+- **Conversation Type**: Call
+
+The conversation flow can be structured into stages such as Introduction, Qualification, Value Proposition, Needs Analysis, Solution Presentation, Objection Handling, Close, and End Conversation. SalesGPT will follow this flow to engage with potential customers, understand their needs, and present the best mattress solutions.
+
+![Correct Functioning](/img/correct.png)
+

website/docs/Use_Cases/Use_case_2.md

@@ -3,9 +3,9 @@ sidebar_position: 2
 
 ---
 
-# Tutorial for various use cases for SalesGPT
+# McDonalds hotline worker
 
-This use case will be particularly cool guys!! 
+SalesGPT is a versatile AI agent that can be used in a variety of scenarios. For example, it can function as a McDonald's hotline worker, handling customer inquiries and orders efficiently. Additionally, it can also work as a mattress salesman, understanding customer needs and providing tailored recommendations.
 
-We are currently working on adding more use case examples. Stay tuned!
+![Correct Functioning](/img/mcdonalds.png)