Back to QMetry All Products Help Page
AI-powered Search
QTM4J provides an AI-powered virtual search assistance which is a sophisticated feature. It leverages artificial intelligence (AI) to enhance the search experience for users. This search assistance 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.
QTM4J allows a quick and efficient search to access information available within the QTM4J 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
This is a global setting for the QTM4J instance. To activate the QI search feature for QMetry users, the Jira administrator needs to enable it for the Jira instance from the QTM4J app global settings.
→ Required Permission: Jira Admin or Jira users with the “Administer Projects” and “Browse Projects” permissions can configure QMetry Intelligence Configuration.
QMetry Intelligence > Search: Ask me Anything (Default: Disabled)
Settings | Description |
Enabled | Users can access the AI-enabled search feature to search text in QTM4J help and FAQ documentation. Project Administrator can also configure project documentation with the project. |
Disabled | Users can not access the AI-enabled search feature to search text in QTM4J help and FAQ documentation. |
Steps
1. Go to Apps > QTM4J > Global Settings. > QMetry Intelligence > Search: Ask me Anything.
2. Select the AI Configuration section.
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 Search: Ask me anything feature only after providing the valid API Key above.
B. Enable the Search: Ask me anything feature in QTM4J modules. Enabling this feature will allow all users to search text in QTM4J help and FAQ documentation.
C. Allow project administrators to configure the project-specific documentation for AI search. In addition to the product help documentation, this feature will allow the project admin to configure the documents personalized for the project.
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 option “Allow project administrators to configure the project-specific documentation for AI search” is enabled in Apps > Manage your apps > QI Configuration.
→ Required Permission: To modify the configuration of Project documentation, the users should have the Modify the Search configuration for “Ask me Anything” permissions in the QMetry Intelligence section.
QMetry Intelligence > Allow project administrators to configure the project-specific documentation for AI search. (Default: Disabled)
Settings | Description |
Disabled | Only the Project Admin can configure the project documentation. |
Enabled | Once the project specific documentation search is enabled, the users with the permission Modify the Search configuration for “Ask me Anything” can also modify the configuration. |
Steps
1. Go to Apps > QMetry > QMetry Intelligence.
2. Enable the Enable the project-specific documentation search option.
Configure URL/Documentation Files
Project Admin can configure the Confluence documentation link or upload documents in the format of 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 PDF formats. Refresh the content after uploading the documents.
Notes:
The file (PDF) with a maximum of 25 MB size can be uploaded.
Refresh the content once you upload the Confluence URL or documents.
Duplicate copies of the same document shall not be uploaded in a project as it may lead to ambiguous answers from the model.
Access the Search Feature
Once the Search feature is enabled in the global settings of QI Configuration, the Search icon will be visible in the application. The QTM4J help documentation is configured as a source by default, from where you can search for the required information.
The project administrator can configure the project-specific documentation in addition to the default available QTM4J help documentation.
→ Prerequisite: The Search: Ask me anything feature should be enabled in Apps > Manage your apps > QI Configuration.
Steps
1. Go to the Test Management section.
2. You can access the AI-powered Search feature by clicking on the Search icon provided on the home page of all the modules.
3. Select the Source documentation from where you want to search for the required information.
QMetry User Guide: The QTM4J User Guide is configured by default. You can access information from the guide without doing any configuration.
Project Documentation: 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.
If you want to make any changes to the configuration of project documentation, click on the Configuration button.
4. Search Text: Once you select the Source from the drop-down list, enter the search text in the search box and press ENTER on the keyboard.
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 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, click on the Configure button on the Search panel.
→ Prerequisite: To modify the configuration of Project documentation, the users should have the Modify the Search configuration for “Ask me Anything” permissions in the QMetry Intelligence section.
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 unlink the configured documentation for the project, select the attached document and click on the Delete button above. To delete multiple documents at a time, select the multiple documents and click on the Delete button.
The warning message appears.
The Delete action will permanently delete the file/confluence URL attached to this project.
The deleting and refreshing of the content process takes time in accordance with the size of the documentation. During the refresh operation, the QI Search functionality will not be available.
2. To delete the configuration of the documentation with the project, click on the Delete & Refresh Content button.
Back to QMetry All Products Help Page