grid-research

AI Research CLI Tool

Overview

The AI Research CLI Tool is a command-line interface designed to assist users in generating structured, tabular data for research purposes. By leveraging the Bing Web Search API and the GPT-4o model, this tool transforms raw research topics into organized data that can be easily exported and utilized.

Features

• AI-Suggested Column Headers: Automatically generate relevant column headers and descriptions for your research data.
• Custom Header Editing: Modify or create your own headers to suit your specific research needs.
• Data Generation: Generate between 1 to 100 rows of structured research data based on your queries.
• Beautiful Terminal Interface: Enjoy a visually appealing and user-friendly command-line interface.
• Export-Ready Data: Easily export the generated data in a structured format for further analysis.

Installation

To install the necessary dependencies, you can use the following command:

pip install -r requirements.txt

Usage

• Start the Application: Run the CLI tool from your terminal.

  python grid/cli.py
  

• Input Research Topic: When prompted, enter the topic you would like to research.

• Choose Header Creation Method:

  • Get AI Suggestions: Use the AI to generate suggested headers.
  • Create Manually: Input your own headers.

• Specify Number of Rows: Indicate how many rows of data you wish to generate.

• Data Generation: The tool will perform a web search using the Bing API and generate structured data based on the retrieved information.

• Export Data: The generated data will be returned in a pandas.DataFrame, ready for your use.

Requirements

• Python 3.8 or higher
• OpenAI API Key
• Bing Search API Key

Environment Variables

Make sure to set the following environment variables in your .env file:

OPENAI_API_KEY=your_openai_api_key
BING_SEARCH_V7_SUBSCRIPTION_KEY=your_bing_search_api_key

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

• OpenAI for providing the models.
• Bing Web Search API for enabling web search capabilities.