Merge pull request #3214 from openai/docs/readme-gpt-5.5

Update README models to gpt-5.5 and gpt-realtime-2

Author: apcha-oai

README.md

@@ -36,7 +36,7 @@ client = OpenAI(
 )
 
 response = client.responses.create(
-    model="gpt-5.2",
+    model="gpt-5.5",
     instructions="You are a coding assistant that talks like a pirate.",
     input="How do I check if a Python object is an instance of a class?",
 )
@@ -52,7 +52,7 @@ from openai import OpenAI
 client = OpenAI()
 
 completion = client.chat.completions.create(
-    model="gpt-5.2",
+    model="gpt-5.5",
     messages=[
         {"role": "developer", "content": "Talk like a pirate."},
         {
@@ -92,7 +92,7 @@ client = OpenAI(
 )
 
 response = client.chat.completions.create(
-    model="gpt-4",
+    model="gpt-5.5",
     messages=[{"role": "user", "content": "Hello!"}],
 )
 ```
@@ -176,7 +176,7 @@ prompt = "What is in this image?"
 img_url = "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d5/2023_06_08_Raccoon1.jpg/1599px-2023_06_08_Raccoon1.jpg"
 
 response = client.responses.create(
-    model="gpt-5.2",
+    model="gpt-5.5",
     input=[
         {
             "role": "user",
@@ -202,7 +202,7 @@ with open("path/to/image.png", "rb") as image_file:
     b64_image = base64.b64encode(image_file.read()).decode("utf-8")
 
 response = client.responses.create(
-    model="gpt-5.2",
+    model="gpt-5.5",
     input=[
         {
             "role": "user",
@@ -232,7 +232,7 @@ client = AsyncOpenAI(
 
 async def main() -> None:
     response = await client.responses.create(
-        model="gpt-5.2", input="Explain disestablishmentarianism to a smart five year old."
+        model="gpt-5.5", input="Explain disestablishmentarianism to a smart five year old."
     )
     print(response.output_text)
 
@@ -274,7 +274,7 @@ async def main() -> None:
                     "content": "Say this is a test",
                 }
             ],
-            model="gpt-5.2",
+            model="gpt-5.5",
         )
 
 
@@ -291,7 +291,7 @@ from openai import OpenAI
 client = OpenAI()
 
 stream = client.responses.create(
-    model="gpt-5.2",
+    model="gpt-5.5",
     input="Write a one-sentence bedtime story about a unicorn.",
     stream=True,
 )
@@ -311,7 +311,7 @@ client = AsyncOpenAI()
 
 async def main():
     stream = await client.responses.create(
-        model="gpt-5.2",
+        model="gpt-5.5",
         input="Write a one-sentence bedtime story about a unicorn.",
         stream=True,
     )
@@ -340,7 +340,7 @@ from openai import AsyncOpenAI
 async def main():
     client = AsyncOpenAI()
 
-    async with client.realtime.connect(model="gpt-realtime") as connection:
+    async with client.realtime.connect(model="gpt-realtime-2") as connection:
         await connection.session.update(
             session={"type": "realtime", "output_modalities": ["text"]}
         )
@@ -376,7 +376,7 @@ Whenever an error occurs, the Realtime API will send an [`error` event](https://
 ```py
 client = AsyncOpenAI()
 
-async with client.realtime.connect(model="gpt-realtime") as connection:
+async with client.realtime.connect(model="gpt-realtime-2") as connection:
     ...
     async for event in connection:
         if event.type == 'error':
@@ -475,15 +475,15 @@ from openai import OpenAI
 
 client = OpenAI()
 
-response = client.chat.responses.create(
+response = client.responses.create(
     input=[
         {
             "role": "user",
             "content": "How much ?",
         }
     ],
-    model="gpt-5.2",
-    response_format={"type": "json_object"},
+    model="gpt-5.5",
+    text={"format": {"type": "json_object"}},
 )
 ```
 
@@ -637,7 +637,7 @@ All object responses in the SDK provide a `_request_id` property which is added
 
 ```python
 response = await client.responses.create(
-    model="gpt-5.2",
+    model="gpt-5.5",
     input="Say 'this is a test'.",
 )
 print(response._request_id)  # req_123
@@ -655,7 +655,7 @@ import openai
 
 try:
     completion = await client.chat.completions.create(
-        messages=[{"role": "user", "content": "Say this is a test"}], model="gpt-5.2"
+        messages=[{"role": "user", "content": "Say this is a test"}], model="gpt-5.5"
     )
 except openai.APIStatusError as exc:
     print(exc.request_id)  # req_123
@@ -687,7 +687,7 @@ client.with_options(max_retries=5).chat.completions.create(
             "content": "How can I get the name of the current day in JavaScript?",
         }
     ],
-    model="gpt-5.2",
+    model="gpt-5.5",
 )
 ```
 
@@ -718,7 +718,7 @@ client.with_options(timeout=5.0).chat.completions.create(
             "content": "How can I list all files in a directory using Python?",
         }
     ],
-    model="gpt-5.2",
+    model="gpt-5.5",
 )
 ```
 
@@ -765,7 +765,7 @@ response = client.chat.completions.with_raw_response.create(
         "role": "user",
         "content": "Say this is a test",
     }],
-    model="gpt-5.2",
+    model="gpt-5.5",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -798,7 +798,7 @@ with client.chat.completions.with_streaming_response.create(
             "content": "Say this is a test",
         }
     ],
-    model="gpt-5.2",
+    model="gpt-5.5",
 ) as response:
     print(response.headers.get("X-My-Header"))