sdk(python): add support for client_request_id -> X-Client-Request-Id

Author: arvindg-openai

README.md

@@ -678,6 +678,12 @@ print(completion)
 
 These methods return a [`LegacyAPIResponse`](https://github.com/openai/openai-python/tree/main/src/openai/_legacy_response.py) object. This is a legacy class as we're changing it slightly in the next major version.
 
+Tag your own requests for easier support follow-up:
+
+```py
+client.responses.create(..., extra_headers={"X-Client-Request-Id": "123e4567-e89b-12d3-a456-426614174000"})
+```
+
 For the sync client this will mostly be the same with the exception
 of `content` & `text` will be methods instead of properties. In the
 async client, all methods will be async.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "openai"
-version = "2.7.1"
+version = "2.7.2"
 description = "The official Python library for the openai API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/openai/_base_client.py

@@ -438,6 +438,22 @@ def _build_headers(self, options: FinalRequestOptions, *, retries_taken: int = 0
 # headers are case-insensitive while dictionaries are not.
 headers=httpx.Headers(headers_dict)
 
+option_client_request_id=options.client_request_id
+ifoption_client_request_id:
+headers["X-Client-Request-Id"] =option_client_request_id
+else:
+client_request_id_header=None
+forkey, valueincustom_headers.items():
+ifkey.lower() !="x-client-request-id":
+continue
+ifisinstance(value, Omit) orvaluein (None, ""):
+break
+client_request_id_header=str(value)
+break
+
+ifclient_request_id_header:
+headers["X-Client-Request-Id"] =client_request_id_header
+
 idempotency_header=self._idempotency_header
 ifidempotency_headerandoptions.idempotency_keyandidempotency_headernotinheaders:
 headers[idempotency_header] =options.idempotency_key
@@ -1850,6 +1866,7 @@ def make_request_options(
 extra_query: Query|None=None,
 extra_body: Body|None=None,
 idempotency_key: str|None=None,
+client_request_id: str|None=None,
 timeout: float|httpx.Timeout|None|NotGiven=not_given,
 post_parser: PostParser|NotGiven=not_given,
 ) ->RequestOptions:
@@ -1873,6 +1890,9 @@ def make_request_options(
 ifidempotency_keyisnotNone:
 options["idempotency_key"] =idempotency_key
 
+ifclient_request_id:
+options["client_request_id"] =client_request_id
+
 ifis_given(post_parser):
 # internal
 options["post_parser"] =post_parser# type: ignore

src/openai/_models.py

@@ -805,6 +805,7 @@ class FinalRequestOptionsInput(TypedDict, total=False):
 timeout: float|Timeout|None
 files: HttpxRequestFiles|None
 idempotency_key: str
+client_request_id: str|None
 json_data: Body
 extra_json: AnyMapping
 follow_redirects: bool
@@ -820,6 +821,7 @@ class FinalRequestOptions(pydantic.BaseModel):
 timeout: Union[float, Timeout, None, NotGiven] =NotGiven()
 files: Union[HttpxRequestFiles, None] =None
 idempotency_key: Union[str, None] =None
+client_request_id: Union[str, None] =None
 post_parser: Union[Callable[[Any], Any], NotGiven] =NotGiven()
 follow_redirects: Union[bool, None] =None
 

src/openai/_types.py

@@ -112,6 +112,7 @@ class RequestOptions(TypedDict, total=False):
 params: Query
 extra_json: AnyMapping
 idempotency_key: str
+client_request_id: str|None
 follow_redirects: bool
 
 

src/openai/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__="openai"
-__version__="2.7.1"# x-release-please-version
+__version__="2.7.2"# x-release-please-version

tests/test_client.py

@@ -349,6 +349,29 @@ def test_default_headers_option(self) -> None:
 test_client.close()
 test_client2.close()
 
+deftest_client_request_id_header_from_option(self, client: OpenAI) ->None:
+request=client._build_request(
+FinalRequestOptions(method="get", url="/foo", client_request_id="custom-option-id")
+ )
+
+assertrequest.headers.get("X-Client-Request-Id") =="custom-option-id"
+
+deftest_client_request_id_header_from_custom_headers(self, client: OpenAI) ->None:
+request=client._build_request(
+FinalRequestOptions(
+method="get",
+url="/foo",
+headers={"x-client-request-id": "custom-header-id"},
+ )
+ )
+
+assertrequest.headers.get("X-Client-Request-Id") =="custom-header-id"
+
+deftest_client_request_id_header_absent_when_unspecified(self, client: OpenAI) ->None:
+request=client._build_request(FinalRequestOptions(method="get", url="/foo"))
+
+assertrequest.headers.get("X-Client-Request-Id") isNone
+
 deftest_validate_headers(self) ->None:
 client=OpenAI(base_url=base_url, api_key=api_key, _strict_response_validation=True)
 options=client._prepare_options(FinalRequestOptions(method="get", url="/foo"))