Search engine setup

Setting up search engine in Faheem Code

Faheem Code can be configured to use Tavily as a search engine, which allows the agent to search the web for information when needed. This capability enhances the agent's ability to provide up-to-date information and solve problems that require external knowledge.

Note

Tavily is configured as a search engine by default in Faheem Code Cloud.

Getting a Tavily API key

To use the search functionality in Faheem Code, you'll need to obtain a Tavily API key:

1. Visit Tavily's website and sign up for an account.
2. Navigate to the API section in your dashboard.
3. Generate a new API key.
4. Copy the API key (it should start with tvly-).

Configuring search in Faheem Code

Once you have your Tavily API key, you can configure Faheem Code to use it:

In the Faheem Code UI

1. Open Faheem Code and navigate to the Settings > LLM page.
2. Enter your Tavily API key (starting with tvly-) in the Search API Key (Tavily) field.
3. Click Save to apply the changes.

Note

The search API key field is optional. If you don't provide a key, the search functionality will not be available to the agent.

Using configuration files

If you're running Faheem Code in headless mode or via CLI, you can configure the search API key in your configuration file:

# In your Faheem Code config file
[core]
search_api_key = "tvly-your-api-key-here"

How search works in Faheem Code

When the search engine is configured:

• The agent can decide to search the web when it needs external information.
• Search queries are sent to Tavily's API via Tavily's MCP server which includes a variety of tools (search, extract, crawl, map).
• Results are returned and incorporated into the agent's context.
• The agent can use this information to provide more accurate and up-to-date responses.

Limitations

• Search results depend on Tavily's coverage and freshness.
• Usage may be subject to Tavily's rate limits and pricing tiers.
• The agent will only search when it determines that external information is needed.

Troubleshooting

If you encounter issues with the search functionality:

• Verify that your API key is correct and active.
• Check that your API key starts with tvly-.
• Ensure you have an active internet connection.
• Check Tavily's status page for any service disruptions.