From 55efa8cad0abaeebcab02c66b3bc50d88cbe1fee Mon Sep 17 00:00:00 2001
From: Jason Liu <jason@jxnl.co>
Date: Mon, 13 Nov 2023 17:23:59 -0500
Subject: [PATCH] mention-raw-response

---
 docs/index.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/index.md b/docs/index.md
index 62e2135..d73cae8 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -152,6 +152,24 @@ assert user.name == "Jason"
 assert user.age == 25
 ```
 
+!!! note "Accessing the original response"
+
+    If you want to access anything like usage or other metadata, the original response is available on the `Model._raw_response` attribute.
+
+    ```python
+    user: UserDetail = client.chat.completions.create(
+        model="gpt-3.5-turbo",
+        response_model=UserDetail,
+        messages=[
+            {"role": "user", "content": "Extract Jason is 25 years old"},
+        ]
+    )
+
+    from openai.types.chat.chat_completion import ChatCompletion
+
+    assert isinstance(user._raw_response, ChatCompletion)
+    ```
+
 ## Pydantic Validation
 
 Validation can also be plugged into the same Pydantic model. Here, if the answer attribute contains content that violates the rule "don't say objectionable things," Pydantic will raise a validation error.