Skip to content

Commit d281566

Browse files
SylvainSylvain
authored andcommitted
expose classical & some changes
1 parent 863133e commit d281566

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+249
-69
lines changed

docs/tutorial-ui/ai-task/1-Search.mdx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,23 @@ import Admonition from '@theme/Admonition'
1515
you will enter the <kbd>Search</kbd> section of the AI Assistant built on top of the documents you uploaded.
1616
</p>
1717

18-
<Image src='/img/screenshots/tutorial-ui/ai-assistant-existing-sys.png' alt='search pages'/>
18+
<Image src='/img/screenshots/tutorial-ui/ai-assistant-existing-sys.png' alt='Ai assistant menu'/>
1919

20-
You can also access the <kbd>Search</kbd> section by clicking on <kbd>AI Assitant</kbd> on the top bar then clicking on <kbd>Search</kbd>.
21-
22-
<Image src='/img/screenshots/ai-task/ai-assistant-menu.png' alt='ai assistant menu'/>
23-
24-
<Image src='/img/screenshots/ai-task/search/search-empty.png' alt='search pages'/>
20+
<Image src='/img/screenshots/tutorial-ui/ai-task/search/search-empty.png' alt='search pages'/>
2521

2622
For "The Simpsons" AI Assistant, you can ask questions like:
2723
- "who are the children of the simpsons"
2824
- "what is the name of the dog of the simpsons"
2925

3026
<Tabs>
3127
<TabItem value='g1' label='Answer' default>
32-
<Image src='/img/screenshots/ai-task/search/search-ai-answer1.png' alt='answer pages'/>
28+
<Image src='/img/screenshots/tutorial-ui/ai-task/search/search-ai-answer1.png' alt='answer pages'/>
3329
</TabItem>
3430
<TabItem value='s1' label='Question 1' >
35-
<Image src='/img/screenshots/ai-task/search/search-ai-answer1-zoomed.png' alt='answer pages'/>
31+
<Image src='/img/screenshots/tutorial-ui/ai-task/search/search-ai-answer1-zoomed.png' alt='answer pages'/>
3632
</TabItem>
3733
<TabItem value='s2' label='Question 2' >
38-
<Image src='/img/screenshots/ai-task/search/search-ai-answer2-zoomed.png' alt='answer pages'/>
34+
<Image src='/img/screenshots/tutorial-ui/ai-task/search/search-ai-answer2-zoomed.png' alt='answer pages'/>
3935
</TabItem>
4036
</Tabs>
4137

@@ -69,7 +65,7 @@ When the system gives you an answer it is highlighted inside its context. You ca
6965
button (at the top left), it will show you the answer highlighted in the PDF document.
7066
</p>
7167

72-
<Image src='/img/screenshots/ai-task/search/search-ai-answer2-highlight.png' alt='answer pages'/>
68+
<Image src='/img/screenshots/tutorial-ui/ai-task/search/search-ai-answer2-highlight.png' alt='answer pages'/>
7369

7470
:::caution
7571
Our backend model is evolving over time so the answers that you get might be different.

docs/tutorial-ui/ai-task/2-Chat.mdx

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,13 @@ import Tabs from '@theme/Tabs'
99
import TabItem from '@theme/TabItem'
1010
import Admonition from '@theme/Admonition'
1111

12-
You can access the <kbd>Chat</kbd> section by clicking on <kbd>AI Assitant</kbd> on the top bar then clicking on <kbd>Chat</kbd>.
13-
14-
<Image src='/img/screenshots/ai-task/ai-assistant-menu.png' alt='ai assistant menu'/>
15-
16-
<Image src='/img/screenshots/ai-task/chat/chat-empty.png' alt='ai assistant chat'/>
12+
<Image src='/img/screenshots/tutorial-ui/ai-task/chat/chat-empty.png' alt='ai assistant chat'/>
1713

1814
:::info
1915
In AI Task chat the answers are based only on the information delivered to the AI Assistant with the connectors. You can interact with the chat and give it more information. You can refer to the data-source section to setup a connector, check [Data Source](/tutorial-ui/data-source/document) section!
2016
:::
2117

