google / google/generative-ai-docs

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

Open
#366 0 comments 0 reactions 0 assignees View on GitHub
component:documentation status:triaged type:help
Dominant language
Jupyter Notebook
Stars
2.3k
Forks
735
PR merge metrics
No merged PRs in 30d

Description

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](https://ai.google.dev/docs/semantic_retriever?hl=en#scrollTo=eLjhFIOQ7_Dk) or through your [user credentials](https://ai.google.dev/docs/semantic_retriever?hl=en#scrollTo=9YGv4x9ehLba)."

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`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.