import os from typing import Any, Optional from langchain_core.messages import AIMessage from langchain_openai import ChatOpenAI from .api_key_env import get_api_key_env from .base_client import BaseLLMClient, normalize_content from .capabilities import get_capabilities from .validators import validate_model class NormalizedChatOpenAI(ChatOpenAI): """ChatOpenAI with normalized content output and capability-aware binding. The Responses API returns content as a list of typed blocks (reasoning, text, etc.). ``invoke`` normalizes to string for consistent downstream handling. ``with_structured_output`` consults the per-model capability table (``capabilities.get_capabilities``) to pick the method and to decide whether ``tool_choice`` may be sent. Models that reject ``tool_choice`` (e.g. DeepSeek V4 and reasoner — per their official tool-calling guide) still bind the schema as a tool, but no ``tool_choice`` parameter is sent. Provider-specific quirks beyond structured-output (e.g. DeepSeek's reasoning_content roundtrip) live in subclasses so this base class stays small. """ def invoke(self, input, config=None, **kwargs): return normalize_content(super().invoke(input, config, **kwargs)) def with_structured_output(self, schema, *, method=None, **kwargs): caps = get_capabilities(self.model_name) if caps.preferred_structured_method == "none": raise NotImplementedError( f"{self.model_name} has no structured-output method available; " f"agent factories will fall back to free-text generation." ) method = method or caps.preferred_structured_method # When the model rejects tool_choice, suppress langchain's hardcoded # value. The schema is still bound as a tool — exactly what # DeepSeek's official tool-calling examples do. if method == "function_calling" and not caps.supports_tool_choice: kwargs.setdefault("tool_choice", None) return super().with_structured_output(schema, method=method, **kwargs) def _input_to_messages(input_: Any) -> list: """Normalise a langchain LLM input to a list of message objects. Accepts a list of messages, a ``ChatPromptValue`` (from a ChatPromptTemplate), or anything else (treated as no messages). Used by providers that need to walk the outgoing message history; in particular DeepSeek thinking-mode propagation must work for both bare-list invocations and ChatPromptTemplate-driven ones, so treating only ``list`` here would silently skip half the call sites. """ if isinstance(input_, list): return input_ if hasattr(input_, "to_messages"): return input_.to_messages() return [] class DeepSeekChatOpenAI(NormalizedChatOpenAI): """DeepSeek-specific overrides on top of the OpenAI-compatible client. Thinking-mode round-trip is the only DeepSeek-specific behavior that stays here. When DeepSeek's thinking models return a response with ``reasoning_content``, that field must be echoed back as part of the assistant message on the next turn or the API fails with HTTP 400. ``_create_chat_result`` captures it on receive and ``_get_request_payload`` re-attaches it on send. Tool-choice handling for V4 and reasoner — those models reject the ``tool_choice`` parameter — is handled by the capability dispatch in ``NormalizedChatOpenAI.with_structured_output``, not here. """ def _get_request_payload(self, input_, *, stop=None, **kwargs): payload = super()._get_request_payload(input_, stop=stop, **kwargs) outgoing = payload.get("messages", []) for message_dict, message in zip(outgoing, _input_to_messages(input_)): if not isinstance(message, AIMessage): continue reasoning = message.additional_kwargs.get("reasoning_content") if reasoning is not None: message_dict["reasoning_content"] = reasoning return payload def _create_chat_result(self, response, generation_info=None): chat_result = super()._create_chat_result(response, generation_info) response_dict = ( response if isinstance(response, dict) else response.model_dump( exclude={"choices": {"__all__": {"message": {"parsed"}}}} ) ) for generation, choice in zip( chat_result.generations, response_dict.get("choices", []) ): reasoning = choice.get("message", {}).get("reasoning_content") if reasoning is not None: generation.message.additional_kwargs["reasoning_content"] = reasoning return chat_result class MinimaxChatOpenAI(NormalizedChatOpenAI): """MiniMax-specific overrides on top of the OpenAI-compatible client. M2.x reasoning models embed ``...`` blocks directly in ``message.content`` by default, which would pollute saved reports. Per platform.minimax.io/docs/api-reference/text-openai-api, ``reasoning_split=True`` redirects the thinking block into ``reasoning_details`` so ``content`` stays clean. It is sent via ``extra_body`` (not a top-level kwarg) because the openai SDK validates top-level params and rejects unknown ones like reasoning_split (#826). The flag is gated by ``ModelCapabilities.requires_reasoning_split`` so only M2.x reasoning models receive it; non-reasoning MiniMax endpoints (Coding Plan, MiniMax-Text-01) never see it. Tool-choice handling for M2.x — those models accept only the string enum ``{"none", "auto"}`` and reject langchain's function-spec dict — is handled by the capability dispatch in ``NormalizedChatOpenAI.with_structured_output``, not here. """ def _get_request_payload(self, input_, *, stop=None, **kwargs): payload = super()._get_request_payload(input_, stop=stop, **kwargs) if get_capabilities(self.model_name).requires_reasoning_split: # Pass via extra_body, not as a top-level kwarg: the openai SDK # (>=1.56) validates top-level params against Completions.create # and rejects unknown ones like reasoning_split (#826). extra_body # is forwarded into the request body untouched. extra_body = payload.setdefault("extra_body", {}) extra_body.setdefault("reasoning_split", True) return payload # Kwargs forwarded from user config to ChatOpenAI _PASSTHROUGH_KWARGS = ( "timeout", "max_retries", "reasoning_effort", "temperature", "api_key", "callbacks", "http_client", "http_async_client", ) # Provider base URLs. API-key env vars live in api_key_env.PROVIDER_API_KEY_ENV # (one canonical mapping consulted by both this client and the CLI's # interactive key-prompt). Dual-region providers (qwen/glm/minimax) keep # separate endpoints because international and China accounts cannot share # credentials (#758). _PROVIDER_BASE_URL = { "xai": "https://api.x.ai/v1", "deepseek": "https://api.deepseek.com", "qwen": "https://dashscope-intl.aliyuncs.com/compatible-mode/v1", "qwen-cn": "https://dashscope.aliyuncs.com/compatible-mode/v1", "glm": "https://api.z.ai/api/paas/v4/", "glm-cn": "https://open.bigmodel.cn/api/paas/v4/", "minimax": "https://api.minimax.io/v1", "minimax-cn": "https://api.minimaxi.com/v1", "openrouter": "https://openrouter.ai/api/v1", "ollama": "http://localhost:11434/v1", } def _resolve_provider_base_url(provider: str) -> Optional[str]: """Default base URL for ``provider``, with env-var overrides where defined. Currently only Ollama supports an env-var override (``OLLAMA_BASE_URL``), matching the convention in the broader Ollama tooling ecosystem so users can point at a remote ollama-serve without editing code. The check is call-time, not import-time, so tests that monkeypatch the env after import behave correctly. """ if provider == "ollama": env_url = os.environ.get("OLLAMA_BASE_URL") if env_url: return env_url return _PROVIDER_BASE_URL.get(provider) class OpenAIClient(BaseLLMClient): """Client for OpenAI, Ollama, OpenRouter, and xAI providers. For native OpenAI models, uses the Responses API (/v1/responses) which supports reasoning_effort with function tools across all model families (GPT-4.1, GPT-5). Third-party compatible providers (xAI, OpenRouter, Ollama) use standard Chat Completions. """ def __init__( self, model: str, base_url: Optional[str] = None, provider: str = "openai", **kwargs, ): super().__init__(model, base_url, **kwargs) self.provider = provider.lower() def get_llm(self) -> Any: """Return configured ChatOpenAI instance.""" self.warn_if_unknown_model() llm_kwargs = {"model": self.model} # Provider-specific base URL and auth. An explicit base_url on the # client (e.g. a corporate proxy) takes precedence over the # provider default so users can route through their own gateway. if self.provider in _PROVIDER_BASE_URL: llm_kwargs["base_url"] = self.base_url or _resolve_provider_base_url(self.provider) api_key_env = get_api_key_env(self.provider) if api_key_env: api_key = os.environ.get(api_key_env) if api_key: llm_kwargs["api_key"] = api_key else: raise ValueError( f"API key for provider '{self.provider}' is not set. " f"Please set the {api_key_env} environment variable " f"(e.g. add {api_key_env}=your_key to your .env file)." ) else: llm_kwargs["api_key"] = "ollama" elif self.base_url: llm_kwargs["base_url"] = self.base_url # Forward user-provided kwargs for key in _PASSTHROUGH_KWARGS: if key in self.kwargs: llm_kwargs[key] = self.kwargs[key] # Native OpenAI: use Responses API for consistent behavior across # all model families. Third-party providers use Chat Completions. if self.provider == "openai": llm_kwargs["use_responses_api"] = True # Provider-specific quirks live in their own subclasses so the # base NormalizedChatOpenAI stays free of provider branches. if self.provider == "deepseek": chat_cls = DeepSeekChatOpenAI elif self.provider in ("minimax", "minimax-cn"): chat_cls = MinimaxChatOpenAI else: chat_cls = NormalizedChatOpenAI return chat_cls(**llm_kwargs) def validate_model(self) -> bool: """Validate model for the provider.""" return validate_model(self.provider, self.model)