report 'relevance_score' error #527

Closed
opened 2026-02-16 10:19:39 -05:00 by yindo · 1 comment
Owner

Originally created by @CreamyLong on GitHub (Aug 6, 2025).

Self Checks

  • I have read the Contributing Guide and Language Policy.
  • This is only for bug report, if you would like to ask a question, please head to Discussions.
  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit this report, otherwise it will be closed.
  • 【中文用户 & Non English User】请使用英语提交,否则会被关闭 :)
  • Please do not modify this template :) and fill in all the required fields.

Dify version

1.7.1

Cloud or Self Hosted

Self Hosted (Docker)

Steps to reproduce

add rerank model in OpenAI-API-compatible

✔️ Expected Behavior

Image

Actual Behavior

unable to add rerank model

Originally created by @CreamyLong on GitHub (Aug 6, 2025). ### Self Checks - [x] I have read the [Contributing Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md) and [Language Policy](https://github.com/langgenius/dify/issues/1542). - [x] This is only for bug report, if you would like to ask a question, please head to [Discussions](https://github.com/langgenius/dify/discussions/categories/general). - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit this report, otherwise it will be closed. - [x] 【中文用户 & Non English User】请使用英语提交,否则会被关闭 :) - [x] Please do not modify this template :) and fill in all the required fields. ### Dify version 1.7.1 ### Cloud or Self Hosted Self Hosted (Docker) ### Steps to reproduce add rerank model in OpenAI-API-compatible ### ✔️ Expected Behavior <img width="1061" height="718" alt="Image" src="https://github.com/user-attachments/assets/1d367e2e-4430-4be7-bb1e-8b46ef3fb7e3" /> ### ❌ Actual Behavior unable to add rerank model
yindo closed this issue 2026-02-16 10:19:39 -05:00
Author
Owner

@dosubot[bot] commented on GitHub (Aug 6, 2025):

Hi @CreamyLong! I'm Dosu and I’m helping the dify team.

Dify expects rerank model outputs to use the field score (float) for each document, not relevance_score. If your rerank plugin or external model returns results using relevance_score, Dify won't recognize it and will raise a schema validation error, which prevents you from adding the rerank model. This is a common integration issue—Dify does not provide a built-in mapping or configuration to accept relevance_score in place of score reference.

To fix this, make sure your rerank plugin or proxy transforms the response so that each document object uses score instead of relevance_score. If you can't modify the plugin directly, you can use a simple proxy to rewrite the response JSON. For example, in JavaScript:

results = results.map(doc => ({
  ...doc,
  score: doc.relevance_score,
  relevance_score: undefined
}));

Also, check that your plugin daemon returns error responses as JSON objects (not lists), since Dify expects errors in dict/object format—otherwise, you'll see errors like list indices must be integers or slices, not str reference.

If you want help reviewing your rerank model config or plugin logs, feel free to share them.

To reply, just mention @dosu.


How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other  Chat with Dosu Join Discord Share on X

@dosubot[bot] commented on GitHub (Aug 6, 2025): <!-- Greeting --> Hi @CreamyLong! I'm [Dosu](https://go.dosu.dev/dosubot) and I’m helping the dify team. <!-- Answer --> Dify expects rerank model outputs to use the field `score` (float) for each document, not `relevance_score`. If your rerank plugin or external model returns results using `relevance_score`, Dify won't recognize it and will raise a schema validation error, which prevents you from adding the rerank model. This is a common integration issue—Dify does not provide a built-in mapping or configuration to accept `relevance_score` in place of `score` [reference](https://github.com/langgenius/dify/blob/c95761f4e6234a27a31446bec768da72826d3324/api/core/model_runtime/entities/rerank_entities.py). To fix this, make sure your rerank plugin or proxy transforms the response so that each document object uses `score` instead of `relevance_score`. If you can't modify the plugin directly, you can use a simple proxy to rewrite the response JSON. For example, in JavaScript: ```js results = results.map(doc => ({ ...doc, score: doc.relevance_score, relevance_score: undefined })); ``` Also, check that your plugin daemon returns error responses as JSON objects (not lists), since Dify expects errors in dict/object format—otherwise, you'll see errors like `list indices must be integers or slices, not str` [reference](https://github.com/langgenius/dify/issues/23491). If you want help reviewing your rerank model config or plugin logs, feel free to share them. <!-- Dosu Comment Footer --> *To reply, just mention [@dosu](https://go.dosu.dev/dosubot).* --- <sup>How did I do? [Good](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/60db0b7e-8895-4b50-8f1e-d564b15caee6?feedback_type=other)</sup>&nbsp;&nbsp;[![Chat with Dosu](https://dosu.dev/dosu-chat-badge.svg)](https://app.dosu.dev/6088a4f4-073a-43f3-b3d4-4f06fb0c05a0/ask?utm_source=github)&nbsp;[![Join Discord](https://img.shields.io/badge/join-5865F2?logo=discord&logoColor=white&label=)](https://go.dosu.dev/discord-bot)&nbsp;[![Share on X](https://img.shields.io/badge/X-share-black)](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/langgenius/dify/issues/23501)
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify-official-plugins#527