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

Updated SERP README.md #804

Merged
merged 3 commits into from
Jul 19, 2023
Merged

Updated SERP README.md #804

merged 3 commits into from
Jul 19, 2023

Conversation

Phoenix2809
Copy link
Contributor

Provided Instructions for serper.dev API key creation and configuring it in the Toolkit Page

Description

Related Issues

Solution and Design

Test Plan

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Docs update

Checklist

  • My pull request is atomic and focuses on a single change.
  • I have read the contributing guide and my code conforms to the guidelines.
  • I have documented my changes clearly and comprehensively.
  • I have added the required tests.

Provided Instructions for serper.dev API key creation and configuring it in the Toolkit Page
@Phoenix2809 Phoenix2809 changed the title Updated README.md Updated SERP README.md Jul 18, 2023
Copy link

@clappo143 clappo143 left a comment

Choose a reason for hiding this comment

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

This looks good (note that your account username appears in the new screenshot).

It might also be worth updating config_template.yaml, specifying that the API key for the SERP Search tool needs to be from https://serper.dev/ (there are multiple providers). Also, the way the comments/instructions read is a bit confusing – it suggests that users should either provide a key for Google-API/CSE or alternatively for SERP, but not both. The serper.dev key is arguably easier to obtain, but also, there is no reason why users cannot provide keys for both (and create agents with access to both tools).

Not sure if that makes sense, but here are the lines I'm referring to:

#If you have google api key and CSE key, use this
GOOGLE_API_KEY: YOUR_GOOGLE_API_KEY
SEARCH_ENGINE_ID: YOUR_SEARCH_ENIGNE_ID

# IF YOU DONT HAVE GOOGLE SEARCH KEY, USE THIS
SERP_API_KEY: YOUR_SERP_API_KEY

Updated Image
Modified Serp Configuration for SERPER
Copy link

@clappo143 clappo143 left a comment

Choose a reason for hiding this comment

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

Nice one

@Phoenix2809
Copy link
Contributor Author

@clappo143 Thanks for pointing it out. I have made the necessary changes in the Config_Template.yaml and the image as well.

Copy link
Collaborator

@neelayan7 neelayan7 left a comment

Choose a reason for hiding this comment

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

Looks good.

@neelayan7 neelayan7 merged commit 55cad10 into TransformerOptimus:main Jul 19, 2023
5 checks passed
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.

3 participants