[v1.38] Document nested object property filters#425
Open
g-despot wants to merge 3 commits into
Open
Conversation
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents preview support in Weaviate v1.38 for filtering nested object / object[] property values, adding conceptual guidance, GraphQL reference examples, and a Python sample include.
Changes:
- Adds nested-object filtering guidance, path syntax, operator patterns, and limitations.
- Adds GraphQL reference examples and updates the renamed compound-filter anchor.
- Updates datatype and collection-operations docs with cross-links to the new guide.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
docs/weaviate/search/filters.md |
Adds the main nested-object filtering guide and updates the compound-filter heading. |
docs/weaviate/api/graphql/filters.md |
Adds nested-path where examples and updates the renamed anchor link. |
docs/weaviate/config-refs/datatypes.md |
Updates the object datatype note to mention nested filtering. |
docs/weaviate/manage-collections/collection-operations.mdx |
Adds a link from nested object configuration docs to filtering docs. |
_includes/code/howto/search.filters.nested.py |
Adds Python examples for nested filtering patterns. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1080
to
+1085
| <FilteredTextBlock | ||
| text={PyCodeNested} | ||
| startMarker="client.collections.create(" | ||
| endMarker="docs = client.collections.use" | ||
| language="python" | ||
| /> |
Comment on lines
+19
to
+22
| client.collections.create( | ||
| name="Document", | ||
| vector_config=Configure.Vectors.self_provided(), | ||
| properties=[ |
|
|
||
| :::note | ||
|
|
||
| - **Allowed leaf data types**: `text`, `int`, `number`, `boolean`, `date`, `uuid`, `blob`, `blobHash`, and their array variants. `geoCoordinates`, `phoneNumber`, and cross-references (`cref`) are not allowed inside nested objects. |
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.
Summary
Adds documentation for filtering on
object/object[](nested) property values, a preview feature landing in Weaviate v1.38 behindWEAVIATE_PREVIEW_NESTED_FILTERING=on. Covers path syntax, every operator pattern (existential, positional, same-element AND, recursive,IsNull), and the limitations users need to know.