Class FinalRequestOptions

src/openai/_models.py:938–1005

@final
class FinalRequestOptions(pydantic.BaseModel):
    method: str
    url: str
    params: Query = {}
    headers: Union[Headers, NotGiven] = NotGiven()
    max_retries: Union[int, NotGiven] = NotGiven()
    timeout: Union[float, Timeout, None, NotGiven] = NotGiven()
    files: Union[HttpxRequestFiles, None] = None
    idempotency_key: Union[str, None] = None
    post_parser: Union[Callable[[Any], Any], NotGiven] = NotGiven()
    follow_redirects: Union[bool, None] = None
    security: SecurityOptions = {
        class="st">"bearer_auth": True,
        class="st">"admin_api_key_auth": True,
    }
    synthesize_event_and_data: Optional[bool] = None

    content: Union[bytes, bytearray, IO[bytes], Iterable[bytes], AsyncIterable[bytes], None] = None
    class="cm"># It should be noted that we cannot use `json` here as that would override
    class="cm"># a BaseModel method in an incompatible fashion.
    json_data: Union[Body, None] = None
    extra_json: Union[AnyMapping, None] = None

    if PYDANTIC_V1:

        class Config(pydantic.BaseConfig):  class="cm"># pyright: ignore[reportDeprecated]
            arbitrary_types_allowed: bool = True
    else:
        model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True)

    def get_max_retries(self, max_retries: int) -> int:
        if isinstance(self.max_retries, NotGiven):
            return max_retries
        return self.max_retries

    def _strip_raw_response_header(self) -> None:
        if not is_given(self.headers):
            return

        if self.headers.get(RAW_RESPONSE_HEADER):
            self.headers = {**self.headers}
            self.headers.pop(RAW_RESPONSE_HEADER)

    class="cm"># override the `construct` method so that we can run custom transformations.
    class="cm"># this is necessary as we don't want to do any actual runtime type checking
    class="cm"># (which means we can't use validators) but we do want to ensure that `NotGiven`
    class="cm"># values are not present
    class="cm">#
    class="cm"># type ignore required because we're adding explicit types to `**values`
    @classmethod
    def construct(  class="cm"># type: ignore
        cls,
        _fields_set: set[str] | None = None,
        **values: Unpack[FinalRequestOptionsInput],
    ) -> FinalRequestOptions:
        kwargs: dict[str, Any] = {
            class="cm"># we unconditionally call `strip_not_given` on any value
            class="cm"># as it will just ignore any non-mapping types