Skip to content

Commit 904dfdf

Browse files
committed
Iterate over content and adapt
1 parent d14b183 commit 904dfdf

30 files changed

+1375
-141
lines changed

docs/introduction/1-Introduction.mdx

+47-4
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,58 @@ slug: /
66
---
77

88
import Image from '../../src/components/Image';
9+
import { Icon } from '@mui/material'
10+
import TextSnippet from '@mui/icons-material/TextSnippet'
11+
import CloudIcon from '@mui/icons-material/Cloud'
12+
import LanguageIcon from '@mui/icons-material/Language'
13+
import QuizIcon from '@mui/icons-material/Quiz'
14+
import SharePointIcon from '../../src/components/SharePointIcon/'
15+
import RDFLogo from '../../src/components/RDFLogo'
16+
import OneNoteIcon from '../../src/components/OneNoteIcon.svg'
17+
import SearchIcon from '@mui/icons-material/Search'
18+
import ChatIcon from '@mui/icons-material/Chat'
19+
import DataUsageIcon from '@mui/icons-material/DataUsage'
20+
import EditNoteIcon from '@mui/icons-material/EditNote'
21+
import LinkIcon from '@mui/icons-material/Link'
22+
import NotesIcon from '@mui/icons-material/Notes'
923

10-
<h3>A Platform to access your data via Natural Language</h3>
24+
<h3>Create Enterprise AI Assistants in a breeze</h3>
1125

12-
QAnswer is a AI Assistant platform, i.e., a platform that allows to find answers accross your data. You can query several data sources and formats,
13-
such as **collections of documents** (txt, pdf, docx, ...) and **RDF data**. It makes your data accessible via natural language!
26+
QAnswer is a platform that allows to combine the power of Large Language Models (LLMs) with enterprise data. QAnswer enables organizations to build intelligent AI assistants directly on top of their existing data, making information instantly accessible and actionable. Its three-step approach simplifies the deployment process:
1427

15-
It is a combination of semantic technologies, information retrieval and machine learning techniques. This makes QAnswer the first AI driven platform to query your data in natural language.
28+
1. **Connect Your Data**: Integrate QAnswer with your data repositories. Currently supported data sources include:
29+
<ul style={{'list-style-type': 'disc'}}>
30+
<li>[<TextSnippet sx={{verticalAlign:"middle"}}/> **Documents** (PDFs, txt, docx, ..)](tutorial-ui/data-source/document)</li>
31+
<li>[<LanguageIcon sx={{verticalAlign:"middle"}}/> **Websites** (server and client side rendered)](tutorial-ui/data-source/website)</li>
32+
<li>[<QuizIcon sx={{verticalAlign:"middle"}}/> **Q&A**](tutorial-ui/data-source/q&a)</li>
33+
<li>[<SharePointIcon sx={{verticalAlign:"middle"}}/> **Sharepoint**](tutorial-ui/data-source/sharepoint)</li>
34+
<li>[<CloudIcon sx={{verticalAlign:"middle"}}/> **OneDrive**](tutorial-ui/data-source/onedrive)</li>
35+
<li>[<Icon sx={{verticalAlign:"middle"}}><OneNoteIcon/></Icon> **OneNote**](tutorial-ui/data-source/onenote)</li>
36+
<li>[<RDFLogo size={20} color={'#148FBF'} color2={'#148FBF'}/> **Knowledge Graphs**: RDF data formats (.TTL, .NT)](tutorial-ui/data-source/rdf)</li>
37+
</ul>
38+
39+
2. **Choose Your AI Task**: Select the functionality best suited to your needs:
40+
<ul style={{'list-style-type': 'disc'}}>
41+
<li>[<ChatIcon sx={{verticalAlign:"middle"}}/> **Chatbot Creation**](tutorial-ui/ai-task/chat): Design conversational agents to interact with users, answer questions, and guide them through processes.</li>
42+
<li>[<SearchIcon sx={{verticalAlign:"middle"}}/> **Semantic Search**](tutorial-ui/ai-task/search): Go beyond keywords and retrieve precise answers based on the meaning and context of queries.</li>
43+
<li>[<DataUsageIcon sx={{verticalAlign:"middle"}}/> **Data Extraction**](tutorial-ui/ai-task/data-extractor): Automatically identify and extract specific pieces of information from your documents.</li>
44+
<li>[<EditNoteIcon sx={{verticalAlign:"middle"}}/> **Report Generation**](tutorial-ui/ai-task/report-generator): Summarize key findings and generate insightful reports from your data.</li>
45+
</ul>
1646

