Update SDK 3 FTS to further detail facets in results#99
Open
chvck wants to merge 3 commits into
Open
Conversation
daschl
reviewed
Oct 27, 2020
daschl
reviewed
Oct 27, 2020
daschl
reviewed
Oct 27, 2020
|
|
||
| ##### Term Facet Results | ||
| ``` | ||
| class TermFacetResult implements SearchFacetResult { |
Contributor
There was a problem hiding this comment.
java calls it TermSearchFacetResult
daschl
reviewed
Oct 27, 2020
| The JSON structure of each **term range** is: | ||
|
|
||
| ``` | ||
| TermRange { |
Contributor
There was a problem hiding this comment.
java calls it SearchTermRange
daschl
reviewed
Oct 27, 2020
|
|
||
| ##### Date Range Facet Results | ||
| ``` | ||
| class DateFacetResult implements SearchFacetResult { |
Contributor
There was a problem hiding this comment.
java is DateRangeSearchFacetResult (and same pattern for the others)
daschl
reviewed
Oct 27, 2020
| long other(); | ||
| List<TermFacetResult> terms(); | ||
| List<NumericRangeFacetResult> numericRanges(); | ||
| List<DateRangeFacetResult> dateRanges(); |
Contributor
There was a problem hiding this comment.
the names now also need to be modified
daschl
reviewed
Oct 27, 2020
| The JSON structure of each **date range** is: | ||
|
|
||
| ``` | ||
| DateRange { |
daschl
reviewed
Oct 27, 2020
| The JSON structure of each **numeric range** is: | ||
|
|
||
| ``` | ||
| NumericRange { |
daschl
reviewed
Oct 27, 2020
| The JSON structure of each **term range** is: | ||
|
|
||
| ``` | ||
| TermFacet { |
avsej
approved these changes
Jul 16, 2026
There was a problem hiding this comment.
Pull request overview
This PR updates RFC 0052’s SDK3 Full Text Search specification to more fully describe how facet results are represented in search responses, including JSON shape examples and suggested SDK-side representations.
Changes:
- Expanded the
SearchFacetResultsection with detailed JSON examples and proposed in-language model shapes for term/numeric/date facets. - Added a revision-history entry for the facet-result expansion and updated the signoff table to reflect revision #8 signoffs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "total": long | ||
| "missing": long | ||
| "other": long | ||
| "terms": [ {TermRange}, ... ] <1> |
| The section could be represented by a `Map` (or equivalent, eg. associative array). | ||
|
|
||
| ``` | ||
| Map<String, SearchFacetResult> facets(); |
Comment on lines
+675
to
+679
| String name(); | ||
| String field(); | ||
| long total(); | ||
| long missing(); | ||
| long other(); |
| long other(); | ||
| } | ||
| ``` | ||
| Note the `name` is made part of the `FacetResult`, so that it can be used in isolation. |
| } | ||
| ``` | ||
|
|
||
| Note that the `name()` is deprecated in this implementation, `name` is not required in this implemenatation due to it belonging the `SearchFacetResult` classes themselves. |
Comment on lines
+688
to
+692
| String name(); // deprecated | ||
| String field(); | ||
| long total(); | ||
| long missing(); | ||
| long other(); |
Comment on lines
+693
to
+695
| List<TermFacetResult> terms(); | ||
| List<NumericRangeFacetResult> numericRanges(); | ||
| List<DateRangeFacetResult> dateRanges(); |
| ``` | ||
| class TermSearchFacetResult implements SearchFacetResult { | ||
| //... all from FacetResult, plus: | ||
| List<SearchTermRange> terms(); |
| ``` | ||
| class NumericRangeSearchFacetResult implements SearchFacetResult { | ||
| //... all from FacetResult, plus: | ||
| List<SearchNumericRange> numericRanges(); |
| ``` | ||
| class DateRangeSearchFacetResult implements SearchFacetResult { | ||
| //... all from FacetResult, plus: | ||
| List<SearchDateRange> dateRanges(); |
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.
No description provided.