AI-Powered Virtual Search Assistant

The AI-Powered Virtual Search Assistant feature is in its Beta version and only available with QTM Cloud edition.

Introduction

QTM provides an AI-powered virtual search assistant which is a sophisticated feature. It leverages artificial intelligence (AI) to enhance the search experience for users. This search assistant is designed to make the search more user-friendly. The feature enables users to express their search queries more conversationally, which improves the overall search experience. Hence, it empowers users to learn on the fly and assists them in asking questions and obtaining answers which results in increased product adaptability.

QTM allows a quick and efficient search to access information available within the QTM Product Help documentation and the Project Documentation that is configured by users to access the personalized knowledge base. The multiple levels of search give users the flexibility to choose the source from which they need to seek the information.

Users can ask questions about QMetry product features and receive real-time answers from the product user guide. The revolutionary QMetry Intelligence (QI) search explains features in a summarized format, provides best practices from the extensive knowledge base, and expertly navigates troubleshooting challenges.

It is vital to provide testing teams with seamless access to project-specific documentation that enables on-the-go learning, thereby enhancing the efficiency of their testing processes. QMetry facilitates this by allowing administrators to upload project-specific documents in various formats, including PDFs, Confluence spaces, and web URLs.

Testers can then utilize QMetry's AI-powered product search to find answers and necessary information from these documents for their testing needs.

Notes:

  • The search only supports English language, for questions asked in other languages, answers are not assured to be correct.

  • This is an AI-based search capability, hence, we recommend you initiate your search with a proper query rather than searching with just keywords to get proper search results.

  • The search mechanism won’t be doing any spelling correction in the search text that you provided.

  • In case you are configuring the project documentation, the process will take some time to finish. The AI Search feature will not be available during this time.

 

Prerequisite: Users should have a valid account on the OpenAI Platform with sufficient balance to access this AI-powered search feature.

QMetry Intelligence Configuration

These are the settings for the QTM instance. To activate the QI search feature for QMetry users, the QTM super administrator needs to enable it for the QMetry instance from Customization > General Settings & Audit > QI Configuration.

→ Required Permission: Only the QMetry super admin can access and configure QMetry Intelligence Configuration under Customization > General Settings & Audit > QI Configuration

Customization > General Settings & Audit > QI Configuration

QI Configuration > Search: Ask me Anything (Default: Disabled)

Settings

Description

Enabled

Users can access the AI-enabled search feature to search text in the QTM help and FAQ documentation.

Project Administrator and users with the QMetry Intelligent Search “Modify” permissions can configure the project-specific documentation for AI search.

Disabled

Users can not access the AI-enabled search feature to search text in the QTM help and FAQ documentation.

Steps

1. Go to Customization > General Settings & Audit.

2. Open the QI Configurations tab.

A. OpenAI API Configuration

→ API Key: Provide the API Key that you generated from the OpenAI platform. Follow the link for more details on creating an API Key.

You can enable the QA feature only after providing the valid API Key above.

B. Enable/Disable QI features for the Projects: The QTM super admin can enable or disable the QI feature for the projects on the instance. Enable this option first, then you can opt to enable the sub-options under it.

C. Search: Ask me anything: Enable the Search: Ask me anything option to activate the AI-powered search in the QTM modules. Enabling this feature will allow all users to search text in QTM help and FAQ documentation.

D. Enable configuration of documentation links for the Projects: Enable the option to allow users with the QMetry Intelligent Search “Modify” permissions to configure the project-specific documentation for AI search. In addition to the product help documentation, this feature will allow users to configure the documents personalized for the project.

image-20240208-071004.png

Project Documentation Configuration

Project Administrators can configure their personalized documentation or knowledge base specific to the project. If configured, all the users would have the option to select the configured documentation as a source to search for the required information in addition to the product help documentation.

→ Prerequisite: Project Administrators can configure the Project Documentation if the optionEnable configuration of documentation links for the Projects” is enabled in Customization > General Settings & Audit > QI Configuration.

Required Permissions:

  • If the Customization package is available on the QMetry instance:

Project Admins and users with the QMetry Intelligent Search “Modify” permissions can configure the settings for Project Documentation. Users with only “View” rights can just view the configuration.

  • If the Customization package is not available on the QMetry instance:

