release: 1.98.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.97.2"
+  ".": "1.98.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-b2a451656ca64d30d174391ebfd94806b4de3ab76dc55b92843cfb7f1a54ecb6.yml
-openapi_spec_hash: 27d9691b400f28c17ef063a1374048b0
-config_hash: e822d0c9082c8b312264403949243179
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-721e6ccaa72205ee14c71f8163129920464fb814b95d3df9567a9476bbd9b7fb.yml
+openapi_spec_hash: 2115413a21df8b5bf9e4552a74df4312
+config_hash: 9606bb315a193bfd8da0459040143242

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.98.0 (2025-07-30)
+
+Full Changelog: [v1.97.2...v1.98.0](https://github.com/openai/openai-python/compare/v1.97.2...v1.98.0)
+
+### Features
+
+* **api:** manual updates ([88a8036](https://github.com/openai/openai-python/commit/88a8036c5ea186f36c57029ef4501a0833596f56))
+
 ## 1.97.2 (2025-07-30)
 
 Full Changelog: [v1.97.1...v1.97.2](https://github.com/openai/openai-python/compare/v1.97.1...v1.97.2)

pyproject.toml

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

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.97.2"  # x-release-please-version
+__version__ = "1.98.0"  # x-release-please-version

src/openai/types/chat/__init__.py

@@ -28,7 +28,9 @@
 from .chat_completion_store_message import ChatCompletionStoreMessage as ChatCompletionStoreMessage
 from .chat_completion_token_logprob import ChatCompletionTokenLogprob as ChatCompletionTokenLogprob
 from .chat_completion_reasoning_effort import ChatCompletionReasoningEffort as ChatCompletionReasoningEffort
+from .chat_completion_content_part_text import ChatCompletionContentPartText as ChatCompletionContentPartText
 from .chat_completion_message_tool_call import ChatCompletionMessageToolCall as ChatCompletionMessageToolCall
+from .chat_completion_content_part_image import ChatCompletionContentPartImage as ChatCompletionContentPartImage
 from .chat_completion_content_part_param import ChatCompletionContentPartParam as ChatCompletionContentPartParam
 from .chat_completion_tool_message_param import ChatCompletionToolMessageParam as ChatCompletionToolMessageParam
 from .chat_completion_user_message_param import ChatCompletionUserMessageParam as ChatCompletionUserMessageParam

src/openai/types/chat/chat_completion_content_part_image.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ChatCompletionContentPartImage", "ImageURL"]
+
+
+class ImageURL(BaseModel):
+    url: str
+    """Either a URL of the image or the base64 encoded image data."""
+
+    detail: Optional[Literal["auto", "low", "high"]] = None
+    """Specifies the detail level of the image.
+
+    Learn more in the
+    [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding).
+    """
+
+
+class ChatCompletionContentPartImage(BaseModel):
+    image_url: ImageURL
+
+    type: Literal["image_url"]
+    """The type of the content part."""

src/openai/types/chat/chat_completion_content_part_text.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ChatCompletionContentPartText"]
+
+
+class ChatCompletionContentPartText(BaseModel):
+    text: str
+    """The text content."""
+
+    type: Literal["text"]
+    """The type of the content part."""

src/openai/types/chat/chat_completion_store_message.py

@@ -1,10 +1,23 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing import List, Union, Optional
+from typing_extensions import TypeAlias
+
 from .chat_completion_message import ChatCompletionMessage
+from .chat_completion_content_part_text import ChatCompletionContentPartText
+from .chat_completion_content_part_image import ChatCompletionContentPartImage
+
+__all__ = ["ChatCompletionStoreMessage", "ChatCompletionStoreMessageContentPart"]
 
-__all__ = ["ChatCompletionStoreMessage"]
+ChatCompletionStoreMessageContentPart: TypeAlias = Union[ChatCompletionContentPartText, ChatCompletionContentPartImage]
 
 
 class ChatCompletionStoreMessage(ChatCompletionMessage):
     id: str
     """The identifier of the chat message."""
+
+    content_parts: Optional[List[ChatCompletionStoreMessageContentPart]] = None
+    """
+    If a content parts array was provided, this is an array of `text` and
+    `image_url` parts. Otherwise, null.
+    """

src/openai/types/chat/completion_create_params.py

@@ -177,6 +177,13 @@ class CompletionCreateParamsBase(TypedDict, total=False):
     far, increasing the model's likelihood to talk about new topics.
     """
 
+    prompt_cache_key: str
+    """
+    Used by OpenAI to cache responses for similar requests to optimize your cache
+    hit rates. Replaces the `user` field.
+    [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+    """
+
     reasoning_effort: Optional[ReasoningEffort]
     """**o-series models only**
 
@@ -199,6 +206,15 @@ class CompletionCreateParamsBase(TypedDict, total=False):
     preferred for models that support it.
     """
 
+    safety_identifier: str
+    """
+    A stable identifier used to help detect users of your application that may be
+    violating OpenAI's usage policies. The IDs should be a string that uniquely
+    identifies each user. We recommend hashing their username or email address, in
+    order to avoid sending us any identifying information.
+    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+    """
+
     seed: Optional[int]
     """
     This feature is in Beta. If specified, our system will make a best effort to
@@ -293,11 +309,12 @@ class CompletionCreateParamsBase(TypedDict, total=False):
     """
 
     user: str
-    """A stable identifier for your end-users.
+    """This field is being replaced by `safety_identifier` and `prompt_cache_key`.
 
-    Used to boost cache hit rates by better bucketing similar requests and to help
-    OpenAI detect and prevent abuse.
-    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+    Use `prompt_cache_key` instead to maintain caching optimizations. A stable
+    identifier for your end-users. Used to boost cache hit rates by better bucketing
+    similar requests and to help OpenAI detect and prevent abuse.
+    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
     """
 
     web_search_options: WebSearchOptions

src/openai/types/responses/response.py

@@ -163,13 +163,29 @@ class Response(BaseModel):
     [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
     """
 
+    prompt_cache_key: Optional[str] = None
+    """
+    Used by OpenAI to cache responses for similar requests to optimize your cache
+    hit rates. Replaces the `user` field.
+    [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+    """
+
     reasoning: Optional[Reasoning] = None
     """**o-series models only**
 
     Configuration options for
     [reasoning models](https://platform.openai.com/docs/guides/reasoning).
     """
 
+    safety_identifier: Optional[str] = None
+    """
+    A stable identifier used to help detect users of your application that may be
+    violating OpenAI's usage policies. The IDs should be a string that uniquely
+    identifies each user. We recommend hashing their username or email address, in
+    order to avoid sending us any identifying information.
+    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+    """
+
     service_tier: Optional[Literal["auto", "default", "flex", "scale", "priority"]] = None
     """Specifies the processing type used for serving the request.
 
@@ -229,11 +245,12 @@ class Response(BaseModel):
     """
 
     user: Optional[str] = None
-    """A stable identifier for your end-users.
+    """This field is being replaced by `safety_identifier` and `prompt_cache_key`.
 
-    Used to boost cache hit rates by better bucketing similar requests and to help
-    OpenAI detect and prevent abuse.
-    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+    Use `prompt_cache_key` instead to maintain caching optimizations. A stable
+    identifier for your end-users. Used to boost cache hit rates by better bucketing
+    similar requests and to help OpenAI detect and prevent abuse.
+    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
     """
 
     @property

src/openai/types/responses/response_create_params.py

@@ -123,13 +123,29 @@ class ResponseCreateParamsBase(TypedDict, total=False):
     [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
     """
 
+    prompt_cache_key: str
+    """
+    Used by OpenAI to cache responses for similar requests to optimize your cache
+    hit rates. Replaces the `user` field.
+    [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+    """
+
     reasoning: Optional[Reasoning]
     """**o-series models only**
 
     Configuration options for
     [reasoning models](https://platform.openai.com/docs/guides/reasoning).
     """
 
+    safety_identifier: str
+    """
+    A stable identifier used to help detect users of your application that may be
+    violating OpenAI's usage policies. The IDs should be a string that uniquely
+    identifies each user. We recommend hashing their username or email address, in
+    order to avoid sending us any identifying information.
+    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+    """
+
     service_tier: Optional[Literal["auto", "default", "flex", "scale", "priority"]]
     """Specifies the processing type used for serving the request.
 
@@ -221,11 +237,12 @@ class ResponseCreateParamsBase(TypedDict, total=False):
     """
 
     user: str
-    """A stable identifier for your end-users.
+    """This field is being replaced by `safety_identifier` and `prompt_cache_key`.
 
-    Used to boost cache hit rates by better bucketing similar requests and to help
-    OpenAI detect and prevent abuse.
-    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+    Use `prompt_cache_key` instead to maintain caching optimizations. A stable
+    identifier for your end-users. Used to boost cache hit rates by better bucketing
+    similar requests and to help OpenAI detect and prevent abuse.
+    [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
     """
 
 

tests/api_resources/chat/test_completions.py

@@ -72,8 +72,10 @@ def test_method_create_with_all_params_overload_1(self, client: OpenAI) -> None:
                 "type": "content",
             },
             presence_penalty=-2,
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning_effort="low",
             response_format={"type": "text"},
+            safety_identifier="safety-identifier-1234",
             seed=-9007199254740991,
             service_tier="auto",
             stop="\n",
@@ -199,8 +201,10 @@ def test_method_create_with_all_params_overload_2(self, client: OpenAI) -> None:
                 "type": "content",
             },
             presence_penalty=-2,
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning_effort="low",
             response_format={"type": "text"},
+            safety_identifier="safety-identifier-1234",
             seed=-9007199254740991,
             service_tier="auto",
             stop="\n",
@@ -501,8 +505,10 @@ async def test_method_create_with_all_params_overload_1(self, async_client: Asyn
                 "type": "content",
             },
             presence_penalty=-2,
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning_effort="low",
             response_format={"type": "text"},
+            safety_identifier="safety-identifier-1234",
             seed=-9007199254740991,
             service_tier="auto",
             stop="\n",
@@ -628,8 +634,10 @@ async def test_method_create_with_all_params_overload_2(self, async_client: Asyn
                 "type": "content",
             },
             presence_penalty=-2,
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning_effort="low",
             response_format={"type": "text"},
+            safety_identifier="safety-identifier-1234",
             seed=-9007199254740991,
             service_tier="auto",
             stop="\n",

tests/api_resources/test_responses.py

@@ -43,11 +43,13 @@ def test_method_create_with_all_params_overload_1(self, client: OpenAI) -> None:
                 "variables": {"foo": "string"},
                 "version": "version",
             },
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning={
                 "effort": "low",
                 "generate_summary": "auto",
                 "summary": "auto",
             },
+            safety_identifier="safety-identifier-1234",
             service_tier="auto",
             store=True,
             stream=False,
@@ -116,11 +118,13 @@ def test_method_create_with_all_params_overload_2(self, client: OpenAI) -> None:
                 "variables": {"foo": "string"},
                 "version": "version",
             },
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning={
                 "effort": "low",
                 "generate_summary": "auto",
                 "summary": "auto",
             },
+            safety_identifier="safety-identifier-1234",
             service_tier="auto",
             store=True,
             temperature=1,
@@ -380,11 +384,13 @@ async def test_method_create_with_all_params_overload_1(self, async_client: Asyn
                 "variables": {"foo": "string"},
                 "version": "version",
             },
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning={
                 "effort": "low",
                 "generate_summary": "auto",
                 "summary": "auto",
             },
+            safety_identifier="safety-identifier-1234",
             service_tier="auto",
             store=True,
             stream=False,
@@ -453,11 +459,13 @@ async def test_method_create_with_all_params_overload_2(self, async_client: Asyn
                 "variables": {"foo": "string"},
                 "version": "version",
             },
+            prompt_cache_key="prompt-cache-key-1234",
             reasoning={
                 "effort": "low",
                 "generate_summary": "auto",
                 "summary": "auto",
             },
+            safety_identifier="safety-identifier-1234",
             service_tier="auto",
             store=True,
             temperature=1,