Skip to content

docs: improve .env.example.full reranker and embedding provider documentation - #1073

Merged
lightzt99 merged 1 commit into
oceanbase:mainfrom
knqiufan:docs/improve-env-example-full-reranker-and-embedding
Jun 23, 2026
Merged

docs: improve .env.example.full reranker and embedding provider documentation#1073
lightzt99 merged 1 commit into
oceanbase:mainfrom
knqiufan:docs/improve-env-example-full-reranker-and-embedding

Conversation

@knqiufan

Copy link
Copy Markdown
Contributor

Summary

While configuring PowerMem I wanted to integrate SiliconFlow and other third-party services as a reranker, but found no guidance in .env.example.full on how to do so. The code already supports a generic reranker provider and many more embedding providers than documented. This PR improves the configuration reference to match what the code actually supports.

Changes

  • Document the generic reranker provider for standard rerank APIs (SiliconFlow, Xinference, vLLM, or any OpenAI-compatible rerank endpoint)
  • Add concrete configuration examples for SiliconFlow and local Xinference rerank setups
  • Add all code-supported embedding providers (azure_openai, gemini, vertexai, together, aws_bedrock, zai) to the EMBEDDING_PROVIDER list
  • Add model examples for siliconflow, azure_openai, gemini, zai embedding providers
  • Fix RERANKER_MODEL comment defaults to match actual code: jina-reranker-v3 (was jina-reranker-v2-base-multilingual), rerank for zai (was rerank-3-base, rerank-3-large)
  • Expand RERANKER_API_BASE_URL comments with per-provider default URLs

Why

  • Users trying to use SiliconFlow, Xinference, or other rerank services have no configuration guidance
  • The generic provider is a powerful universal adapter but is completely invisible in the docs
  • Several implemented embedding providers are missing from the configuration reference
  • Stale model defaults in comments vs code create confusion

Closes #1072

Validation

  • Cross-checked all provider names against src/powermem/integrations/rerank/config/providers.py and src/powermem/integrations/embeddings/config/providers.py
  • Verified default model values match code: jina-reranker-v3, rerank (zai), qwen3-rerank
  • Verified default API base URLs match code: https://api.jina.ai/v1/rerank, https://open.bigmodel.cn/api/paas/v4/rerank
  • Verified SiliconFlow rerank API format compatibility with GenericRerank implementation (standard {model, query, documents}{results: [{index, relevance_score}]})
  • git diff --check passes

…entation

- Document the `generic` reranker provider for standard rerank APIs
  (SiliconFlow, Xinference, vLLM, etc.) with usage examples
- Add all supported embedding providers (azure_openai, gemini, vertexai,
  together, aws_bedrock, zai) to the EMBEDDING_PROVIDER list
- Add model examples for siliconflow, azure_openai, gemini, zai embeddings
- Fix RERANKER_MODEL defaults to match code (jina-reranker-v3, rerank)
- Expand RERANKER_API_BASE_URL comments with per-provider defaults
- Add concrete configuration examples for SiliconFlow and Xinference rerank
@lightzt99

Copy link
Copy Markdown
Collaborator

LGTM

@lightzt99
lightzt99 merged commit eb0bde2 into oceanbase:main Jun 23, 2026
11 checks passed
@knqiufan
knqiufan deleted the docs/improve-env-example-full-reranker-and-embedding branch July 5, 2026 16:50
222twotwotwo pushed a commit to 222twotwotwo/powercontext that referenced this pull request Aug 23, 2026
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.

[Enhancement]: Improve .env.example.full — document generic reranker provider and missing embedding providers

2 participants