_get_request_payload() — langchain Function Reference

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

Function python LangChainCore LanguageModelBase

Entity Profile

LangChainCore→ LanguageModelBase→ _get_request_payload() — langchain Function Reference

Dependency Diagram

graph TD
  9a8bf9b3_c469_d477_066b_a116152fe27f["_get_request_payload()"]
  4b940a4c_8618_3ca0_9fa5_c378f5b8f6ac["AzureChatOpenAI"]
  9a8bf9b3_c469_d477_066b_a116152fe27f -->|defined in| 4b940a4c_8618_3ca0_9fa5_c378f5b8f6ac
  style 9a8bf9b3_c469_d477_066b_a116152fe27f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/partners/openai/langchain_openai/chat_models/azure.py lines 796–814

    def _get_request_payload(
        self,
        input_: LanguageModelInput,
        *,
        stop: list[str] | None = None,
        **kwargs: Any,
    ) -> dict:
        """Get the request payload, using deployment name for Azure Responses API."""
        payload = super()._get_request_payload(input_, stop=stop, **kwargs)

        # For Azure Responses API, use deployment name instead of model name
        if (
            self._use_responses_api(payload)
            and not payload.get("model")
            and self.deployment_name
        ):
            payload["model"] = self.deployment_name

        return payload