Method _build_request

src/openai/_base_client.py:498–604

(
        self,
        options: FinalRequestOptions,
        *,
        retries_taken: int = 0,
    )

        return SSEDecoder()

    def _build_request(
        self,
        options: FinalRequestOptions,
        *,
        retries_taken: int = 0,
    ) -> httpx.Request:
        if log.isEnabledFor(logging.DEBUG):
            log.debug(
                class="st">"Request options: %s",
                model_dump(
                    options,
                    exclude_unset=True,
                    class="cm"># Pydantic v1 can't dump every type we support in content, so we exclude it for now.
                    exclude={
                        class="st">"content",
                    }
                    if PYDANTIC_V1
                    else {},
                ),
            )
        kwargs: dict[str, Any] = {}

        json_data = options.json_data
        if options.extra_json is not None:
            if json_data is None:
                json_data = cast(Body, options.extra_json)
            elif is_mapping(json_data):
                json_data = _merge_mappings(json_data, options.extra_json)
            else:
                raise RuntimeError(fclass="st">"Unexpected JSON data type, {type(json_data)}, cannot merge with `extra_body`")

        headers = self._build_headers(options, retries_taken=retries_taken)
        params = _merge_mappings({**self._auth_query(options.security), **self.default_query}, options.params)
        content_type = headers.get(class="st">"Content-Type")
        files = options.files

        class="cm"># If the given Content-Type header is multipart/form-data then it
        class="cm"># has to be removed so that httpx can generate the header with
        class="cm"># additional information for us as it has to be in this form
        class="cm"># for the server to be able to correctly parse the request:
        class="cm"># multipart/form-data; boundary=---abc--
        if content_type is not None and content_type.startswith(class="st">"multipart/form-data"):
            if class="st">"boundary" not in content_type:
                class="cm"># only remove the header if the boundary hasn't been explicitly set
                class="cm"># as the caller doesn't want httpx to come up with their own boundary
                headers.pop(class="st">"Content-Type")

            class="cm"># As we are now sending multipart/form-data instead of application/json
            class="cm"># we need to tell httpx to use it, https://www.python-httpx.org/advanced/clients/#multipart-file-encoding
            if json_data:
                if not is_dict(json_data):
                    raise TypeError(
                        fclass="st">"Expected query input to be a dictionary for multipart requests but got {type(json_data)} instead."
                    )
                kwargs[class="st">"data"] = self._serialize_multipartform(json_data)

            class="cm"># httpx determines whether or not to send a class="st">"multipart/form-data"
            class="cm"># request based on the truthiness of the class="st">"files" argument.