_get_request_payload() — langchain Function Reference

Architecture documentation for the _get_request_payload() function in base.py from the langchain codebase.

Function python LangChainCore LanguageModelBase calls 1 called by 1

Entity Profile

LangChainCore→ LanguageModelBase→ _get_request_payload() — langchain Function Reference

Dependency Diagram

graph TD
  b0fc5f1b_2841_ff5e_06d3_cfa84a6522f6["_get_request_payload()"]
  29c504f8_01a0_5f4c_3ec6_14bbf14b96eb["ChatOpenAI"]
  b0fc5f1b_2841_ff5e_06d3_cfa84a6522f6 -->|defined in| 29c504f8_01a0_5f4c_3ec6_14bbf14b96eb
  36b15b48_0822_029c_4a53_8243405e5a5e["_get_request_payload()"]
  36b15b48_0822_029c_4a53_8243405e5a5e -->|calls| b0fc5f1b_2841_ff5e_06d3_cfa84a6522f6
  36b15b48_0822_029c_4a53_8243405e5a5e["_get_request_payload()"]
  b0fc5f1b_2841_ff5e_06d3_cfa84a6522f6 -->|calls| 36b15b48_0822_029c_4a53_8243405e5a5e
  style b0fc5f1b_2841_ff5e_06d3_cfa84a6522f6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/partners/openai/langchain_openai/chat_models/base.py lines 3043–3061

    def _get_request_payload(
        self,
        input_: LanguageModelInput,
        *,
        stop: list[str] | None = None,
        **kwargs: Any,
    ) -> dict:
        payload = super()._get_request_payload(input_, stop=stop, **kwargs)
        # max_tokens was deprecated in favor of max_completion_tokens
        # in September 2024 release
        if "max_tokens" in payload:
            payload["max_completion_tokens"] = payload.pop("max_tokens")

        # Mutate system message role to "developer" for o-series models
        if self.model_name and re.match(r"^o\d", self.model_name):
            for message in payload.get("messages", []):
                if message["role"] == "system":
                    message["role"] = "developer"
        return payload