Tavily icon

Tavily

Tavily API

Overview

This node creates a research task based on a user-provided question or topic. It is designed to generate detailed research reports using different models optimized for various research scopes, such as targeted or comprehensive analysis. The node supports citation formatting and can structure the output according to a user-defined JSON schema. It also offers an option to stream results in real-time, providing incremental updates as the research progresses. This node is useful for automating research tasks, gathering information on complex topics, and generating formatted reports with citations.

Use Case Examples

  1. A user inputs a question about the latest developments in artificial intelligence and receives a detailed research report with citations formatted in APA style.
  2. A user requests a comprehensive multi-angle research report on climate change using the 'Pro' model, with output structured to a specific JSON schema for integration into another system.
  3. A user enables streaming to get real-time updates on a research task about market trends, allowing them to monitor progress as data is gathered.

Properties

Name Meaning
Input The research task or question to investigate, provided as a string input.
Model The model used by the research agent to perform the research, with options for automatic selection, targeted efficient research (Mini), or comprehensive multi-angle research (Pro).
Citation Format The format for citations in the research report, with options including APA, Chicago, MLA, and Numbered.
Output Schema A JSON Schema object defining the structure of the research output. When provided, the research response is structured to match this schema.
Stream A boolean option to enable streaming of research results as they are generated, returning Server-Sent Events (SSE) with real-time progress updates, tool calls, and incremental results.

Output

JSON

  • researchReport - The generated research report content based on the input question and selected options.
  • citations - Formatted citations included in the research report according to the selected citation format.
  • progress - If streaming is enabled, incremental progress updates and partial results during the research process.

Dependencies

  • An API key credential for accessing the research service backend.

Troubleshooting

  • Ensure the input question is clear and well-defined to get accurate research results.
  • If streaming is enabled but no updates are received, check network connectivity and server support for Server-Sent Events (SSE).
  • Invalid JSON schema in the Output Schema property may cause errors or unexpected output formatting; validate the schema before use.

Discussion