TransformerOptimus / SuperAGI

<⚡️> SuperAGI - A dev-first open source autonomous AI agent framework. Enabling developers to build, manage & run useful autonomous agents quickly and reliably.
https://superagi.com/
MIT License
15.22k stars 1.83k forks source link

is PINECONE_API_KEY required? / suggestions for comments in configuration files #246

Open ClaireCJS opened 1 year ago

ClaireCJS commented 1 year ago

Discussed in https://github.com/TransformerOptimus/SuperAGI/discussions/245

Originally posted by **ClaireCJS** June 7, 2023 Does it just use local storage otherwise? Can we put a comment into the config.yaml template answering this question so people won't have the question in the first place when editing the template? :) Perhaps these answers are elsewhere? I'm guessing the answer is no because there is a waitlist for new users currently which would mean most people couldn't jump into this project, but it would be nice for a comment to be there because I'm scared it is required and that i should just give up until the waitlist :) And I'm guessing the answer is no because STORAGE_TYPE below: is set to "FILE" * It would be nice if this file was more self-documenting, so everything people need to know about the file is in the file while editing file. - is YOUR_EMAIL_APP_PASSWORD required? - What is the pro/con of using GITHUB_OATH? - What is the pro/con of using S3 vs FILE storage? {I can guess, but someone else probably wants to know} - What is the advantage of getting a GOOGLE_API_KEY? I have one, but the file says "IF" you have an api key and CSE key, use this, which makes it sound not required. And I don't know what a CSE key is. - I can't figure out what a CSE key is, would be nice if the comment mentioned that, maybe a link to the site to grab one (like how EMAIL_PASSWORD has a very helpful link to myaccount.google.com/apppasswords) - Could use an example of what YOUR_DRAFTS_FOLDER should be set to, though I think it's intuitive. What might help would be to have some sample drafts in a sample folder and have the project already point to an existing (generic) set that we could the modify without having to figure out as much. [Basically, chamber our round so we can shoot our gun, right now it's feeling like having to learn how to work a bullet press, but that's just how I'm personally experiencing it because I'm more of a beginner with github.] - In the original setup instructions it says: "Google API key Create a project in the Google Cloud Console and enable the API you need (for example: Google Custom Search JSON API)." Could we just add a sentence or two about how we would know which APIs we need, or what some examples or, so that we can be inspired to have ideas in which direction to take this? I'm just installing this for curiosity, so I don't know which API i may or may not need. I think this would help more beginner users launch the project with more confidence and get farther in a happier and more-informed state. The right answers in the right places (not just the readme) can reallllly help speedup deployment p.s. this is my first-ever opened issue on github, be gentle 😅 -
AdamBLevine commented 1 year ago

I have many of these questions and would appreciate if these suggestions were taken action on by someone more competent than myself around a codebase.

luiscosio commented 1 year ago

Still have the same question with PINECONE,

I get this error in the terminal when it's not configured:

superagi-celery-1 | [2023-06-09 18:54:28,640: WARNING/ForkPoolWorker-7] Retrying (Retry(total=2, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f6c1e250ac0>: Failed to establish a new connection: [Errno -2] Name or service not known')': /databases From the README, it appears not needed.

UFGator56 commented 1 year ago

Pinecone is gone.

neelayan7 commented 1 year ago

We have removed the Pinecone dependency for now. And have added READMEs to all the Tools and Keys required. Does this solve your issue @ClaireCJS ? If you have any other questions, do let us know!

dceluis commented 1 year ago

image This still shows on the create agent page. Assuming it's outdated now?

Any interest for a PR to remove it from the UI?

neelayan7 commented 1 year ago

Agree. We'll remove this from the Front-End for now.