docs(config): correct 15.7 geolocation search against current implementation#323
Open
marevol wants to merge 1 commit into
Open
docs(config): correct 15.7 geolocation search against current implementation#323marevol wants to merge 1 commit into
marevol wants to merge 1 commit into
Conversation
…ntation Verified search-geosearch.rst against the Fess 15.7 source code, fixed inaccuracies in the Japanese document, and propagated the corrections to all languages (en, de, es, fr, ko, zh-cn). Corrections: - API endpoint: the removed v1 JSON API (/api/v1/documents) is replaced with the current v2 search API (/api/v2/search). The v1 API was dropped in 15.7. - API response handling: the Google Maps example now reads the v2 envelope (response.data) instead of the v1 shape (response.result). - Crawl script syntax: field assignment uses `location="lat,lon"` instead of the invalid `doc.location = ...`. Additions (previously missing): - `location` is not returned in API responses by default; document the required `query.additional.api.response.fields=location` setting (the Google Maps example does not work without it). - Geo search runs as a filter clause: it narrows results but does not affect score and does not sort by distance (Fess has no distance sorting). - Request parameter names follow `geo.<field>.point` / `geo.<field>.distance` and track `query.geo.fields`; `point` and `distance` must be paired. - Multiple points on one field are OR'd; multiple fields are AND'd. - Additional OpenSearch distance units (cm, mm, ft, in, nmi) are accepted. Fixes: - Replace the arbitrary "slower above 50km" claim with an accurate note about geo_point BKD indexing and result-count/response-size considerations. Sources: GeoInfo.java, QueryFieldConfig.java, SearchEngineClient.java, fess_config.properties (query.geo.fields, query.additional.api.response.fields), fess_indices/fess/doc.json, api/v2 handlers.
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
1 participant
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
Reviewed
config/search-geosearch.rst(Geolocation Search) for 15.7 against the current Fess implementation, corrected the Japanese source, and propagated the changes to all languages (en, de, es, fr, ko, zh-cn).Why
Several statements no longer matched the 15.7 code:
/api/v1/documents), which was removed in 15.7 and consolidated into v2 (/api/v2/search). Seeapi/api-overview.response.result) instead of the v2 envelope (response.data).doc.location = ...).It also omitted important behavior:
locationfield is not returned in API responses by default, so the Maps example silently produced no markers.query.additional.api.response.fields=locationis required.SearchEngineClient), so it narrows results but does not affect the relevance score and does not sort by distance (Fess has no distance sorting).Changes
Corrections
/api/v1/documents→/api/v2/searchresponse.result) → v2 envelope (response.data)doc.location = "..."→location="..."num/ radius)Additions
locationmust be added viaquery.additional.api.response.fields=locationto appear in API responsesgeo.<field>.point/geo.<field>.distanceand its link toquery.geo.fields; thepoint/distancepairing rulecm,mm,ft,in,nmi)Verification
Verified against:
GeoInfo.java,QueryFieldConfig.java,SearchEngineClient.java,fess_config.properties(query.geo.fields,query.additional.api.response.fields),fess_indices/fess/doc.json, and theapi/v2handlers.Structural lint across all 7 files: section underline lengths, directive/code-block formatting, element counts (notes / code-blocks / list-tables), and
:doc:references are consistent; no leftover Japanese remains in the translations.