22-
<Image src='/img/screenshots/ai-task/chat/chat-full.png' alt='ai assistant chat'/>
18+
<Image src='/img/screenshots/tutorial-ui/ai-task/chat/chat-full.png' alt='ai assistant chat'/>
2319

2420
<div>
2521
<Admonition type="tip">
@@ -44,13 +40,13 @@ In AI Task chat the answers are based only on the information delivered to the A
4440

4541
<Tabs>
4642
<TabItem value='g1' label='Positive feedback' default>
47-
<Image src='/img/screenshots/ai-task/chat/chat-feedback-positive.png' alt='chat give positive feedback'/>
43+
<Image src='/img/screenshots/tutorial-ui/ai-task/chat/chat-feedback-positive.png' alt='chat give positive feedback'/>
4844
</TabItem>
4945
<TabItem value='s1' label='Negative feedback' >
50-
<Image src='/img/screenshots/ai-task/chat/chat-feedback-negative.png' alt='chat give negative feedback'/>
46+
<Image src='/img/screenshots/tutorial-ui/ai-task/chat/chat-feedback-negative.png' alt='chat give negative feedback'/>
5147
</TabItem>
5248
<TabItem value='s2' label='Edit answer' >
53-
<Image src='/img/screenshots/ai-task/chat/chat-edit_answer.png' alt='chat edit answer'/>
49+
<Image src='/img/screenshots/tutorial-ui/ai-task/chat/chat-edit_answer.png' alt='chat edit answer'/>
5450
</TabItem>
5551
</Tabs>
5652

docs/tutorial-ui/ai-task/3-DataExtractor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: dataextractor
2+
id: data-extractor
33
title: 'Data Extractor'
44
sidebar_label: Data Extractor
55
---

docs/tutorial-ui/ai-task/4-RDF.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: reportgenerator
2+
id: report-generator
33
title: 'Report Generator'
44
sidebar_label: Report Generator
55
---
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
id: ai-task-introduction
3+
title: 'AI Task'
4+
sidebar_label: 2 - AI Task
5+
---
6+
import Link from '@docusaurus/Link'
7+
import Tabs from '@theme/Tabs'
8+
import TabItem from '@theme/TabItem'
9+
import Image from '../../src/components/Image'
10+
11+
You can access the <kbd>AI Task</kbd> section by clicking on the on the top bar after choosing the AI Assistant you want to work with.
12+
13+
<Image src='/img/screenshots/tutorial-ui/ai-task/ai-assistant-menu.png' alt='ai assistant menu'/>
14+
15+
AI task groups together several features that allows you to request information in different ways.
16+
17+
* <b style={{ color: '#3d82b3' }}>Search</b>
18+
allows you to ask a question to the assistant, which will answer you with references to the documents provided.
19+
* <b style={{ color: '#3d82b3' }}>Chat</b>
20+
allows you to talk to your assistant like a conversation, which will answer you with references to the documents provided. You can interact whith it and give more informations. But the the chat will reset if you close or refresh the page.
21+
* <b style={{ color: '#3d82b3' }}>Data Extractor</b>
22+
Write text
23+
* <b style={{ color: '#3d82b3' }}>Report Generator</b>
24+
Write text
25+
26+
:::note
27+
If you don't have created an AI Assistant you can check [Create an AI Assistant](/tutorial-ui/createAiAssistant) section!
28+
:::

docs/tutorial-ui/createAiAssistant.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
id: createAiAssistant
2+
id: create-ai-assistant
33
title: 'Create an AI Assistant'
44
sidebar_label: Create an AI Assistant
55
---
Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: document
3-
title: 'Document based AI Assistant'
3+
title: 'Document data source AI Assistant'
44
sidebar_label: Document
55
---
66

