docs: add temp_dataset_name to community.BigQueryVectorStore docs #735
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @lkuligin this is ready for review. I see the integration tests have failed, although I would expect no change given that only the docs have changed. Please let me know if I need to recreate the PR. |
lkuligin
approved these changes
Feb 14, 2025
|
@cmenon12 thanks for your contribution! |
|
@lkuligin thank you very much! I think I've fixed the issue the linter found. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Added
temp_dataset_nameto the docstring forBigQueryVectorStore, and an explanation about how to use it to avoid needing permission to create datasets in GCP.This attribute is defined in
BaseBigQueryVectorStore, albeit without the additional explanation.Relevant issues
None.
Type
📖 Documentation
Changes(optional)
Testing(optional)
Note(optional)
In my environment I'm not allowed to create datasets, so was confused why
BigQueryVectorStoreasked for thebigquery.datasets.createpermission even though the dataset already existed. Digging into the source code I found thetemp_dataset_nameattribute, and specifying it as the name of a dataset that already existed stopped this class from asking for this permission.