Skip to content

docs(rerank): document DashScope provider - #446

Open
ACBBZ wants to merge 1 commit into
EverMind-AI:mainfrom
ACBBZ:docs/rerank-dashscope-provider
Open

ACBBZ wants to merge 1 commit into
EverMind-AI:mainfrom
ACBBZ:docs/rerank-dashscope-provider

Conversation

@ACBBZ

@ACBBZ ACBBZ commented Sep 10, 2026

Copy link
Copy Markdown

Summary

  • Document dashscope as a supported [rerank].provider alongside deepinfra and vllm.
  • Clarify in build_rerank_provider that api_key is required for both DeepInfra and DashScope, while it remains optional for self-hosted vLLM endpoints.
  • No runtime behavior changes.

Area

  • Architecture method
  • Benchmark
  • Use case
  • Documentation
  • Developer experience
  • CI, build, or release

Verification

Python AST parse of the updated factory.py: passed
Configuration table structure/provider-name check: passed
Branch diff: 1 commit, 2 files; documentation/docstring changes only

Repo-wide make ci was not run because the execution environment could not create a working-tree checkout. The change does not alter runtime behavior.

Checklist

  • I kept the change scoped to the relevant area.
  • I am opening this from a separate branch, not pushing directly to main.
  • I updated docs, examples, or setup notes when behavior changed.
  • Tests are not applicable because this change does not affect behavior.
  • I did not commit secrets, .env files, dependency folders, or generated output.
  • No Markdown links were added or changed.

Notes for Reviewers

RerankSettings and the provider factory already support DashScope; this PR only brings the configuration reference and the factory docstring in sync with the existing implementation.

By submitting this pull request, I agree that my contribution is licensed under
the Apache License 2.0.

Copilot AI lite review requested due to automatic review settings September 10, 2026 02:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The [rerank] configuration table still marks api_key as universally required even though it is optional for self-hosted vllm endpoints, leaving the docs inconsistent with the implementation.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates EverOS’s configuration reference/docs to include the existing DashScope rerank provider and clarifies API-key expectations in the rerank provider factory documentation so the docs match current behavior.

Changes:

  • Document dashscope as a supported [rerank].provider alongside deepinfra and vllm.
  • Clarify (docstring) that api_key is required for deepinfra and dashscope, but optional for self-hosted vllm endpoints.
File summaries
File Description
src/everos/component/rerank/factory.py Updates the build_rerank_provider docstring to reflect DashScope support and api_key requirements by provider.
docs/configuration.md Expands the [rerank] provider field documentation to include dashscope.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/configuration.md
| `provider` | string | `"deepinfra"` | No | Rerank provider: `deepinfra` or `vllm`. |
| `provider` | string | `"deepinfra"` | No | Rerank provider: `deepinfra`, `vllm`, or `dashscope`. |
| `model` | string | — | **Yes** | Reranker model identifier. |
| `api_key` | string | — | **Yes** | API key. |
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