Settings

  • 5 minute(s) read
Prev Next

1. Introduction

Use the Settings menu to manage users, proxy settings, and API keys.

2. General

The General page lets you set a variety of general settings.

Request classifier

Toggle the Request classifier to identify and filter casual, non-business conversations in chatbot interactions by recognizing greetings, small talk, jokes, and off-topic discussions.

When toggled, Verax adds classifier tags to all requests.

Business interactions are classified as such.

Casual, non-business interactions are classified by category, such as pleasantries, greetings, emotions, small-talk, random talk, weather, farewell, etc.


3. User Management

The User Management page lets you add, delete, and edit users.

Add a New User

Add a new user under Settings > User Management.

To add a new user, click Add user on the top right.



The Add New User dialog appears. Fill out the fields and then click Save. Click Save and add another to add multiple users. You can only add one user at a time.

  • Email

  • First Name

  • Last Name

  • Password

    • The password must abide by the following guidelines:

      • At least 8 characters

      • 1 lower case character

      • 1 upper case character

      • 1 special character

      • 1 number

Edit Existing Users

To edit an existing user, click the three dots to the right of the user.

Currently the only option available is Reset password but more options will be added in the future.

To reset a users’s password, click Reset password. Enter the New password and click Reset password.

Delete a User

To delete an existing user, click the three dots to the right of the user and choose Delete.

The user will be removed from the system and will no longer have access to the Verax Control Center. Click Delete.

4. Proxy Settings

The Proxy Settings tab lets you configure new proxy settings to connect to Verax via a proxy or to edit existing proxy settings.

Configure New Proxy Settings

To configure new proxy settings to connect to Verax via a proxy, do the following:

  1. Click on Proxy settings.

  2. Click Set proxy settings.  

  3. Under Proxy Settings, do the following:

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

    2. 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. Under Endpoints, do the following:

    1. 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.

      3. 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.

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

    2. For each endpoint, review the request and response bodies and add the relevant JSONPaths.

      1. Review the JSONPaths’ Value prior to proceeding.

    3. 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. Click Save.

Edit Existing Proxy Settings

To edit existing proxy settings to connect to Verax via a proxy, click Reset proxy settings.

Note: This will reset all proxy settings and disconnect your proxy connection from Verax. The Verax Control Center won’t show any new interactions after reset.

4. API Keys

The API Keys tab lets you add new API keys to connect to Verax via a API or to edit existing API keys.

Create New API Key

To create a new API key to connect to Verax via an API, follow these steps:

  1. Navigate to the Settings > API Keys tab.

  2. Click Create API key.  

     

  3. Add a Name and Description and click Create key.

     

  4.   The API key is created. Click Download CSV to save the key data. Ensure that you save the key data, as you will not be able to see it later.

Use the API Key to Sent Interactios to Verax

After creating an API key, you need to configure the API key to send interactions to Verax within your internal systems.

The following script is an example of a Python-based API key configuration:

import requests
import json

# Define base URL
base_url = "https://34.29.50.103:3000/api/v1" 

# Step 1: Login to get JWT token
login_url = f"{base_url}/auth/login"
login_payload = {
    "api_key_name": "my_key", # replace with your API key name  
    "api_key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" # replace with your API key
}

try:
    login_response = requests.post(login_url, json=login_payload)
    login_response.raise_for_status()  # Raise an error for bad HTTP response
    jwt_token = login_response.json().get('accessToken') 
    if not jwt_token:
        raise ValueError("JWT token not found in response.")
except Exception as e:
    print(f"Login request failed: {e}")
    exit()

print(f"JWT Token: {jwt_token}")

# Step 2: Use the JWT token to send interaction request
interaction_url = f"{base_url}/interaction"
interaction_payload = {
    "request": "How can I access professional development resources?",
    "response": "Contact HR to learn about available professional development resources and programs that you are eligible to participate in.",
    "timestamp": "2024-09-15T05:34:13.000Z"
}

headers = {
    "Authorization": f"Bearer {jwt_token}",  # Include the token in Authorization header
    "Content-Type": "application/json"
}

try:
    interaction_response = requests.post(interaction_url, json=interaction_payload, headers=headers)
    interaction_response.raise_for_status()
    interaction_result = interaction_response.json()
    print("Response:", json.dumps(interaction_result))
except Exception as e:
    print(f"Interaction request failed: {e}")

Edit Existing API Key

To edit an existing API key used to connect to Verax via a API, follow these steps:

  1. Click on the three dots to the right of the key and click Edit key.  

  2. Edit the key description and click Save changes.


Rotate API Key

To rotate existing API keys used to connect to Verax via a API, follow these steps:

  1. Click on the three dots to the right of the key and click Rotate key.
     

  2.  Click Rotate key to confirm.

     

  3. A new API key is created.  Click Download CSV to save the key data. Ensure that you save the key data, as you will not be able to see it later. Ensure that you recommend your system to the Verax Control Center with the new API key, as the old key will no longer work.