Skip to content

docs(recall): align min_scores score field names#2432

Open
r266-tech wants to merge 2 commits into
vectorize-io:mainfrom
r266-tech:r266-recall-min-scores-docs
Open

docs(recall): align min_scores score field names#2432
r266-tech wants to merge 2 commits into
vectorize-io:mainfrom
r266-tech:r266-recall-min-scores-docs

Conversation

@r266-tech

Copy link
Copy Markdown
Contributor

Summary

  • replace the stale semantic/text wording for recall scores with semantic/keyword
  • update the min_scores docs to point at the scores object instead of the removed singular score anchor
  • regenerate the Hindsight docs skill mirror for developer/api/recall.md

Checks

  • UV_PYTHON=/Users/admin/.local/bin/python3.12 uv run --project hindsight-api-slim ruff check hindsight-api-slim/hindsight_api/engine/response_models.py hindsight-api-slim/tests/test_recall_min_score.py
  • ./scripts/generate-docs-skill.sh
  • UV_PYTHON=/Users/admin/.local/bin/python3.12 ./scripts/generate-openapi.sh generated OpenAPI successfully; the wrapper then failed at npm run build in this sparse checkout because hindsight-docs/package.json was not checked out. The OpenAPI JSON had no diff because the exported RecallScores/MinScores schemas were already aligned.
  • mirror/source assertions for the recall docs wording
  • git diff --check

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