Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Configuring the Voice Search Assistant

    Return to menu

    The Voice Search Assistant enables users to enter search terms using their device's microphone. After selecting the Microphone icon, users can begin speaking search terms or select a different language for the system to detect. If no input is detected for 10 seconds, the system provides a message and then prompts the user to provide audio input two more times before timing out and exiting the voice search assistant. If audio is detected, Primo will display the relevant search results.


    Voice Search Icon
    • This feature is available for all browsers that support the Speech Recognition interface of the Web Speech API (such as Chrome for Desktop and Android browsers and Samsung browsers). It will be progressively available in other browsers as they support the Web Speech API.

    • Because Safari does not support speech-to-text functionality, users can alternatively activate dictation ( or enable Siri in Safari's settings.

    • If additional language-detection support is needed, please contact Ex Libris Support.

    Configuration Options

    This feature is enabled by default. The following table lists the settings used to configure this functionality.

    Element Description

    View Configuration page (Configuration Menu > Discovery > Display Configuration > Configure Views)

    Select the Use Voice Search option to enable/disable this functionality. By default, it is enabled for you.  After selecting this option, select one of the following options from the drop-down list:

    • Use UI supported languages – When selected, Primo VE supports the languages configured in Alma.

    • Use customized languages – When selected, the Supported languages field appears and enables you to select one or more enabled languages from the Voice Search Supported Languages code table.

      • Customized languages cannot be arranged in a specific order.

      • The default language is not given priority for voice search unless the Use UI Supported Languages option has been selected.

    Voice Search Labels code table

    The following codes support the tooltips, labels, and messages associated with this functionality:

    • nui.voice_search.tooltip: Search by voice

    • nui.voice_listening: Listening

    • nui.voice_didntGetIt: Didn’t get it, try again

    • nui.voice_didntGetItCheck: Didn’t get it – please check your microphone

    • nui.voice_language: Voice search language

    • nui.voice_searching: Searching for:

    Aria Labels code table

    The following codes support accessibility for the tooltips, labels, and messages associated with this functionality:

    • Open voice search

    • nui.aria.voiceSearch.close: Close voice search

    • nui.aria.voiceSearch.changeLanguage: Change voice search language

    • nui.aria.voiceSearch.voiceSearch.closed: Voice search closed

    • nui.aria.voiceSearch.voiceSearch.Listening: System is listening; Please say your search keywords

    Voice Search Supported Languages code table

    This table enables you to customize and translate the customized list of languages, which appear in the Language drop-down list for Voice Search if added to the Supported languages field on the View Configuration page. 

    The codes and languages are based on the supported languages for the Voice Search Languages API. For more details, see Supported Languages from GitHub.

    Analytics - Voice Search

    The following actions were added to the Action Usage subject area:

    Group Subgroup Action Description


    Voice Search

    Voice Search

    Voice search was invoked.

    Voice Search – didn’t get it

    User input was not detected in the first attempt.

    Voice Search - Didn’t get it, please check your microphone

    User input was not detected in the second attempt. Please check your microphone.

    Voice Search – exit

    User selected X to abort the voice request.

    Change voice Language

    User changed the voice-detection language.

    • Was this article helpful?