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

Semantic retriever docs say OAuth is required but this is not completely true #366

Open
roschler opened this issue Apr 5, 2024 · 0 comments
Labels
component:documentation Update docs status:triaged Issue/PR triaged to the corresponding sub-team type:help Support-related issues

Comments

@roschler
Copy link

roschler commented Apr 5, 2024

The main docs page for the semantic retrieval API says that OAuth must be set up to use that API:

https://ai.google.dev/docs/semantic_retriever?hl=en#attributed_question-answering

"The Semantic Retriever API lets you perform semantic search on your own data. Since it's your data, this needs stricter access controls than API keys. Authenticate with OAuth with service accounts or through your user credentials."

This is misleading because if you use the Attributed Question-Answer model, and you use inline grounding attributions, you don't need to authenticate with OAuth. I know this because I am using that powerful technique right now in running code.

Apparently the OAuth requirement is for when you use your own corpora built from your own files, because the API needs access to your private resources to execute the API call. But with inline grounding attributions you are passing in the necessary source material along with the API call, so the API does not need access to your private files. I suggest that the docs be updated to alter that paragraph above and have it point out that OAuth is only required when using your own files, not when using inline grounding attributions.

@singhniraj08 singhniraj08 transferred this issue from google-gemini/generative-ai-js Apr 15, 2024
@singhniraj08 singhniraj08 added status:triaged Issue/PR triaged to the corresponding sub-team component:documentation Update docs type:help Support-related issues labels Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:documentation Update docs status:triaged Issue/PR triaged to the corresponding sub-team type:help Support-related issues
Projects
None yet
Development

No branches or pull requests

2 participants