Skip to content

Commit 05524e0

Browse files
Readme update as257 (#85)
* Updated README with edits per AS-257 1. Updated README contents. 2. Added sample image * Removed unnecessary text Changed ` [code block: `server/llmManager.js`]` to `server/llmManager.js`
1 parent 66fa9de commit 05524e0

2 files changed

Lines changed: 10 additions & 6 deletions

File tree

webviewer-ask-ai/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# WebViewer - Ask AI sample
22

3-
[WebViewer](https://docs.apryse.com/web/guides/get-started) is a powerful JavaScript-based PDF Library that is part of the [Apryse SDK](https://apryse.com/).
3+
Add an AI-powered assistant to WebViewer, enabling chat-based Q&A, document and selected-text summarization, keyword extraction, and contextual prompts that lets users ask questions about their PDFs.
4+
5+
6+
[WebViewer](https://apryse.com/products/webviewer) is a powerful JavaScript-based PDF Library that is part of the [Apryse SDK](https://apryse.com/).
47

58
- [WebViewer Documentation](https://docs.apryse.com/web/guides/get-started)
69
- [WebViewer Demo](https://showcase.apryse.com/)
710

8-
This sample demonstrates how to utilize the artificial intelligence capabilities within the WebViewer, using a chat panel interface to ask questions about the loaded document. Also the user can select text to summarize.
11+
![sample document](sample-document.png "sample document")
12+
913

10-
## Get your trial key
14+
## Getting started
1115

1216
A license key is required to run WebViewer. You can obtain a trial key in our [get started guides](https://docs.apryse.com/web/guides/get-started), or by signing-up on our [developer portal](https://dev.apryse.com/).
1317

@@ -25,9 +29,7 @@ npm install
2529

2630
## Configuration
2731

28-
This sample uses OpenAI. You can use any other artificial intelligence of your choice.
29-
30-
However, to get started with this sample rename `.env.example` file into `.env` and fill the followings:
32+
OpenAI is the default backend for this sample. To get started, rename `.env.example` file into `.env` and fill the following:
3133

3234
```
3335
OPENAI_API_KEY=your-openai-api-key-here
@@ -37,6 +39,8 @@ OPENAI_TEMPERATURE=your-openai-temperature-here
3739
OPENAI_SEED=your-openai-seed-here
3840
```
3941

42+
To use another model, replace the LangChain provider in `server/llmManager.js`, install the corresponding provider package, and update the `.env` variables for that model provider.
43+
4044
## Run
4145

4246
```
463 KB
Loading

0 commit comments

Comments
 (0)