47+
3. **Expose Your Assistant**: Make your AI assistant readily available through multiple channels:
48+
<ul style={{'list-style-type': 'disc'}}>
49+
<li>[**Web Widgets**](tutorial-ui/expose/classical-integrations/website-chatbot): Embed interactive chatbots seamlessly into your website or intranet pages.</li>
50+
<li>[**Integrations**](/tutorial-ui/expose/third-party-integrations/bubble): Leverage existing platforms like Microsoft Teams, Slack, or other collaboration tools.</li>
51+
<li>**Native APIs**: Develop custom integrations and workflows tailored to your specific requirements.</li>
52+
</ul>
1753

54+
Potential Use Cases include:
55+
<ul style={{'list-style-type': 'disc'}}>
56+
<li>**Website Chatbots**: Quickly create chatbots for your websites</li>
57+
<li>**Internal Employee Assistants**: Streamline HR processes, facilitate policy lookups, and offer personalised guidance to staff members.</li>
58+
<li>**Support**: Elevate customer service by offering 24/7 access to information.</li>
59+
<li>**Legal Research**: Accelerate research by enabling direct access to legal precedents, regulations, and historical records.</li>
60+
</ul>
1861
<div style={{ display: 'flex', alignItems: 'center', flexDirection: 'column', gap: '30px', marginBottom: '20px' }}>
1962
Go ahead to start using QAnswer!
2063
<img src='/img/illustrations/search-text.png' alt='training button' width= '40%'/>

docs/introduction/2-ContactInformation.mdx

+7-4
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ sidebar_label: Contact Information
55
---
66

77
import Link from '@docusaurus/Link'
8+
import EmailIcon from '@mui/icons-material/Email';
9+
import LinkedInIcon from '@mui/icons-material/LinkedIn';
10+
import DiscordIcon from './discord'
11+
812

913
If you have any questions, feedbacks or need further assistance, feel free to reach out to us. Here are the different ways you can contact us:
1014

