Metaphor Tool

================================================================================

NOTE: Deprecated in favor of Exa Tool.

================================================================================

This tool connects to Metaphor to easily enable your agent to search and get HTML content from the Internet.

To begin, you need to obtain an API key on the Metaphor developer dashboard.

Usage

This tool has more a extensive example usage documented in a Jupyter notebook here

Here's an example usage of the MetaphorToolSpec.

python

from llama_index.tools.metaphor import MetaphorToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

metaphor_tool = MetaphorToolSpec(
    api_key="your-key",
)
agent = FunctionAgent(
    tools=metaphor_tool.to_tool_list(),
    llm=OpenAI(model="gpt-4.1"),
)

print(
    await agent.run(
        "Can you summarize the news published in the last month on superconductors"
    )
)

search: Search for a list of articles relating to a natural language query retrieve_documents: Retrieve a list of documents returned from metaphor_search. search_and_retrieve_documents: Combines search and retrieve_documents to directly return a list of documents related to a search find_similar: Find similar documents to a given URL. current_date: Utility for the Agent to get todays date

This loader is designed to be used as a way to load data as a Tool in a Agent.