langchain Architecture Docs
Home / Function/ _get_request_payload() — langchain Function Reference

_get_request_payload() — langchain Function Reference

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

Function python CoreAbstractions MessageSchema calls 5 called by 7

Entity Profile

Dependency Diagram

graph TD
  19833ed1_212f_748a_c465_4c311b99c303["_get_request_payload()"]
  6acbd332_f387_0c7a_34ab_a3d88a1064cb["BaseChatOpenAI"]
  19833ed1_212f_748a_c465_4c311b99c303 -->|defined in| 6acbd332_f387_0c7a_34ab_a3d88a1064cb
  4e60455d_9607_026a_e62c_daaae8d8fd32["_stream_responses()"]
  4e60455d_9607_026a_e62c_daaae8d8fd32 -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  ebb797f8_e145_5d6a_5451_7f2333a7f64f["_astream_responses()"]
  ebb797f8_e145_5d6a_5451_7f2333a7f64f -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  be11bdd9_20e6_0d66_ee45_45175189364d["_stream()"]
  be11bdd9_20e6_0d66_ee45_45175189364d -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  ebd1bfb1_67ad_e1e6_3202_04ca697dfd47["_generate()"]
  ebd1bfb1_67ad_e1e6_3202_04ca697dfd47 -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  6786ef19_3f66_ba7c_9786_8e30addcc463["_astream()"]
  6786ef19_3f66_ba7c_9786_8e30addcc463 -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  dcbd739a_66ae_915f_7087_234dec7749be["_agenerate()"]
  dcbd739a_66ae_915f_7087_234dec7749be -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  da97c4ea_cf99_7c1e_3bcf_0b2d4d776d3a["_get_request_payload()"]
  da97c4ea_cf99_7c1e_3bcf_0b2d4d776d3a -->|calls| 19833ed1_212f_748a_c465_4c311b99c303
  da97c4ea_cf99_7c1e_3bcf_0b2d4d776d3a["_get_request_payload()"]
  19833ed1_212f_748a_c465_4c311b99c303 -->|calls| da97c4ea_cf99_7c1e_3bcf_0b2d4d776d3a
  7aedebfb_b538_7587_13d3_3f152fcf1f15["_get_last_messages()"]
  19833ed1_212f_748a_c465_4c311b99c303 -->|calls| 7aedebfb_b538_7587_13d3_3f152fcf1f15
  1782a9b7_5310_befd_b211_b39285a871e1["_construct_responses_api_payload()"]
  19833ed1_212f_748a_c465_4c311b99c303 -->|calls| 1782a9b7_5310_befd_b211_b39285a871e1
  10cb591f_84c2_3141_6777_c175ffc9c8cf["_convert_message_to_dict()"]
  19833ed1_212f_748a_c465_4c311b99c303 -->|calls| 10cb591f_84c2_3141_6777_c175ffc9c8cf
  2a010195_d9d2_2f7b_90b3_c36b77bcde8e["_use_responses_api()"]
  19833ed1_212f_748a_c465_4c311b99c303 -->|calls| 2a010195_d9d2_2f7b_90b3_c36b77bcde8e
  style 19833ed1_212f_748a_c465_4c311b99c303 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/partners/openai/langchain_openai/chat_models/base.py lines 1449–1478

    def _get_request_payload(
        self,
        input_: LanguageModelInput,
        *,
        stop: list[str] | None = None,
        **kwargs: Any,
    ) -> dict:
        messages = self._convert_input(input_).to_messages()
        if stop is not None:
            kwargs["stop"] = stop

        payload = {**self._default_params, **kwargs}

        if self._use_responses_api(payload):
            if self.use_previous_response_id:
                last_messages, previous_response_id = _get_last_messages(messages)
                payload_to_use = last_messages if previous_response_id else messages
                if previous_response_id:
                    payload["previous_response_id"] = previous_response_id
                payload = _construct_responses_api_payload(payload_to_use, payload)
            else:
                payload = _construct_responses_api_payload(messages, payload)
        else:
            payload["messages"] = [
                _convert_message_to_dict(_convert_from_v1_to_chat_completions(m))
                if isinstance(m, AIMessage)
                else _convert_message_to_dict(m)
                for m in messages
            ]
        return payload

Domain

Subdomains

Defined In

Calls

Called By

Source

Frequently Asked Questions

What does _get_request_payload() do?
_get_request_payload() is a function in the langchain codebase, defined in libs/partners/openai/langchain_openai/chat_models/base.py.
Where is _get_request_payload() defined?
_get_request_payload() is defined in libs/partners/openai/langchain_openai/chat_models/base.py at line 1449.
What does _get_request_payload() call?
_get_request_payload() calls 5 function(s): _construct_responses_api_payload, _convert_message_to_dict, _get_last_messages, _get_request_payload, _use_responses_api.
What calls _get_request_payload()?
_get_request_payload() is called by 7 function(s): _agenerate, _astream, _astream_responses, _generate, _get_request_payload, _stream, _stream_responses.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free