feat: add skip_decode parameter to return_fields method (#252) #389
Conversation
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
bsbodden
force-pushed
the
bsb/issue-252
branch
from
2700a00 to
5189c9f
Compare
bsbodden
force-pushed
the
bsb/issue-252
branch
from
5189c9f to
1a019ac
Compare
Implements skip_decode parameter for return_fields() method to improve field deserialization UX. This allows users to skip decoding of binary fields like embeddings while still returning them in query results. - Added optional skip_decode parameter to BaseQuery.return_fields() - Parameter accepts string or list of field names to skip decoding - Maintains backward compatibility when skip_decode is not provided - Comprehensive unit test coverage for all query types - Enhanced skip_decode to use parent's return_field with decode_field=False - Added comprehensive integration tests with real Redis - Maintained full backward compatibility with return_field(decode_field=False) - Tests confirm proper binary field handling (embeddings, image data)
bsbodden
force-pushed
the
bsb/issue-252
branch
from
1a019ac to
638f95a
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
bsbodden
added a commit
to redis/redis-vl-java
that referenced
this pull request
Oct 23, 2025
…on PR #389) Add skipDecodeFields parameter to query builders to control binary field decoding: - FilterQuery, VectorQuery, VectorRangeQuery, TextQuery - Accepts List<String> or varargs of field names - Returns immutable copy via getSkipDecodeFields() Implementation details: - Field names that should not be decoded from binary format - Useful for binary data like embeddings and image data - Validates field names cannot be null - Maintains backward compatibility (defaults to empty list) Test coverage: - 10 unit tests in SkipDecodeFieldsTest - Tests for all query types - Validation tests for null handling - Varargs convenience method tests Python reference: - skip_decode parameter in return_fields() method - Prevents automatic decoding of specified binary fields - Allows retrieval of raw bytes for embeddings/images Refs: redis/redis-vl-python#389 Fixes: #252
bsbodden
added a commit
to redis/redis-vl-java
that referenced
this pull request
Oct 23, 2025
…on PR #389) Add skipDecodeFields parameter to query builders to control binary field decoding: - FilterQuery, VectorQuery, VectorRangeQuery, TextQuery - Accepts List<String> or varargs of field names - Returns immutable copy via getSkipDecodeFields() Implementation details: - Field names that should not be decoded from binary format - Useful for binary data like embeddings and image data - Validates field names cannot be null - Maintains backward compatibility (defaults to empty list) Test coverage: - 10 unit tests in SkipDecodeFieldsTest - Tests for all query types - Validation tests for null handling - Varargs convenience method tests Python reference: - skip_decode parameter in return_fields() method - Prevents automatic decoding of specified binary fields - Allows retrieval of raw bytes for embeddings/images Refs: redis/redis-vl-python#389 Fixes: #252
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.
Implements skip_decode parameter for return_fields() method to improve field deserialization UX. This allows users to skip decoding of binary fields like embeddings while still returning them in query results.