Open
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates v0.16.x documentation to reflect that query result distance is not always returned and is controlled by include, and records the change in the release notes.
Changes:
- Document
distanceas an optional query result field (controlled byinclude) across Python SDK docs. - Update Go SDK query example
Includefields to explicitly includedistance. - Add v0.16.1 release note describing the
query()/includedistance behavior fix.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| versions/v0.16.x/service/python-sdk/types.mdx | Updates query result field docs and include note to reflect optional distance and server defaults. |
| versions/v0.16.x/service/python-sdk/encrypted-index/query.mdx | Updates include parameter and result format docs to make distance optional and clarify defaults. |
| versions/v0.16.x/service/go-sdk/encrypted-index/query.mdx | Adjusts example Include list to include distance explicitly. |
| versions/v0.16.x/embedded/guides/data-operations/query.mdx | Updates example output, but currently introduces a mismatch with the surrounding text about distances. |
| versions/changelog.mdx | Adds v0.16.1 changelog entry describing the distance/include bug fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
added v0.16.1 to the change log to reflect the query distances bug fix.