Open
Conversation
add info about __index required field in response, batches and search_normalized_score
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 of Changes –
$matchEndpoint Documentation🎯 Purpose
Update the documentation for the
$matchendpoint to clarify usage and reflect recent improvements.➕ Additions
__indexfield (zero-based) is mandatory for each row in the response.search_normalized_scorefield (range 0–1) in thesearch_metaresponse object.🔧 Adjustments
💡 Examples
local_idfrom the payload, adding the__indexfield in the response, and formatting the JSON for readability.✅ Impact
__indexis always returned and thatsearch_normalized_scoreis optional.📝 Modified File
docs/source/oclapi/apireference/match.md