llm-researcher 0.1.0

LLM plugin for comprehensive research using Jina AI's Search Foundation APIs

llm-jina-research

LLM plugin for comprehensive research using Jina AI's Search Foundation APIs

Installation

Install this plugin in the same environment as LLM:

llm install llm-jina-research

Set your Jina AI API key:

export JINA_API_KEY="your_api_key_here"

Get your Jina AI API key for free: https://jina.ai/?sui=apikey

Usage

Perform comprehensive research using Jina AI's APIs:

llm research "What are the latest advancements in AI safety?"

Options:

• query: The research question to investigate
• --output: Path to save results as JSON file

Features

• 🔍 Web search with relevance filtering
• 📥 Advanced content extraction with reader API
• 🧬 Query embedding generation
• 🔬 Document reranking based on relevance
• 📊 Interactive terminal report generation
• 📄 JSON output for programmatic use
• 📝 Automatic research session logging

Example

llm research "What are the latest advancements in AI safety?" --output results.json

This will:

1. Search the web for relevant information
2. Extract and process content from top results
3. Analyze and rank the content
4. Generate an interactive report
5. Save the results to a JSON file

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd llm-jina-research
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

Contributing

Contributions to llm-jina-research are welcome! Please refer to the GitHub repository for more information on how to contribute.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.