[PR #184] docs: document Router model_provider / strict_mode / fallback_provider #184

Open
opened 2026-10-31 22:02:08 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/184
Author: @deepme987
Created: 9/22/2026
Status: 🔄 Open

Base: main ← Head: deepme987/docs/router-params


📝 Commits (3)

  • b8016b0 docs: document router model_provider / strict_mode / fallback_provider on model run
  • aec1963 test(router): pin credits_used lift now that the spec declares X-Comfy-Credits-Used
  • d94be41 docs: Clarify Router parameter dropping, strict mode, and fallback behavior

📊 Changes

2 files changed (+41 additions, -3 deletions)

View changed files

📝 README.md (+29 -0)
📝 tests/test_router_spec_contract.py (+12 -3)

📄 Description

Documents the alternate-provider params (model_provider / strict_mode / fallback_provider) on client.models.run, added in #159 but not yet surfaced in the README. Docs-only; no code or behavior changes.

Summary by CodeRabbit

  • Documentation
    • Added guidance for routing models.run calls through alternate providers.
    • Documented that alternate-provider requests translate native model input and output by default, while strict mode uses the alternate provider’s raw schema.
    • Clarified that fallback retries only failures attributable to the Router or provider, can be disabled, and that calls without provider options remain unchanged.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/184 **Author:** [@deepme987](https://github.com/deepme987) **Created:** 9/22/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `deepme987/docs/router-params` --- ### 📝 Commits (3) - [`b8016b0`](https://github.com/Comfy-Org/comfy-python-sdk/commit/b8016b0681ef8b751c5d9e3124b217e73e284a9d) docs: document router model_provider / strict_mode / fallback_provider on model run - [`aec1963`](https://github.com/Comfy-Org/comfy-python-sdk/commit/aec19630844f2c4be9397d07063c4a2e2f32fd24) test(router): pin credits_used lift now that the spec declares X-Comfy-Credits-Used - [`d94be41`](https://github.com/Comfy-Org/comfy-python-sdk/commit/d94be41c0862c04dc50d6e674058887e773fbb12) docs: Clarify Router parameter dropping, strict mode, and fallback behavior ### 📊 Changes **2 files changed** (+41 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+29 -0) 📝 `tests/test_router_spec_contract.py` (+12 -3) </details> ### 📄 Description Documents the alternate-provider params (`model_provider` / `strict_mode` / `fallback_provider`) on `client.models.run`, added in #159 but not yet surfaced in the README. Docs-only; no code or behavior changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added guidance for routing `models.run` calls through alternate providers. * Documented that alternate-provider requests translate native model input and output by default, while strict mode uses the alternate provider’s raw schema. * Clarified that fallback retries only failures attributable to the Router or provider, can be disabled, and that calls without provider options remain unchanged. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Comfy-Org/comfy-python-sdk#184
No description provided.