Skip to content

Commit

Permalink
Merge pull request #84 from microsoft/ltierney/5796-updates-getting-s…
Browse files Browse the repository at this point in the history
…tarted-docs

Adding in Feature and Readme Docs for Using IA
  • Loading branch information
dayland authored Jun 19, 2023
2 parents 903209e + e061bb6 commit ea2fbe1
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,19 @@ There are several steps to deploying the IA Accelerator. The following checklist

# Using IA Accelerator for the first time

TBD
Now that you have successfully deployed the IA Accelerator, you are ready to use the accelerator to process some data.

To use the IA Accelerator, you need to follow these steps:

> 1. Prepare your data and upload it to Azure.
> - 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).
> - Upload your data [via the data upload user interface](/docs/features/features.md#uploading-documents).
> 2. Once uploaded the system will automatically process and make the document(s) available to you and other users of the deployment.
> 3. Begin [having conversations with your data](/docs/features/features.md#having-a-conversation-with-your-data) by selecting the appropriate interaction method.
For more detailed information review the [Features](/docs/features/features.md) section of the documentation.

---

## Resources

Expand Down
19 changes: 19 additions & 0 deletions docs/features/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,29 @@ We also log the status of the pre-processing in Azure Cosmos DB. View our [Statu

## User Experience

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.

### Uploading documents
You can upload documents in the [supported formats listed above](#document-pre-processing) through the user interface. To do so:
> 1. Click on the Upload Files link in the top of the interface
> ![Upload Link](/docs/images/upload-files-link.jpg)
> 2. Drag files to the user interface, or click to open a browse window
> ![Upload Link Drag and Drop](/docs/images/upload-files-drag-drop.jpg)
### Having a conversation with your data

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.

> You may activate the Chat engagement pattern by choosing the "Chat" link at the top of the page
> ![Chat Link](/docs/images/chat-interface.jpg)
### Ask your data

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.

> You may activate the **Ask a question** engagement pattern by choosing the "Chat" link at the top of the page
> ![Chat Link](/docs/images/ask-a-question-interface.jpg)
### Analysis Panel

The Analysis Panel in the UX allows the user to explore three details about the answer to their question:
Expand Down
Binary file added docs/images/ask-a-question-interface.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/chat-interface.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/upload-files-drag-drop.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/upload-files-link.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ea2fbe1

Please sign in to comment.