Plans supporting the use of AI search suite
Free | Professional | Business | Enterprise |
---|---|---|---|
The Ask Eddy AI feature is available on your home page and the Knowledge base site's search bar. This AI assistant provides more contextual answers to reader queries and prompts. This helps the user avoid having to search and read through multiple articles. Instead, it provides answers from your existing Knowledge base.
NOTE
By default, Eddy AI assistive search retrieves answers from the main workspace. To access information from a different workspace or across all workspaces, switch to the desired workspace using the filter on your knowledge base site.
After updating content in the published article, Eddy AI assistive search will take approximately 15 minutes to fetch the updated information in the knowledge base site.
The Ask Eddy AI will extract all information in your knowledge base, including the textual content, code blocks, tables, content reuse elements, and LaTeX.
Turning on Ask Eddy AI for your Knowledge base site
Navigate to Settings () > AI Features > Eddy AI in the Knowledge base portal.
Turn on the AI assistive search toggle.
The AI assistant Eddy AI now starts indexing your Knowledge base content and this process takes a while. Once done, the Ask Eddy AI button will be available on your Knowledge base site search bar and the Home page.
Accessing Ask Eddy AI
For your information
The Conversational Eddy AI enhancement is available exclusively in KB site 2.0. To explore KB site 2.0 without impacting your existing Knowledge base, go to Settings () > Customize site. For more details, read the article on KB site 2.0 migration.
Click on the Search bar or press
Ctrl + K
on the Knowledge base site.Start typing the keyword, and the general search results will appear.
NOTE
If Ask Eddy AI is not enabled in the Knowledge base portal, only the search bar will be available in the Knowledge base site.
Press Enter and Ask Eddy AI will generate results along with the source articles.
Click the Copy () icon to copy the generated content if needed.
Provide feedback by clicking the like () or dislike () icon for the generated result.
Click Source articles to refer the articles based on which the Eddy AI fetches information.
Click on any desired source article, and it will open in a new tab.
The Eddy AI will provide answers in the language the question is asked.
Choose the desired workspace or all workspaces from the filter dropdown to fetch results from Eddy AI.
NOTE
If you filter workspaces during an Ask Eddy AI conversation, the generated results will be reset.
Eddy’s response will be contextual and will be based on the last five queries.
After the first query and answer, click the Continue conversation with Eddy AI text field to enter your next query and press Enter or click the Send icon.
Multi-lingual support for Ask Eddy AI assistive search
The Ask Eddy AI assistive search feature seamlessly integrates with the knowledge base site, offering support for a wider array of languages.
NOTE
In addition to English (en-US, en-GB, en-AU), the Eddy AI assistive search supports 14 other languages, including:
French (fr)
Spanish (es)
German (de)
Norwegian (no)
Dutch (nl)
Portuguese (pt)
Swedish (sv)
Italian (it)
Korean (ko)
Finnish (fi)
Polish (pl)
Arabic (ar)
Hebrew (he)
Danish (da)
If a workspace is configured with a language not supported by Eddy AI, such as Chinese, the Assistive search feature will not be available for that workspace.
Customize the Eddy AI Localization variables
Navigate to Settings () > Localization & Workspaces in the Knowledge base portal.
By default, the Localization & workspaces tab will appear.
Navigate to the Localization variables tab.
In the Eddy AI accordion, update the variable values according to your desired language.
Integrating Eddy AI in KB Widget with multi-lingual support
You can access Eddy AI within your knowledge base as a widget, in various languages including English (en-US, en-GB), French (fr), Spanish (es), German (de), Norwegian (no), Dutch (nl), Portuguese (pt), Swedish (sv), Italian (it), Korean (ko), Finnish (fi), Polish (pl), Arabic (ar), Hebrew (he), Danish (da), ensuring a seamless user experience.
For more information, read the article on Integrating Eddy AI in KB widget.
Enabling Eddy AI credits notification
You can configure notifications for Ask Eddy AI credit balance. To enable Credit usage alert toggle,
Navigate to Settings () > Knowledge base portal > Notifications.
By default, the Notification channels tab will appear.
Go to the Notification mapping tab.
In Eddy AI notifications accordion, turn on the Credit usage alert toggle.
Once enabled, Document360 will send reminders to the configured notification channels when the credit balance drops to 20%, 10% of the total allotted balance, and when the balance expires.
How do my readers use the AI-powered assistive search feature?
Your Knowledge base site users click the "Ask Eddy AI" button, and a prompt input popup opens. They can type in any prompt or query to get tailor-made answers.
Recommendations for optimizing your experience as a reader with Eddy AI
1. Converse Naturally
Why: Speak to "Eddy AI" as you would to a human.
Example: Instead of "Search for articles on templates," try "Eddy AI, find me articles explaining Document360 templates."
2. Provide Detailed Context
Why: Enhance understanding by setting the stage and providing context.
Example: Instead of "Errors in the documentation," try "Eddy AI, help me identify and resolve errors in the Document360 user guide."
3. Customize Persona
Why: Instruct "Eddy AI" to adopt a specific identity for personalized responses.
Example: Instead of "Search for software updates," try "Eddy AI, imagine you're our IT expert and update me on the latest software changes."
4. Embrace Creativity
Why: Encourage experimentation and creativity in your queries.
Example: Instead of a standard search like "Knowledge base structure," try "Eddy AI, let's play! Imagine you're a content strategist and suggest an ideal knowledge base structure."
By following these recommendations, you harness the power of Eddy AI’s capabilities and make your interactions more engaging and tailored to your specific needs. Feel free to experiment, instruct Eddy AI creatively, and watch as your queries yield more insightful and personalized results.
Recommendations for optimizing your experience as a contributor with Eddy AI
Writing documentation that is easily understood by AI (Eddy AI) involves incorporating clear language, structured formatting, and adherence to specific guidelines.
1. Use Clear and focused language
Express ideas in a straightforward manner, avoiding unnecessary complexity.
Break down complex concepts into simpler, digestible parts.
Define technical terms or provide links to detailed explanations.
2. Structured formatting
Use clear headings and subheadings to organize information.
Employ bullet points and numbered lists to present step-by-step instructions.
Highlight key points using bold or italics for better parsing by bots.
3. Consistent terminology
Maintain consistency in the use of terminology to facilitate understanding.
Use the Glossary feature in Document360 to achieve this.
Avoid ambiguity by using specific and standardized terms.
4. Avoid jargon overload
Minimize the use of industry-specific jargon unless essential.
If technical terms are necessary, provide brief explanations or context.
5. Elaborative text content
Elaborate the content and clearly specify the content's intent.
If you use multimedia content, ensure that you provide a text explanation of what the media is trying to convey.
Break down information into shorter paragraphs for better readability.
Provide explicit answers to questions in the form of FAQs to minimize inaccurate answers by "Eddy AI." AI bots tend to hallucinate when the content is not elaborate or explicitly mentioned.
6. Provide context and example
Offer real-world examples to illustrate technical concepts.
Provide context to help the reader understand the purpose and application of the information.
7. Use descriptive headings
Craft descriptive headings that accurately represent the content.
Headings should act as a guide, summarizing the content beneath.
Avoid repetitive heading text in the same article.
8. Test with "Eddy AI"
Utilize "Eddy AI" to analyze your content for clarity and coherence.
Make adjustments based on feedback from these tools.
By implementing these recommendations, you can create and manage documentation that is not only comprehensible to humans but also easily processed and understood by AI and NLP bots like "Eddy AI".
NOTE
Document360's "Ask Eddy AI" utilizes OpenAI APIs in its backend operations. Data is transmitted to OpenAI through their APIs. OpenAI adheres to a privacy policy that prohibits the use of customer-submitted data via our API for training OpenAI models or enhancing OpenAI's service offerings. Both Document360 and OpenAI comply with GDPR regulations. Additionally, Document360 is SOC 2 compliant.
An extract from the policy states, "OpenAI will not use data submitted by customers via our API to train OpenAI models or improve OpenAI's service offerings."
Read the complete OpenAI API data usage policies.
If you any queries regarding Document360's data policy, please read our Privacy policy.
FAQ(s)
What data or information does Ask Eddy AI collects?
Ask Eddy AI does not collect any Personal Identifiable Information (PII). We collect prompts (questions), Eddy AI's response, citation articles, and feedback; This collected data is available as part of Eddy AI Search Analytics.
What technology does Ask Eddy AI use?
Eddy AI utilizes OpenAI APIs under the hood for its functionality. We send data to OpenAI via their APIs. According to OpenAI's privacy policies, data sent via their APIs will not be used to train their GPT models.
Does Ask Eddy AI use any other source other than our knowledge base?
No, Ask Eddy AI does not use any other sources. It solely relies on your knowledge base content to generate responses. If there is insufficient information or context available in your knowledge base to answer a specific question, Ask Eddy AI will respond with "I do not know."
How does Ask Eddy AI protect your data?
We know that privacy and security is critical for many organizations. We are committed to protecting your organization’s and user’s data and privacy. We use industry-standard security practices, reputable subprocessors with SOC 2 compliance, and provide the controls needed for organizations to meet their own data protection requirements.
What does credit mean for Ask Eddy AI?
One credit equals one question (prompt) asked. As part of our standard offering, Ask Eddy AI can be used to ask 1000 questions per month. Please contact our support team or your customer success manager if you wish to purchase additional credits.
How does Ask Eddy AI work on private knowledge base?
Ask Eddy AI utilizes the access controls you have set to generate an appropriate response based on the user's access control and permissions. If a logged-in user lacks access to a specific article but asks a question where the restricted article holds the answer, Ask Eddy AI will respond with "I do not know."
How quickly does Eddy AI's response reflect new content?
After updating an article, it generally takes around 15 minutes for Eddy AI's response to align with the changes if a question is posed regarding the updated content. Similarly, when deleting an article, Eddy AI typically takes about 15 minutes to stop referencing the content from the deleted article.
Does Ask Eddy AI search within attachments?
Currently, Ask Eddy AI does not search within attachments. This means any content within your PDF and Word document which you have attached or embedded within your knowledge base article, is not indexed by Ask Eddy AI. However, we will support this functionality in future release updates.
What happens if I select French as the workspace language but ask questions in English?
If you have selected French as the preferred language for your workspace, the Article Summarizer will read your question and respond in French irrespective of the language of the question. The selected language in the workspace settings determines the language of Eddy AI's responses.
What if I ask a question in a language not available in the project?
In such cases, Eddy AI will not respond through the Assistive search feature. It's essential to ensure that the language used for inquiring aligns with the supported languages.
How do I check my Eddy AI credit balance?
The admin/owner can view the remaining credits for using AI Assistive search feature from Settings > AI features > Eddy AI.
Document360 will send reminders to the configured notification channels when the credit balance drops to 20%, 10% of the total allotted balance, and when the balance expires.
How can I purchase additional credits for the Eddy AI assistive search?
You can purchase additional credits by navigating Settings > AI Features > Eddy AI, and the Buy more option in the Document360 portal. If you are in trial version, you cannot purchase add-ons.
How do I configure email domain for Eddy AI credit notification?
To receive Eddy AI credit notifications via email, you need to configure your email domain. Go to Settings > Knowledge base portal > Notifications > Email domain. By default, emails will be sent from support@document360.com if the email domain is not configured.
What are the various notification channels for receiving Eddy AI credit notifications?
You can receive Eddy AI credits notifications in English from various notification channels such as webhook, Microsoft Teams, Slack, and email if you have set up the configuration.
For more information of configuring notifications, read the article on Notifications.
How do I configure the desired email address for receiving Eddy AI credit notifications?
After enabling the Eddy AI credits notification toggle, to receive Eddy AI credit notifications, configure your email address in Settings > Knowledge base portal > Notifications.
In the Notification channels tab, click on New channel and select SMTP.
Click Next.
Enter the channel name and the desired email address to receive notifications.
If required, you can add CC and BCC.
For more information, read the article on SMTP notification channel.
Why is Eddy not showing in my API documentation?
Eddy is available only on the Knowledge base site and is not implemented for API documentation.
Can Eddy AI answer questions that require user login or involve restricted articles?
No, Eddy AI answers questions based on the user’s access control and permissions. If a logged-in user does not have access to a specific article, but they ask a question related to that article, Eddy AI will respond with No results found.