release: 1.23.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.22.0"
+  ".": "1.23.0"
 }

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.23.0 (2024-04-18)
+
+Full Changelog: [v1.22.0...v1.23.0](https://github.com/openai/openai-python/compare/v1.22.0...v1.23.0)
+
+### Features
+
+* **api:** add request id property to response classes ([#1341](https://github.com/openai/openai-python/issues/1341)) ([444d680](https://github.com/openai/openai-python/commit/444d680cbb3745adbc27788213ae3312567136a8))
+
+
+### Documentation
+
+* **helpers:** fix example snippets ([#1339](https://github.com/openai/openai-python/issues/1339)) ([8929088](https://github.com/openai/openai-python/commit/8929088b206a04b4c5b85fb69b0b983fb56f9b03))
+
 ## 1.22.0 (2024-04-18)
 
 Full Changelog: [v1.21.2...v1.22.0](https://github.com/openai/openai-python/compare/v1.21.2...v1.22.0)

examples/demo.py

@@ -36,3 +36,18 @@
 
     print(chunk.choices[0].delta.content, end="")
 print()
+
+# Response headers:
+print("----- custom response headers test -----")
+response = client.chat.completions.with_raw_response.create(
+    model="gpt-4",
+    messages=[
+        {
+            "role": "user",
+            "content": "Say this is a test",
+        }
+    ],
+)
+completion = response.parse()
+print(response.request_id)
+print(completion.choices[0].message.content)

helpers.md

@@ -33,11 +33,13 @@ class EventHandler(AssistantEventHandler):
   def on_text_delta(self, delta: TextDelta, snapshot: Text):
     print(delta.value, end="", flush=True)
 
+  @override
   def on_tool_call_created(self, tool_call: ToolCall):
     print(f"\nassistant > {tool_call.type}\n", flush=True)
 
+  @override
   def on_tool_call_delta(self, delta: ToolCallDelta, snapshot: ToolCall):
-    if delta.type == 'code_interpreter':
+    if delta.type == "code_interpreter" and delta.code_interpreter:
       if delta.code_interpreter.input:
         print(delta.code_interpreter.input, end="", flush=True)
       if delta.code_interpreter.outputs:
@@ -69,7 +71,7 @@ with client.beta.threads.runs.stream(
 ) as stream:
     for event in stream:
         # Print the text from text delta events
-        if event.type == "thread.message.delta" and event.data.delta.content:
+        if event.event == "thread.message.delta" and event.data.delta.content:
             print(event.data.delta.content[0].text)
 ```
 

pyproject.toml

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

src/openai/_legacy_response.py

@@ -71,6 +71,10 @@ def __init__(
         self._options = options
         self.http_response = raw
 
+    @property
+    def request_id(self) -> str | None:
+        return self.http_response.headers.get("x-request-id")  # type: ignore[no-any-return]
+
     @overload
     def parse(self, *, to: type[_T]) -> _T:
         ...

src/openai/_response.py

@@ -258,6 +258,10 @@ def _parse(self, *, to: type[_T] | None = None) -> R | _T:
 
 
 class APIResponse(BaseAPIResponse[R]):
+    @property
+    def request_id(self) -> str | None:
+        return self.http_response.headers.get("x-request-id")  # type: ignore[no-any-return]
+
     @overload
     def parse(self, *, to: type[_T]) -> _T:
         ...
@@ -362,6 +366,10 @@ def iter_lines(self) -> Iterator[str]:
 
 
 class AsyncAPIResponse(BaseAPIResponse[R]):
+    @property
+    def request_id(self) -> str | None:
+        return self.http_response.headers.get("x-request-id")  # type: ignore[no-any-return]
+
     @overload
     async def parse(self, *, to: type[_T]) -> _T:
         ...

src/openai/_version.py

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