Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Open Deep Research's README.md #763

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

keetrap
Copy link
Contributor

@keetrap keetrap commented Feb 24, 2025

Closes #760

## Notes

- Currently, this implementation only supports **OpenAI** models.
- Only **reasoning models** like `o1` are supported at this time. If you attempt to use a non-reasoning model, you may need to modify the script.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@keetrap if this is true we should fix it to work with any model (maybe just remove the reasoning_effort argument if it's passed, because it did not impact results)

Copy link
Contributor Author

@keetrap keetrap Feb 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aymeric-roucher Thanks for the review.
I am going to remove the Notes section.
Should we keep reasoning_effort as an command-line argument or remove it completely? What do you think?

keetrap and others added 2 commits February 25, 2025 15:26
Co-authored-by: Aymeric Roucher <69208727+aymeric-roucher@users.noreply.github.com>
@keetrap keetrap force-pushed the Deep_research_Readme branch from 93ecda3 to 64228b2 Compare February 26, 2025 11:57
Comment on lines +51 to +54
- **SerperAPI Key**: Open Deep Research uses SerperAPI for web browsing functionality.
```bash
export SERPER_API_KEY="your_serper_api_key_here"
```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some confusion regarding this because

Currently, we are passing the SERPAPI_API_KEY in the BROWSER_CONFIG as follows:

BROWSER_CONFIG = {
    "viewport_size": 1024 * 5,
    "downloads_folder": "downloads_folder",
    "request_kwargs": {
        "headers": {"User-Agent": user_agent},
        "timeout": 300,
    },
    "serpapi_key": os.getenv("SERPAPI_API_KEY"),
}

However, in the WEB_TOOLS, the GoogleSearchTool is using the serper provider, which requires the SERPER_API_KEY:

GoogleSearchTool(provider="serper")

This requires users to provide two different API keys. Is this intentional, or should we be using the same provider throughout?

@keetrap
Copy link
Contributor Author

keetrap commented Feb 27, 2025

@aymeric-roucher @albertvillanova
A gentle reminder to review this PR, as multiple issues are open related to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Usage instructions for Open Deep Research are incomplete
2 participants