Skip to content
Nappai Documentation

Metaphor

This component, Metaphor, helps you find information on the web directly within your Nappai automation workflows. It uses the Metaphor API to search for information, retrieve website content, and find websites similar to a given URL.

Relationship with Metaphor API

Metaphor is built on top of the Metaphor API. This API allows us to access powerful web search and content retrieval capabilities. The component acts as a bridge, making it easy for you to use these capabilities within Nappai without needing to understand the technical details of the API.

Inputs

  • Credential: Your Metaphor API access key. This is essential for the component to work. You’ll need to obtain this key from your Metaphor account.
  • Use Autoprompt: (Default: On) If turned on, Metaphor will automatically refine your search queries to get better results. You can turn this off if you prefer to control your search terms precisely.
  • Search Number of Results: (Default: 5) Specifies how many search results you want Metaphor to return.
  • Similar Number of Results: (Default: 5) Specifies how many similar websites you want Metaphor to return when you ask it to find similar sites to a given URL.

Outputs

Metaphor doesn’t provide outputs as individual variables, but it offers three powerful functions:

  • Search: This function performs a web search based on your query and returns a list of results. You can then use these results in other parts of your Nappai workflow.
  • Get Contents: This function retrieves the actual content of a website given its ID (obtained from a previous search). This lets you extract specific information from web pages.
  • Find Similar: This function finds websites similar to a URL you provide. This is useful for finding related information or resources.

Usage Example

Let’s say you want to find articles about “AI in healthcare” and then extract the main points from the top result. You would:

  1. Provide your Metaphor API key in the “Credential” input.
  2. Enter “AI in healthcare” in the search query (this would be handled by another component feeding into Metaphor).
  3. Use the “Search” function to get a list of results.
  4. Use the ID of the top result with the “Get Contents” function to retrieve the article’s text.
  5. (Further processing with other Nappai components to extract main points would follow).

Templates

[List of templates where the component is used – This section needs to be populated with actual template names from your system.]

  • OpenAI Function Agent: Uses OpenAI’s language models to process the information retrieved by Metaphor.
  • ReAct Agent LLM: A Langchain agent that can interact with Metaphor and other tools to complete complex tasks.
  • [Other components]: [Add descriptions of other related components as needed]

Tips and Best Practices

  • Make sure you have a valid Metaphor API key.
  • Experiment with the “Use Autoprompt” setting to see if it improves your search results.
  • Adjust the “Search Number of Results” and “Similar Number of Results” settings to control the amount of data you receive.

Security Considerations

  • Protect your Metaphor API key: Treat your API key like a password. Do not share it publicly or commit it to version control.