Add a web search to an AI agent

  • Release version: Xanadu
  • Updated February 10, 2025
  • 1 minute to read

    • Add a web search to an AI agent in AI Agent Studio using a third-party search API such as Microsoft Bing or Google.

    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 web search to and navigate to the Add tools and information section.
    3. In the Add tool drop-down list, select Web search.
    4. On the form, fill in the fields.
      Table 1. Add a web search
      Fields Description
      Name

      Name that you want to specify for your web search.
      Resource Resource for the web search.
      Provider Third-party search API provider.
      Note:
      You can configure the default provider for the Web Search API capability on the OneExtend Definition Config table [sys_one_extend_definition_config].
      Inputs Information for the search API to include in the web search. You can select value overrides or leave them blank for generative AI to fill in the details for you.
      • Country: Country where results come from.
      • Max tokens: Maximum number of tokens to include in the response.
      • Number of results: Total number of results acquired.
      • Search query: Value to search for
      • Sites or domains: Websites where you want to search.
      Note:
      If the agent uses multiple tools, you can choose to use another tool's output as an input value override. Select the data picker icon (Data picker icon.) to review the available options.
      Execution mode Mode of execution for your selected web search:
      • Supervised: Inputs from your live 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 execution in the Now Assist panel or in Virtual Agent:
      • Yes
      • No
      Processing message Message to display to users when the tool is running.
      Output transformation strategy Style for the LLM to present the results.
      • None
      • Concise
      • Paragraph
      • Verbose
    5. Select Add.
      A web search is added in the Web search list on the Add tools and information page.