Skip to content

Update $match API reference to match current implementation#60

Merged
paynejd merged 1 commit intomainfrom
fix/match-api-docs
Mar 27, 2026
Merged

Update $match API reference to match current implementation#60
paynejd merged 1 commit intomainfrom
fix/match-api-docs

Conversation

@paynejd
Copy link
Copy Markdown
Member

@paynejd paynejd commented Mar 27, 2026

Summary

  • Fix incorrect parameter defaults (numCandidates: 5000→3000, kNearest: 5→100) and ranges
  • Add missing query parameters: brief, encoder_model, reranker
  • Add missing body parameters: target_repo (alternative to URL), filter (locale + faceted filtering)
  • Fix target_repo_url cardinality from 1..1 to 0..1, rows.synonyms type to accept string or list
  • Document missing response fields: search_normalized_score, search_rerank_score, algorithm, search_confidence
  • Add match_type scoring logic explanation for all search modes (token, semantic, semantic+reranker)
  • Add authentication & access requirements section
  • Fix broken JSON examples (syntax errors, mismatched data) with realistic responses
  • Remove misleading includeSearchMeta=true (automatic for $match)
  • Add Example Request 3 demonstrating semantic + reranker + locale filter

Companion API PR: OpenConceptLab/oclapi2#824

Test plan

  • Build docs locally (make html) and review rendered match page
  • Verify all parameter tables render correctly in Sphinx
  • Confirm JSON examples are valid and realistic
  • Check navigation/toctree still includes match entry

🤖 Generated with Claude Code

Fix incorrect parameter defaults (numCandidates: 5000->3000, kNearest: 5->100),
add missing parameters (brief, encoder_model, reranker, filter, target_repo),
document match_type scoring logic, authentication requirements, and response
fields (search_normalized_score, algorithm, search_rerank_score). Fix broken
JSON examples with realistic data.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@paynejd paynejd merged commit 4346371 into main Mar 27, 2026
@paynejd paynejd deleted the fix/match-api-docs branch March 27, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant