auto_research.applications.surveys module

topic_to_survey(num_results=30, sort_by='relevance', date_cutoff='2024-12-01', score_threshold=0.5, destination_folder='papers', model='gpt-4o-mini', api_key_path='../', api_key_type='OpenAI', organize_files=True, order_by_score=True, zip_folder=True, api_key=None)[source]

Conducts an automated research process based on the provided topic and settings.

Parameters:

  • num_results (int) – Number of search results to retrieve. Defaults to 30.

  • sort_by (str) – Sorting criteria for search results. Defaults to “relevance”.

  • date_cutoff (str) – Cutoff date for search results. Defaults to “2024-12-01”.

  • score_threshold (float) – Minimum score threshold for articles. Defaults to 0.5.

  • destination_folder (str) – Folder to store downloaded articles. Defaults to “papers”.

  • model (str) – Model to use for summarization and keyword suggestions. Defaults to “gpt-4o-mini”.

  • api_key_path (str) – Path to the directory containing the API key. Defaults to “../”.

  • api_key_type (str) – Type of API key to retrieve. Defaults to “OpenAI”.

  • organize_files (bool) – Whether to organize the downloaded articles. Defaults to True.

  • order_by_score (bool) – Whether to order articles by their score. Defaults to True.

  • zip_folder (bool) – Whether to zip the organized folder. Defaults to True.

  • api_key (str | None) – Directly provide the API key as a string. If None, the key will be retrieved from

  • None. (the file. Defaults to)

Return type:

None

Example

>>> topic_to_survey(api_key="your_api_key_here")