Add a search retrieval to an AI agent

  • Release version: Zurich
  • Updated July 31, 2025
  • 3 minutes to read

    • Add a search retrieval to an AI agent in AI Agent Studio. Leveraging the Retrieval-Augmented Generation (RAG) enables an AI agent to retrieve and incorporate relevant information from an external source.

    Before you begin

    Role required: sn_aia.admin

    Procedure

    1. Navigate to All > AI Agent Studio > Create and manage > AI agents.
    2. Open the AI agent that you want to add a search retrieval to and navigate to the Add tools and information section.
    3. In the Add tool drop-down list, select Search retrieval.
    4. On the form, fill in the fields.
      Table 1. Add search retrieval form
      Fields Description
      Select a type of record operation to add If you select An existing one, you can select a record operation tool used by the current AI agent or any other AI agent. You can make changes to the settings of that tool to fit the needs of your specific AI agent.
      Name

      Name that you want to specify for your search retrieval tool.
      Description Description of the search retrieval tool and what it's going to do to assist your AI agent.
      Note:
      This description is sent to the large language model (LLM).
      Search profile

      Name of the search profile that you want to add to your RAG-based tool from the list. To learn more about a search profile, see Search profiles in AI Search.
      Search sources One or multiple sources that you want to add to your search profile. To learn more about the search sources, see Search profiles in AI Search.
      Fields returned One or multiple fields that you want your search profile to return from the search sources.
      Results limit Number of records to be retrieved from the defined search source. The default value is 10.
      Search criteria Type of search that needs to be used:
      • Semantic: This search is carried out with the logical meaning of the search query.
      • Keyword: This search is carried out with the defined keywords.
      • Hybrid: This search is a combination of both keyword and semantic searches.
      Semantic indexes Fields on the source table that are indexed for a semantic search.
      Note:
      Semantic indexed fields are required if the search criteria are semantic or hybrid.
      Document matching threshold Cosine similarity score between 0 and 1 (exclusive). Default value is 0. The higher the number, the more variation in search results.
      Execution mode Mode of execution for your search retrieval tool:
      • Supervised: Inputs from your human agent are required during the execution of this tool while the AI agent runs.
      • Autonomous: Doesn't require any input from your live agent during the execution of this tool while the AI agent runs.
      Display output Permission to display the output of the tool execution in the Now Assist panel or in Virtual Agent:
      • Yes
      • No
      If you want the AI agent to work in Off Glide architecture with Premium Chat experience, you must turn-on the Display output toggle. When the toggle is turned-on, you can add widgets that can be used in assistants built with Premium Chat experiences. The widget configuration includes:
      • Widget: Defines the display output to render the content in a better user experience. You can select the widget from the drop-down.
      • Require widget transformation: An additional LLM call is required to transform the raw tool. If you choose to skip this transformation step, the tool output will be directly mapped to the widget.
        • Yes
        • No
      • Display refined widget message: Refines the widget message when configured.
        • Yes
        • No
      Note:
      The display output as a toggle is exclusively available for the Premium Chat experience when the Off Glide Conversation Server plugin (com.glide.cs.offglide) is installed. If the plugin is not installed, you will continue to access the standard display output options.
      Advanced settings
      Select an output transformation format Style for the LLM to present the results as it passes information between tools and to other agents. Out transformation formats:
      • None
      • Concise
      • Paragraph
      • Summary
      • Custom
      Write processing messages for users Message to display to users during tool execution.
      • In-progress message: Write an in-progress message to be displayed to end-users while the tool is running.
      • Completion message: Write a completion message to be displayed to end-users once the tool finishes running.
    5. Select Add.
      A search retrieval tool is added in the Search retrievals section on the Add tools and information page.