First Time Setup Wizard

  • 5 minute(s) read
Prev Next

1. Introduction

After first log in, follow the steps in the setup wizard to connect to Verax and set up Verax to best suit your needs.

2. Add Your Chatbot

After successfully logging in, the Welcome to Verax setup wizard appears. The first step is to add your chatbot name.

  1. Enter the name of your chatbot and click Start setup.  

    Note: Verax uses the chatbot name for labeling purposes; it does not need to be the chatbot's technical name. For example, if your chatbot handles customer inquiries, you can name it “Customer Support Bot.”

3. Upload Your Knowledge base

The second step in the setup wizard is to upload your knowledge base. Verax requires an uploaded knowledge base to provide you with insights and analysis of your chatbot interactions.

  1. Click the upload area or drag the files directly into the area to upload your knowledgebase files.

    Note: The following file types are supported: csv, docx, pdf, txt, ppt, and pptx.

  2. Click Upload and continue to go to the next step of the setup wizard.

  3. Click Upload later to skip this step.  

    Note: The Verax Control Center will not be able to provide you with insight and analytics until you connect your knowledge base. You will have to upload them later. Learn more about uploading your knowledge base.

4. Interaction Method

The third step in the setup wizard is to choose your interaction method. The interaction method determines how the Verax Control Center will interact with your systems. There are two potential interaction methods. Choose the method that best fits your needs and your organization’s security protocols:

  • Proxy - Connect via a proxy for the best Verax experience. A proxy connection allows the Verax Control Center to receive data from your chatbots at real time and provide you with the best request and response analysis and control. Learn more about connecting via proxy

  • API Key - Use an API key if you want more control over how Verax accesses your data. You can set the API key to allow Verax direct access to your chatbots while abiding by stricter organizational security policies. Learn more about connecting via API Key.

Follow these steps to set up your desired interaction method:

  1. Click on the interaction method you want to use.

  2. The next step depends on which interaction method you chose. If you chose to skip adding an interaction method, you’ll be redirected into the Verax Control Center. Based on your choice, follow the instructions in the corresponding section:

    1. Proxy

    2. API Key

  3. To skip this step, click I’ll set it up later.
    Note: Until you select an interaction method, Verax Control Center will not be able to interact with your LLM. You will have to choose an interaction method later to use the Verax Control Center.

5. Proxy Settings

Set up your proxy settings in order to connect to Verax. Connect via a proxy to allow Verax to receive data from your chatbots in real time in order to take full control of the all of the Verax Connect features. To connect via a proxy, you must define the Base URL of your chatbot's API, and add any associated endpoints. You must then generate a Certificate and Key in order to configure your API calls to go through Verax. After setting up your proxy settings, you must verify and connect your endpoints to Verax.

On the Configure Proxy Settings screen:

  1. Under Proxy Settings, do the following:

    1. Enter the Base URL of your chatbot's API. Each chatbot has its own unique URL.

    2. Add the API Endpoints for the Post path of your chatbot's API. Some chatbots have multiple endpoints.

      1. Click Add Endpoint to add additional endpoints.

      2. Click Remove Endpoint to remove an endpoint.

        Note: For a POC setup, you can change the local host to redirect to the proxy to the Verax Control Center IP address, which should resolve immediately. For production setups, you must perform the redirect through your DNS server, which may take more time.

    3. Generate and upload the Certificate and Key. The certificate allows the proxy to configure your API calls to go through the Verax Control Panel. Work with your Certificate Authority to generate a certificate or generate it locally with the proper trust settings.

    4. Click Save and Continue.

    5. Under Verify and Connect Endpoints, do the following:

      1. For each endpoint, review the request and response bodies and add the relevant JSONPaths. In order for your endpoints to appear on this screen, you must first configure your chatbot's DNS server to send requests to the Verax Public API which can be found in your registration.

      2. Once configured, send a random DNS request for Verax to receive your endpoint information.

        1. Click the endpoint to open the request and response windows.

        2. Enter the Request JSONPath and Re

          ponse JSONPath.

        3. Review the JSONPaths’ Value for both the request and response.

        4. Click Path settings to add optional paths to improve analysis accuracy.

          1. Add the Message ID path to make it easier for Verax to locate chatbot messages within the JSON and therefore improve analysis. The Message ID usually appears as a key within the response body.

          2. Add the Conversation ID path to make it easier for Verax to locate chatbot conversations within the JSON and therefore improve analysis. The Conversation ID usually appears as a key within the response body.

          3. Add the Timestamp path to help you to improve timestep response accuracy in the Verax Control Center. The Timestamp usually appears as a key within the response body.

        5. Optionally, test your JSONPaths.

        6. If everything is correct, click Verify and save.

      3. The Verax Control Center shows a green checkbox next to a verified endpoint. Once all endpoints are verified, click Done.




        Learn more about Proxy Setup.

6. Create API Key

Use an API key if you want more control over how Verax accesses your data. Verax generates an API key that you can use to send your chatbot request/response data to Verax. The API key gives you programmatic access to Verax. The API key lets you avoid placing Verax between critical request/response interactions and helps you manage latency issues.

On the Create API Key screen:

  1. Enter any Name and Description and click Generate API key.

  2. Verax creates an API key for you. Click Download CSV and save the API key in a secure place, as you will not be able to see it after exiting the setup.

  3. Click Done.

  4. Add the Verax API key into your API code configured in such a way that it authenticates with Verax and then sends chatbot requests and responses in JSON Web Token (JWT) format to Verax.

    Learn more about API Keys.