Users with the Admin and QA Manager roles can access and configure the settings for Project Documentation. Users with other roles can only view the configuration.

Enable the project-specific documentation search (Default: Disabled)

Settings

Description

Disabled

Only the QMetry super admin and QA Manager can configure the project documentation.

Enabled

Once the project-specific documentation search is enabled, the users with the QMetry Intelligent Search “Modify” permission can also modify the configuration.

 

Steps

1. Go to QMetry Intelligence > Search - Ask me anything.

image-20240124-082247.png

2. Enable the Enable the project-specific documentation search option. (Default: Disabled)

Configure URL/Documentation Files

  • Project Admin can configure the documentation link or upload documents in the format of Word (docx) and PDF.

  • Multiple Confluence Spaces (i.e., documentation links) can be configured with a single project.

  • Make sure the Confluence Space is publicly published and not a private one so that all the users who are accessing the feature can view the required information easily. Refresh the content after adding the URL.

  • Along with the publicly published Confluence space, you can also upload multiple documents in Word (docx) and PDF formats. Refresh the content after uploading the documents.

    • Notes:

      • The file (Word/PDF) with a maximum of 25 MB size can be uploaded.

      • Refresh the content once you upload the Confluence URL or documents. The QI Search functionality will not be available during the process.

On clicking on the Refresh Content option, the confirmation message pops up. Read the instructions carefully.

Then click on the Refresh Content button to proceed.

Access the Search Feature

In addition to the normal project search of entities, QMetry Intelligent Search enables you to initiate the search within QTM help documentation and also allows you to configure project-specific documentation in the form of documents and links.

A. Project Search: Search by keyword in Entity Key, Summary, Description, and Test Step. This search option is available by default. Users do not have to do any configuration for it.

QMetry Intelligent Search

Once you enable the Search: Ask me anything feature in Customization > General Settings & Audit > QI Configuration, the QMetry Intelligent Search section will be visible on the Search menu. The QTM help documentation is configured as a source by default, from where you can search for the required information.

B. Project Documents: The option is visible when you turn the Enable configuration of documentation links for the Projects feature "ON" under Customization > General Settings & Audit > QI Configuration. The project administrator can configure the project-specific documentation in addition to the default available QTM help documentation.

C. QMetry User Guide: The option is visible when you enable the Search: Ask me Anything feature under Customization > General Settings & Audit > QI Configuration.

Steps

1. Log into QMetry Test Management.

2. You can access the AI-powered Search feature by clicking on the QI - Ask me anything search box provided on the header of the application.

3. Open the drop-down and select the Source documentation from where you want to search for the required information.

  • Project Documents: The document you configured from QMetry Intelligence > Search: Ask me Anything > Configuration tab. This option is available only when the Enable the project-specific documentation search option is turned ON.

  • QMetry User Guide: The QTM User Guide is configured by default. You can access information from the guide without doing any configuration.

4. Search Text: Once you select the Source from the drop-down list, enter the search text in the search box. Then either press ENTER on the keyboard or click on the Search icon.

The search result will give you the information that you are looking for with the source link so that you can navigate to the page for more details.

Note: When the search does not find the data relevant to the asked question in the QMetry User Guide, the source link will be displayed blank. The answer displayed on the screen is generated from the trained data in Open AI.

You can see the list of previously asked questions in the search box.

If you want to search for the same question again, select the question from the list and press ENTER on the keyboard or click on the Search icon to get the latest search results. Just clicking on the previously asked question will return the historical search results only.

Modify Configuration

If you want to make any changes to the configuration of project documentation, click on the Configuration button on the Search panel.

Prerequisite: To modify the configuration of Project documentation, the users should have the QMetry Intelligence Search “Modify” permissions.

It will take you to the Search: Ask Me Anything Configuration screen under the QMetry Intelligence module if you have the required permissions.

 

Refresh Content

Click on the Refresh Content option to keep the search results updated with the latest documentation changes.

Unlink Project Documents

You can remove the configured project documentation if it is no longer required.

Steps

1. To delete/unlink the configured documentation for the project, select the attached document.

2. Click on the Delete Select button above.

To delete multiple documents at a time, select multiple documents and click on the Delete Selected button.

The warning message appears.

To delete the configuration of the documentation with the project, click on the Delete & Refresh Content button.