mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-31 06:51:29 +00:00
ba9964ff0d
Allow custom OpenAI-compatible providers declared under `custom_providers:`
to set provider-specific `extra_body` fields and have Hermes merge them into
chat-completions requests when the matching custom endpoint is active.
This is a manual per-provider override rather than a model-name heuristic.
OpenAI-compatible Gemma thinking support is real, but the on-wire payload
shape is backend-specific: some servers want top-level `enable_thinking`,
while vLLM Gemma and NIM-style endpoints expect `chat_template_kwargs`.
A per-provider override is safer than picking one assumed payload.
Example config:
```yaml
custom_providers:
- name: gemma-local
base_url: http://localhost:8080/v1
model: google/gemma-4-31b-it
extra_body:
enable_thinking: true
reasoning_effort: high
```
For vLLM Gemma or NIM-style endpoints, use the nested shape those servers
expect:
```yaml
extra_body:
chat_template_kwargs:
enable_thinking: true
```
Changes:
- `hermes_cli/config.py`: preserve `extra_body` in normalized
`custom_providers:` entries and allow it in the validated field set.
- `hermes_cli/runtime_provider.py`: propagate custom-provider `extra_body`
as `request_overrides.extra_body` for named custom runtime resolution,
including credential-pool paths.
- `agent/agent_init.py`: at agent init, locate the matching custom-provider
entry by `base_url` (+ optional model) and merge its `extra_body` into
`AIAgent.request_overrides`, with caller-provided overrides winning on
conflicting top-level keys.
- `plugins/model-providers/custom/__init__.py`: keep existing CustomProfile
behavior (Ollama `num_ctx`, `think=False` when reasoning disabled);
user-configured `extra_body` flows through `request_overrides`.
- `website/docs/integrations/providers.md`: document the explicit
`extra_body` override and the vLLM/Gemma `chat_template_kwargs` variant.
- Tests cover config normalization, runtime propagation, model matching,
trailing-slash equivalence, fallback when no `model` field is set, and
caller-override merging precedence.
Verified end-to-end against `CustomProfile` via `ChatCompletionsTransport`:
configured `extra_body` reaches `kwargs.extra_body` on the wire request,
and coexists with profile-generated entries (Ollama `num_ctx`, `think=False`)
without clobber.
Salvaged from #29022 onto current `main`. Cosmetic typing edit in
`plugins/model-providers/custom/__init__.py` and a stale-base docs revert
in `providers.md` were dropped during cherry-pick.
Closes #29022
259 lines
9.2 KiB
Python
259 lines
9.2 KiB
Python
"""Parity tests: pin the exact current transport behavior per provider.
|
|
|
|
These tests document the flag-based contract between run_agent.py and
|
|
ChatCompletionsTransport.build_kwargs(). When the next PR wires profiles
|
|
to replace flags, every assertion here must still pass — any failure is
|
|
a behavioral regression.
|
|
"""
|
|
|
|
import pytest
|
|
from agent.transports.chat_completions import ChatCompletionsTransport
|
|
from providers import get_provider_profile
|
|
|
|
|
|
@pytest.fixture
|
|
def transport():
|
|
return ChatCompletionsTransport()
|
|
|
|
|
|
def _simple_messages():
|
|
return [{"role": "user", "content": "hello"}]
|
|
|
|
|
|
def _max_tokens_fn(n):
|
|
return {"max_completion_tokens": n}
|
|
|
|
|
|
class TestNvidiaParity:
|
|
"""NVIDIA NIM: default max_tokens=16384."""
|
|
|
|
def test_default_max_tokens(self, transport):
|
|
"""NVIDIA default max_tokens=16384 comes from profile, not legacy is_nvidia_nim flag."""
|
|
from providers import get_provider_profile
|
|
|
|
profile = get_provider_profile("nvidia")
|
|
kw = transport.build_kwargs(
|
|
model="nvidia/llama-3.1-nemotron-70b-instruct",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
max_tokens_param_fn=_max_tokens_fn,
|
|
provider_profile=profile,
|
|
)
|
|
assert kw["max_completion_tokens"] == 16384
|
|
|
|
def test_user_max_tokens_overrides(self, transport):
|
|
from providers import get_provider_profile
|
|
|
|
profile = get_provider_profile("nvidia")
|
|
kw = transport.build_kwargs(
|
|
model="nvidia/llama-3.1-nemotron-70b-instruct",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
max_tokens=4096,
|
|
max_tokens_param_fn=_max_tokens_fn,
|
|
provider_profile=profile,
|
|
)
|
|
assert kw["max_completion_tokens"] == 4096 # user overrides default
|
|
|
|
|
|
class TestKimiParity:
|
|
"""Kimi: OMIT temperature, max_tokens=32000, thinking + reasoning_effort."""
|
|
|
|
def test_temperature_omitted(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="kimi-k2",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("kimi-coding"),
|
|
omit_temperature=True,
|
|
)
|
|
assert "temperature" not in kw
|
|
|
|
def test_default_max_tokens(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="kimi-k2",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("kimi-coding"),
|
|
max_tokens_param_fn=_max_tokens_fn,
|
|
)
|
|
assert kw["max_completion_tokens"] == 32000
|
|
|
|
def test_thinking_enabled(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="kimi-k2",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("kimi-coding"),
|
|
reasoning_config={"enabled": True, "effort": "high"},
|
|
)
|
|
assert kw["extra_body"]["thinking"] == {"type": "enabled"}
|
|
|
|
def test_thinking_disabled(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="kimi-k2",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("kimi-coding"),
|
|
reasoning_config={"enabled": False},
|
|
)
|
|
assert kw["extra_body"]["thinking"] == {"type": "disabled"}
|
|
|
|
def test_reasoning_effort_top_level(self, transport):
|
|
"""Kimi reasoning_effort is a TOP-LEVEL api_kwargs key, NOT in extra_body."""
|
|
kw = transport.build_kwargs(
|
|
model="kimi-k2",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("kimi-coding"),
|
|
reasoning_config={"enabled": True, "effort": "high"},
|
|
)
|
|
assert kw.get("reasoning_effort") == "high"
|
|
assert "reasoning_effort" not in kw.get("extra_body", {})
|
|
|
|
def test_reasoning_effort_default_medium(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="kimi-k2",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("kimi-coding"),
|
|
reasoning_config={"enabled": True},
|
|
)
|
|
assert kw.get("reasoning_effort") == "medium"
|
|
|
|
|
|
class TestOpenRouterParity:
|
|
"""OpenRouter: provider preferences, reasoning in extra_body."""
|
|
|
|
def test_provider_preferences(self, transport):
|
|
prefs = {"allow": ["anthropic"], "sort": "price"}
|
|
kw = transport.build_kwargs(
|
|
model="anthropic/claude-sonnet-4.6",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("openrouter"),
|
|
provider_preferences=prefs,
|
|
)
|
|
assert kw["extra_body"]["provider"] == prefs
|
|
|
|
def test_reasoning_passes_full_config(self, transport):
|
|
"""OpenRouter passes the FULL reasoning_config dict, not just effort."""
|
|
rc = {"enabled": True, "effort": "high"}
|
|
kw = transport.build_kwargs(
|
|
model="anthropic/claude-sonnet-4.6",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("openrouter"),
|
|
supports_reasoning=True,
|
|
reasoning_config=rc,
|
|
)
|
|
assert kw["extra_body"]["reasoning"] == rc
|
|
|
|
def test_default_reasoning_when_no_config(self, transport):
|
|
"""When supports_reasoning=True but no config, adds default."""
|
|
kw = transport.build_kwargs(
|
|
model="anthropic/claude-sonnet-4.6",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("openrouter"),
|
|
supports_reasoning=True,
|
|
)
|
|
assert kw["extra_body"]["reasoning"] == {"enabled": True, "effort": "medium"}
|
|
|
|
|
|
class TestNousParity:
|
|
"""Nous: product tags, reasoning, omit when disabled."""
|
|
|
|
def test_tags(self, transport):
|
|
from agent.portal_tags import nous_portal_tags
|
|
kw = transport.build_kwargs(
|
|
model="hermes-3-llama-3.1-405b",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("nous"),
|
|
)
|
|
assert kw["extra_body"]["tags"] == nous_portal_tags()
|
|
|
|
def test_reasoning_omitted_when_disabled(self, transport):
|
|
"""Nous special case: reasoning omitted entirely when disabled."""
|
|
kw = transport.build_kwargs(
|
|
model="hermes-3-llama-3.1-405b",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("nous"),
|
|
supports_reasoning=True,
|
|
reasoning_config={"enabled": False},
|
|
)
|
|
assert "reasoning" not in kw.get("extra_body", {})
|
|
|
|
def test_reasoning_enabled(self, transport):
|
|
rc = {"enabled": True, "effort": "high"}
|
|
kw = transport.build_kwargs(
|
|
model="hermes-3-llama-3.1-405b",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("nous"),
|
|
supports_reasoning=True,
|
|
reasoning_config=rc,
|
|
)
|
|
assert kw["extra_body"]["reasoning"] == rc
|
|
|
|
|
|
class TestQwenParity:
|
|
"""Qwen: max_tokens=65536, vl_high_resolution, metadata top-level."""
|
|
|
|
def test_default_max_tokens(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="qwen3.5-plus",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("qwen-oauth"),
|
|
max_tokens_param_fn=_max_tokens_fn,
|
|
)
|
|
assert kw["max_completion_tokens"] == 65536
|
|
|
|
def test_vl_high_resolution(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="qwen3.5-plus",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("qwen-oauth"),
|
|
)
|
|
assert kw["extra_body"]["vl_high_resolution_images"] is True
|
|
|
|
def test_metadata_top_level(self, transport):
|
|
"""Qwen metadata goes to top-level api_kwargs, NOT extra_body."""
|
|
meta = {"sessionId": "s123", "promptId": "p456"}
|
|
kw = transport.build_kwargs(
|
|
model="qwen3.5-plus",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("qwen-oauth"),
|
|
qwen_session_metadata=meta,
|
|
)
|
|
assert kw["metadata"] == meta
|
|
assert "metadata" not in kw.get("extra_body", {})
|
|
|
|
|
|
class TestCustomOllamaParity:
|
|
"""Custom/Ollama: num_ctx, thinking controls — now tested via profile."""
|
|
|
|
def test_ollama_num_ctx(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="llama3.1",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("custom"),
|
|
ollama_num_ctx=131072,
|
|
)
|
|
assert kw["extra_body"]["options"]["num_ctx"] == 131072
|
|
|
|
def test_think_false_when_disabled(self, transport):
|
|
kw = transport.build_kwargs(
|
|
model="qwen3:72b",
|
|
messages=_simple_messages(),
|
|
tools=None,
|
|
provider_profile=get_provider_profile("custom"),
|
|
reasoning_config={"enabled": False, "effort": "none"},
|
|
)
|
|
assert kw["extra_body"]["think"] is False
|