Skip to content

docs: document compatible reranker APIs - #157

Merged
zhenghaoz merged 3 commits into
gorse-io:mainfrom
zhangzhenghao:docs/reranker-api-compatibility
Oct 13, 2026
Merged

zhenghaoz merged 3 commits into
gorse-io:mainfrom
zhangzhenghao:docs/reranker-api-compatibility

Conversation

@zhangzhenghao

Copy link
Copy Markdown
Contributor

Summary

  • Add an API Compatibility subsection under LLM-based Rerankers in the English and Chinese ranking documentation.
  • List the compatible Jina AI, Cohere v2, Alibaba Cloud qwen3-rerank compatible endpoint, SiliconFlow, and vLLM interfaces, with endpoint paths and official references.
  • Explain the Bearer-authenticated text request / top-level results response contract, the complete-endpoint requirement, and provider-specific limitations.
  • Include a Jina reranker configuration example; leave the configuration reference and existing surrounding content unchanged.

Validation

  • pnpm install --frozen-lockfile
  • git diff --check
  • pnpm docs:build (passed; existing theme/sidebar/fonticon/chunk warnings)
  • Parsed both generated ranking HTML pages and verified the compatibility tables, configuration example, and section anchors.
  • Compatibility is based on the client implementation and official protocol documentation, not live paid provider calls.

@zhenghaoz
zhenghaoz merged commit e48c944 into gorse-io:main Oct 13, 2026
1 check passed
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.

2 participants