Tavily Tool

Javapackage: com.etendoerp.copilot.toolpack

Overview

The TavilySearchTool is a custom tool designed to perform searches using the Tavily search engine, which is known for allowing users to search the Internet for various types of information.

Info

To be able to include this functionality, the Copilot Extensions Bundle must be installed. To do that, follow the instructions from the marketplace: Copilot Extensions Bundle. For more information about the available versions, core compatibility and new features, visit Copilot Extensions - Release notes.

Configuration

Tavily API key Configuration

Visit the Tavily website and sign up for an account.
Once logged in, navigate to the API key section of your account.
Generate a new API key.
It is necessary to add the gradle.properties file with the following configuration:
gradle.properties
```
TAVILY_API_KEY=<your_api_key_here>
```
Restart Copilot service
terminal
```
./gradlew resources.down resources.up
```

Functionality

This tool is used to interface with the Tavily search engine and retrieve search results for a given query.

Everytime this tool is called, the parameter to use is a JSON like:

{ "query": "What is the capital of Spain?" }