@@ -9,8 +9,33 @@ 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
15+
16+
<Tabs>
17+
<TabItem value='g1' label='Empty' default>
18+
<Image src='/img/screenshots/tutorial-ui/data-source/document/documents-empty.png' alt='documents empty'/>
19+
</TabItem>
20+
<TabItem value='s1' label='Files selected'>
21+
<Image src='/img/screenshots/tutorial-ui/data-source/document/documents-init.png' alt='documents add'/>
22+
</TabItem>
23+
</Tabs>
24+
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.
28+
29+
<Image src='/img/screenshots/tutorial-ui/data-source/document/documents-list.png' alt='documents list'/>
30+
31+
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+
1237
:::info
13-
In this tutorial we are going to make a AI Assistant on top of a collection of textual documents (PDFs) about the Simpsons that can be found here:
38+
We are making an AI Assistant on top of a collection of textual documents (PDFs) about the Simpsons that can be found here:
1439
<div style={{ display: 'flex', justifyContent: 'center', marginBottom: '20px' }}>
1540
<Link
1641
target="_blank"
@@ -36,20 +61,4 @@ Here you can access a demo based on this tutorial and try it yourself!
3661
Open demo 🍩
3762
</Link>
3863
</div>
39-
:::
40-
41-
## Access
42-
:::note
43-
To access the creation page, check [Create an AI Assistant](/tutorial-ui/createAiAssistant) section!
44-
:::
45-
46-
## Creation
47-
Upload your files (click or drag and drop on the dedicated area), you can click on:
48-
* <kbd>Finish</kbd> to create your AI Assistant.
49-
50-
<Image src='/img/screenshots/tutorial-ui/data-source/document/creation-init.png' alt='documents add'/>
51-
52-
After clicking on the <kbd>Finish</kbd> button, you will be redirected to the AI Assistant principal page with a topbar and you
53-
will have your newly built connector appearing in the list.
54-
55-
<Image src='/img/screenshots/tutorial-ui/data-source/document/documents-list.png' alt='documents list'/>
64+
:::

docs/tutorial-ui/data-source/2-Website.mdx

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: website
3-
title: 'Website-based AI Assistant'
3+
title: 'Website data source AI Assistant'
44
sidebar_label: Website
55
---
66

@@ -16,14 +16,7 @@ Sometimes searching information through a website can be very tedious. So why do
1616
Let's see how do to it!
1717
:::
1818

19-
In this section we will learn how to create a website based AI Assistant.
20-
21-
## Access
22-
:::note
23-
To access the creation page, check [Introduction and Access](/tutorial-ui/createAiAssistant) section!
24-
:::
25-
26-
You will get [there](https://app.qanswer.ai/qa-systems/website):
19+
In this section we will learn how to create a website based AI Assistant.
2720

2821
<Image src='/img/screenshots/tutorial-ui/data-source/website/website-empty.png' alt='Empty wizard'/>
2922

@@ -101,4 +94,9 @@ Then you can customize your QA System parameters if needed (default parameters a
10194
<Image src='/img/screenshots/tutorial-ui/data-source/website/creation-settings.png' alt='Settings'/>
10295

10396
After clicking on the <kbd>Finish</kbd> button, you will be redirected to the home page and you
104-
will have your newly built QA system appearing in the list.
97+
will have your newly built QA system appearing in the list.
98+
99+
## Access
100+
:::note
101+
To access the creation page, check [Create an AI Assistant](/tutorial-ui/createAiAssistant) section!
102+
:::

docs/tutorial-ui/data-source/3-Q&A.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: q&a
3-
title: 'Q&A-based AI Assistant'
3+
title: 'Q&A data source AI Assistant'
44
sidebar_label: Q&A
55
---
66

@@ -37,4 +37,9 @@ You may also click on <kbd>Add Q&A</kbd> of the popup to add several question in
3737

3838
Finaly, your Q&A are available on your AI Assistant.
3939

40-
<Image src='/img/screenshots/tutorial-ui/data-source/q&a/q&a-filled.png' alt='Q&A filled'/>
40+
<Image src='/img/screenshots/tutorial-ui/data-source/q&a/q&a-filled.png' alt='Q&A filled'/>
41+
42+
## Access
43+
:::note
44+
To access the creation page, check [Create an AI Assistant](/tutorial-ui/createAiAssistant) section!
45+
:::

docs/tutorial-ui/data-source/4-RDF.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: rdf
3-
title: 'RDF-based AI Assistant'
3+
title: 'RDF data source AI Assistant'
44
sidebar_label: RDF
55
---
66

0 commit comments

Comments
 (0)