11-
- **Email**: For general inquiries, you can email us at [[email protected]](mailto:[email protected]).
12-
- **Twitter**: Stay updated with our latest news and announcements by following us on Twitter [@TheQACompany](https://twitter.com/TheQACompany).
13-
- **LinkedIn**: Connect with us on LinkedIn to explore professional opportunities, stay connected with our team, and receive the latest announcements. Visit our LinkedIn page [https://www.linkedin.com/company/qanswer](https://www.linkedin.com/company/qanswer).
14-
- **Discord Community Server**: Join our Discord community server to engage in discussions, ask questions, and connect with other members of our community. Click [https://discord.gg/XqkNCB3ZEY](https://discord.gg/XqkNCB3ZEY) to join our Discord server.
15+
- <EmailIcon sx={{verticalAlign:"middle"}}/> **Email**: For general inquiries, you can email us at [[email protected]](mailto:[email protected]).
16+
- <LinkedInIcon sx={{verticalAlign:"middle"}}/> **LinkedIn**: Connect with us on LinkedIn to explore professional opportunities, stay connected with our team, and receive the latest announcements. Visit our LinkedIn page [https://www.linkedin.com/company/qanswer](https://www.linkedin.com/company/qanswer).
17+
- <DiscordIcon sx={{verticalAlign:"middle"}}/> **Discord Community Server**: Join our Discord community server to engage in discussions, ask questions, and connect with other members of our community. Click [https://discord.gg/XqkNCB3ZEY](https://discord.gg/XqkNCB3ZEY) to join our Discord server.
1518

1619
We value your feedback and are always here to assist you. Feel free to reach out through any of the above channels. We look forward to hearing from you!

docs/introduction/discord.js

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
id: register-login
3-
title: Register and login
4-
sidebar_label: Register and login
2+
id: register-login-email
3+
title: Email
4+
sidebar_label: Email
55
---
66

77
import Image from '../../src/components/Image';
88
import Link from '@docusaurus/Link';
99
import Tabs from '@theme/Tabs';
1010
import TabItem from '@theme/TabItem';
1111

12-
To discover the full potential of the platform, you need to register and login to the platform. Let's get started !
12+
You can start to register and login from here:
1313

1414
<div style={{ display: 'flex', justifyContent: 'center', marginBottom: '20px' }}>
1515
<Link
@@ -27,22 +27,18 @@ You will then be able to [change your password](/premise-mode/change-pwd) on you
2727
:::
2828

2929
## Register
30-
First you need to register.
30+
First you need to register by indicating a valid e-mail, a name, a username and a password:
3131

3232
<Image src='/img/screenshots/register.png' alt='Sign up'/>
3333

3434
## Activate your account
35-
After your registered, you need to activate your account (check your email).
35+
After your registered, you need to activate your account (check your email (also your spams)).
3636

3737
<Image src='/img/screenshots/activate-account.png' alt='Activate account'/>
3838

3939
## Login
4040
Once your account is validated, you can login to the platform and start having fun!
4141

42-
:::info
43-
You can also connect with your Google or GitHub account!
44-
:::
45-
4642
<Image src='/img/screenshots/login.png' alt='Login'/>
4743

48-
<div style={{ display: 'flex', width: '100%', justifyContent: 'center', fontSize: '30px' }}>Welcome to the QAnswer community 🎉</div>
44+
<div style={{ display: 'flex', width: '100%', justifyContent: 'center', fontSize: '30px' }}>Welcome to the QAnswer community 🎉</div>../../../src/components/Image

docs/register/oAuth.mdx

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: register-login-oauth
3+
title: OAuth
4+
sidebar_label: OAuth
5+
---
6+
7+
import Image from '../../src/components/Image';
8+
import Link from '@docusaurus/Link';
9+
import Tabs from '@theme/Tabs';
10+
import TabItem from '@theme/TabItem';
11+
12+
You can start to register and login from here:
13+
14+
<div style={{ display: 'flex', justifyContent: 'center', marginBottom: '20px' }}>
15+
<Link
16+
to='https://app.qanswer.ai'
17+
className="button button--primary button--lg"
18+
>
19+
Try it out!
20+
</Link>
21+
</div>
22+
23+
:::note
24+
If you are in *On premise mode* an administrator needs to create an account for you.
25+
26+
You will then be able to [change your password](/premise-mode/change-pwd) on your profile page.
27+
:::
28+
29+
## oAuth
30+
Choose the oAuth provider that you want to use, for example Google or Github and click on the corresponding oAuth button:
31+
32+
<Image src='/img/screenshots/login.png' alt='Login'/>
33+
34+
## Login and authorize
35+
36+
Login via your oAuth provider and if needed authorize the application:
37+
38+
<Image src='/img/screenshots/oauth.png' alt='Login'/>
39+
40+
<div style={{ display: 'flex', width: '100%', justifyContent: 'center', fontSize: '30px' }}>Welcome to the QAnswer community 🎉</div>

docs/tutorial-ui/createAiAssistant.mdx

+10-17
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,17 @@ import Link from '@docusaurus/Link'
77
import Tabs from '@theme/Tabs'
88
import TabItem from '@theme/TabItem'
99
import Image from '../../src/components/Image'
10+
import AddIcon from '@mui/icons-material/Add';
1011

11-
Welcome to our AI Assistant documentation, where you can effortlessly explore your data using natural language queries. Enhance the performance of your AI Assistants through training and share them with peers.
12-
13-
## Access
12+
In the following we will guide you through the steps to create an AI Assistant on your data.
1413

1514
:::info
16-
You have to be connected to create and access your AI Assistant (you can use AI Assistant without being connected if it is open to public and you have the link).
17-
18-
If you don't have an account yet, you can [see the tutorial here](/tutorial-ui/register-login)
15+
You have to be connected to create and access your AI Assistants. If you don't have an account yet, you can [see the tutorial here](/tutorial-ui/register/register-login-email)
1916
:::
2017

21-
Once your account is created, you can login and start discovering the platform!
18+
## List AI Assistants
19+
20+
When you are logged in, you will enter in the **AI Assistant** page. The page is directly available here:
2221

2322
<div style={{ display: 'flex', justifyContent: 'center', marginBottom: '20px' }}>
2423
<Link
@@ -29,7 +28,7 @@ Once your account is created, you can login and start discovering the platform!
2928
</Link>
3029
</div>
3130

32-
When you are logged in, you will enter in the **AI Assistant** page:
31+
The page will be empty or contain the AI Assistants that you have already created:
3332

3433
<Tabs>
3534
<TabItem value='s1' label='Empty page' default>
@@ -40,17 +39,11 @@ When you are logged in, you will enter in the **AI Assistant** page:
4039
</TabItem>
4140
</Tabs>
4241

43-
:::note
44-
Independently to their type, all AI Assistant will be listed in this [page](https://app.qanswer.ai/qa-systems).
45-
:::
42+
## Create
4643

4744
<p>
48-
It's time to build your first AI Assistant! In the panel <a href='https://app.qanswer.ai/qa-systems'>AI Assistant</a>, click on
49-
<span style={{ whiteSpace: 'nowrap' }}>
50-
<img src='/img/icons/add_circle.svg' style={{ width: '30px', padding: '0 5px', verticalAlign: 'middle' }}/>
51-
<b style={{ verticalAlign: 'middle', color: '#666666', marginRight: '10px' }}>CREATE</b>
52-
</span>
53-
button and choose the type of AI Assistant you want to create.
45+
It's time to build your an AI Assistant! In the panel <a href='https://app.qanswer.ai/'>AI Assistant</a>, click on the "CREATE"
46+
button and choose the name of AI Assistant you want to create as well the language it should support.
5447
</p>
5548

5649
<Image src='/img/screenshots/tutorial-ui/ai-assistant-empty-add-btn.png' alt='Home page, add button'/>

docs/tutorial-ui/data-source/1-Document.mdx

+16-17
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: document
3-
title: 'Document data source AI Assistant'
3+
title: 'Document data source'
44
sidebar_label: Document
55
---
66

@@ -9,9 +9,17 @@ import Link from '@docusaurus/Link'
99
import Tabs from '@theme/Tabs'
1010
import TabItem from '@theme/TabItem'
1111

12-
## Creation
13-
Upload your files (click or drag and drop on the dedicated area). There is the list of extention files supported by the AI Assitant :<br/>
14-
.txt, .html, .md, .ods, .docx, .xlsx, .doc, .rtf, .odt, .csv, .pdf, .pptx
12+
Click on "Document" to add documents as a data source:
13+
14+
<Image src='/img/screenshots/tutorial-ui/data-source/data-source-empty.png' alt='data source menu'/>
15+
16+
## Upload
17+
18+
Upload your files (click or drag and drop on the dedicated area):
19+
20+
:::info
21+
The following file formats are currently supported: .txt, .html, .md, .ods, .docx, .xlsx, .doc, .rtf, .odt, .csv, .pdf, .pptx
22+
:::
1523

1624
<Tabs>
1725
<TabItem value='g1' label='Empty' default>
@@ -22,20 +30,13 @@ Upload your files (click or drag and drop on the dedicated area). There is the l
2230
</TabItem>
2331
</Tabs>
2432

25-
Then you can click on:
26-
* <kbd>Finish</kbd> to create your AI Assistant and you will be redirected to the AI Assistant principal page with a topbar and you
27-
will have your newly built connector appearing in the list.
33+
Once you specified all your documents click on "Finish". You will be redirected to data source page:
2834

2935
<Image src='/img/screenshots/tutorial-ui/data-source/document/documents-list.png' alt='documents list'/>
3036

3137

32-
## Access
33-
:::note
34-
If you don't have created an AI Assistant you can check [Create an AI Assistant](/tutorial-ui/createAiAssistant) section!
35-
:::
36-
37-
:::info
38-
We are making an AI Assistant on top of a collection of textual documents (PDFs) about the Simpsons that can be found here:
38+
:::tip
39+
If you need some files to try out this data source you can use this collection of PDFs about the Simpsons that can be found here:
3940
<div style={{ display: 'flex', justifyContent: 'center', marginBottom: '20px' }}>
4041
<Link
4142
target="_blank"
@@ -47,11 +48,9 @@ We are making an AI Assistant on top of a collection of textual documents (PDFs)
4748
</Link>
4849
</div>
4950
These documents are coming from <a href='https://simpsons.fandom.com/wiki/Category:Simpson_family'>the Simpsons wiki</a>
50-
:::
5151

52+
Here you can access a search interface based on this PDF collection, you can try it yourself!
5253

53-
:::tip
54-
Here you can access a demo based on this tutorial and try it yourself!
5554
<div style={{ display: 'flex', justifyContent: 'center', marginBottom: '20px' }}>
5655
<Link
5756
to='https://app.qanswer.ai/public-share?kb=The%20Simpson%20Family&type=text&user=demo&lang=en'

0 commit comments

Comments
 (0)