Skip to content
Nappai Documentation

SearchApi Tool

This tool lets you search in real-time using various search engines connected to Nappai. You can use it to quickly find information within your data and applications. The results are displayed directly in your Nappai dashboard.

Relationship with Search APIs

This component connects to various search engine APIs (like Google, Bing, etc., depending on your configuration). It sends your search requests to the chosen engine and displays the results neatly in your Nappai workflow. You’ll need to specify which search engine to use and provide the necessary credentials.

Inputs

  • Engine: Choose the search engine you want to use (e.g., Google, Bing).
  • Input: Type your search query here. You can use multiple lines if needed.
  • Search parameters: (Advanced) Use this to fine-tune your search. This allows for more specific search criteria (e.g., date range, specific keywords). This is optional and only needed for advanced searches.
  • Credential: This is where you provide the necessary access information (API key or similar) to connect to your chosen search engine. This is usually set up once and then saved.

Outputs

The tool returns a list of search results. Each result includes a short summary (snippet) to help you quickly understand its relevance. You can then use these results in other parts of your Nappai workflow.

Usage Example

Let’s say you want to find all documents related to “customer support” using the Google search engine.

  1. Select “Google” as the Engine.
  2. Type “customer support” in the Input field.
  3. (Optional) Add any advanced search parameters in the Search parameters field.
  4. Run the tool. You’ll see a list of search results, each with a snippet, displayed in your dashboard.

Templates

This component is used in the following Nappai templates: ‘Hierarchical Tasks Agent’, ‘Sequential Tasks Agent’, ‘Eurocup 2024’.

Many components can work with the SearchApi Tool’s output. For example:

  • OpenAI Function Agent: Use the search results to generate text summaries or other content.
  • ReAct Agent LLM: Integrate the search results into a larger reasoning process.
  • Other Agents and Tools: The search results can be used as input for many other Nappai components to further process or analyze the information. (See the full list of related components for more details).

Tips and Best Practices

  • Use specific keywords for better search results.
  • Experiment with the advanced search parameters to refine your searches.
  • Review the search results carefully to ensure they are relevant to your needs.

Security Considerations

Ensure you use strong and secure credentials for your chosen search engine. Never share your credentials with anyone. Nappai employs security measures to protect your data, but it’s crucial to maintain good security practices.