agents.research.open_perplexity.cli¶
CLI tool for running the open_perplexity research agent.
This module provides command-line utilities for running research tasks and visualizing research states. It supports loading research questions from text files, configuring research parameters, and generating reports.
Functions¶
|
CLI entry point for the research tool. |
|
Run a research process on text from the specified file. |
|
Visualize a specific state from a saved state history file. |
Module Contents¶
- agents.research.open_perplexity.cli.main()¶
CLI entry point for the research tool.
Parses command-line arguments and executes the appropriate command based on user input.
- Return type:
None
- agents.research.open_perplexity.cli.run_research(text_path, **kwargs)¶
Run a research process on text from the specified file.
Loads a research question from a text file, configures a research agent with the specified parameters, runs the research process, and saves the results.
- Parameters:
text_path (str) – Path to a text file containing research question
**kwargs – Additional arguments to pass to the agent, including: - output: Path to save the generated report - save_state_path: Path to save the state history - depth: Research depth (1-5) - concurrent_searches: Number of concurrent searches - max_sources: Maximum sources per query - vector_store_path: Path for the vector store
- Return type:
None
- agents.research.open_perplexity.cli.visualize_state(state_path, step=None, output_md=None)¶
Visualize a specific state from a saved state history file.
Loads a state from a saved state history file, displays a visualization of the research state, and optionally generates a markdown report.