docs: clarify PointStruct usage for IDs in README example#1147
Open
uahroberto wants to merge 1 commit intoqdrant:masterfrom
Open
docs: clarify PointStruct usage for IDs in README example#1147uahroberto wants to merge 1 commit intoqdrant:masterfrom
uahroberto wants to merge 1 commit intoqdrant:masterfrom
Conversation
✅ Deploy Preview for poetic-froyo-8baba7 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe README.md file was updated with a single-line inline comment added to the upsert points code example. The comment clarifies the use of PointStruct for strict typing and notes that point IDs can be integers or strings (UUIDs). This is a purely documentation-focused change with no behavioral or logic modifications. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or 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
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.
Description
This PR updates the "Insert vectors into a collection" example in the README to explicitly clarify the usage of
PointStruct.Motivation:
Users (as seen in issue #1141) are encountering
ImportErrorwhen trying to import internal classes likePointIdto handle custom IDs (UUIDs). This update adds a comment to the code snippet clarifying thatPointStructhandles ID types automatically, promoting best practices and preventing confusion.Changes:
client.upsertexample inREADME.md.Closes #1141
All Submissions:
devbranch. Did you create your branch fromdev?