diff --git a/SUMMARY.md b/SUMMARY.md index 33d1033..d44ed4f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -18,6 +18,7 @@ * [Deploy to Web](guides/copilot/deploy-to-web.md) * [Building a Multi-Modal Copilot](guides/copilot/building-a-multi-modal-copilot.md) * [📢 Broadcast Messages (via web or API)](guides/copilot/broadcast-messages-via-web-or-api.md) + * [Frequently Asked Questions about AI Copilot](guides/copilot/frequently-asked-questions-about-ai-copilot.md) * [🎞️ How to create AI Animations?](guides/how-to-create-ai-animations.md) * [🖼️ Create an AI Image with text](guides/create-an-ai-image-with-text/README.md) * [AI Image Prompting](https://docs.google.com/presentation/d/1RaoMP0l7FnBZovDAR42zVmrUND9W5DW6eWet-pi6kiE/edit#slide=id.p) diff --git a/guides/copilot/frequently-asked-questions-about-ai-copilot.md b/guides/copilot/frequently-asked-questions-about-ai-copilot.md new file mode 100644 index 0000000..fe5c0e5 --- /dev/null +++ b/guides/copilot/frequently-asked-questions-about-ai-copilot.md @@ -0,0 +1,56 @@ +--- +description: Some answers to common issues when implementing Copilot in production +--- + +# Frequently Asked Questions about AI Copilot + +### Q: The copilot seems to answer the question accurately but the answers are incomplete. What can I do? + +A: To avoid this, you need to increase the Output Tokens from the “settings” section of your copilot. + +> NOTE: If your copilot use case requires a lot of memory/history of the previous chats to continue the conversation this can create huge context windows and you might get a quickly scaled up usage and higher billing. + +### Q: We are running a voice-based bot, the TTS model reads out the formatting syntax like asterisks, hyphens, etc. This is very troubling to the user. What can we do? + +A: You can add a simple prompt instruction: “Don't include markdown” or if you want to be a lot more specific you can write a detailed prompt like this: + +``` +“Remember, you are a voice agent, so do not use markdown, HTML, latex or any other markup language, instead, output plain text without any formatting characters like asterisk, hyphen, bracket, hash, underscore etc. Keep your responses concise and clear under 100 words.” +``` + +### Q: The copilot is running on Whatsapp for text and Twilio for phone audio, I want to make sure that some prompts are specified only to Twilio, I don’t want to make two bots. What can i do? + +A: For example, if you want to make sure that Twilio does not use markdown but you want formatting for your Whatsapp or Web bots. You can add “if statement” to the prompt through our Jinja templating language like this: + +```django +{% raw %} +{% if platform == "TWILIO" %} +Remember, you are a voice agent, so do not use markdown, HTML, latex or any other markup language, instead, output plain text without any formatting characters like asterisk, hyphen, bracket, hash, underscore etc. Keep your responses concise and clear under 100 words. +{% endif %} +{% endraw %} +``` + +> NOTE: This can be added in your basic prompt instructions there are no “special” settings for this. + +### Q: I have a WhatsApp/Slack copilot, but the text output shows up as markup language. How can I fix this? + +A: By incorporating _Jinja_ templating in the Prompt, you can adjust the prompt as needed. In the example below we are using WhatsApp and Slack clients running alongside your web client you can try this example in your AI Copilot: + +```django +You are an AI Bot that runs the front-desk of a Dentist's clinic. + +{% raw %} +{% if platform == [ "WHATSAPP", "SLACK" ] %} + Remember, you are a {{ platform }} agent, so do not use HTML, latex or any other markup language, instead use only the following formatting styles: + italic: single underscore + bold: single asterix. Do not use 2 asterix as per markdown, instead use {{ platform }} guidelines and use 1 asterix only + strikethrough: single tilde + code: single backtick + code block: 3 backticks + quoted text: place an angle bracket and space before the text + headings: just use bold style with 1 asterix. +{% endif %} +{% endraw %} +``` + +Here the Jinja templating language uses an `if statement` to provide the prompt with a condition to output the text in a particular way based on the platform the bot is integrated into.