Skip to content

Commit ea2fbe1

Browse files
authored
Merge pull request #84 from microsoft/ltierney/5796-updates-getting-started-docs
Adding in Feature and Readme Docs for Using IA
2 parents 903209e + e061bb6 commit ea2fbe1

File tree

6 files changed

+32
-1
lines changed

6 files changed

+32
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,19 @@ There are several steps to deploying the IA Accelerator. The following checklist
8383

8484
# Using IA Accelerator for the first time
8585

86-
TBD
86+
Now that you have successfully deployed the IA Accelerator, you are ready to use the accelerator to process some data.
87+
88+
To use the IA Accelerator, you need to follow these steps:
89+
90+
> 1. Prepare your data and upload it to Azure.
91+
> - Your data must be in a specified format to be valid for processing. See our [supported document types in the Feature documentation](/docs/features/features.md#document-pre-processing).
92+
> - Upload your data [via the data upload user interface](/docs/features/features.md#uploading-documents).
93+
> 2. Once uploaded the system will automatically process and make the document(s) available to you and other users of the deployment.
94+
> 3. Begin [having conversations with your data](/docs/features/features.md#having-a-conversation-with-your-data) by selecting the appropriate interaction method.
95+
96+
For more detailed information review the [Features](/docs/features/features.md) section of the documentation.
97+
98+
---
8799

88100
## Resources
89101

docs/features/features.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,29 @@ We also log the status of the pre-processing in Azure Cosmos DB. View our [Statu
2424

2525
## User Experience
2626

27+
The end user leverages the web interface as the primary method to engage with the IA Accelerator, and the Azure OpenAI service. The user interface is very similar to that of the OpenAI ChatGPT interface, though it provides different and additional functionality which is outlined below.
28+
29+
### Uploading documents
30+
You can upload documents in the [supported formats listed above](#document-pre-processing) through the user interface. To do so:
31+
> 1. Click on the Upload Files link in the top of the interface
32+
> ![Upload Link](/docs/images/upload-files-link.jpg)
33+
> 2. Drag files to the user interface, or click to open a browse window
34+
> ![Upload Link Drag and Drop](/docs/images/upload-files-drag-drop.jpg)
35+
2736
### Having a conversation with your data
2837

38+
When you engage with IA Accelerator in the "Chat" method, the system maintains a history for your conversation and will be able to understand the context of your questions from one question to the next.
39+
40+
> You may activate the Chat engagement pattern by choosing the "Chat" link at the top of the page
41+
> ![Chat Link](/docs/images/chat-interface.jpg)
42+
2943
### Ask your data
3044

45+
When you engage with IA Accelerator in the "Ask a question" method, the system does not maintain a history for your conversation. Each question will be treated with on its own as a new and unique query.
46+
47+
> You may activate the **Ask a question** engagement pattern by choosing the "Chat" link at the top of the page
48+
> ![Chat Link](/docs/images/ask-a-question-interface.jpg)
49+
3150
### Analysis Panel
3251

3352
The Analysis Panel in the UX allows the user to explore three details about the answer to their question:
93.6 KB
Loading

docs/images/chat-interface.jpg

122 KB
Loading
52.2 KB
Loading

docs/images/upload-files-link.jpg

125 KB
Loading

0 commit comments

Comments
 (0)