updated install instructions and added warnings

This commit is contained in:
Peter Morton 2025-05-28 11:15:27 -05:00
parent 73294b19b4
commit 509da61b97

View File

@ -12,9 +12,15 @@ This package provides an example RAG process using Azure AI Search for Retrieval
- This package requires the CQA Widget to be installed and configured. - This package requires the CQA Widget to be installed and configured.
> **WARNING:** There is an error in the _CQA_66308ec473f3d10350a2e499_ Global Variable file on line 20: It should read v2 instead of v1 and should be fixed manually
```javascript
let url = `${settings.apiurl}/${settings.productcode}/${settings.ingress}/inference/verint-contextual-question-answering-v2`;
```
### Installation ### Installation
1. Copy the CQA_Retriever and CQA_RetieverSettings files into **Global Variables** 1. Copy the [CQA_Retriever](./GlobalVariable/CQA_Retriever.js) and [CQA_RetieverSettings](./GlobalVariable/CQA_RetrieverSettings.json) files into **Global Variables**
2. _Optional:_ Import the Example Conversation Flow and Intent 2. _Optional:_ Import the Example Conversation Flow and Intent
### Configuration ### Configuration
@ -56,6 +62,8 @@ A global variable function which handles the logic and API calls used to retriev
This is included in the Example Conversation Flow if you have imported that. This is included in the Example Conversation Flow if you have imported that.
> NOTE: This example exits via the output pin '0'. If you need it to continue to the next block, then change the ```next(0)``` to ```next()``` on the second to last line,
```javascript ```javascript
(async () => { (async () => {
console.log(`CQA Retrieval: ${conversationData.cqa_question}`); console.log(`CQA Retrieval: ${conversationData.cqa_question}`);