Merge pull request #5 from perplexityai/release-please--branches--main--changes--next

Author: kesku

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.12.1"
+  ".": "0.13.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/perplexity-ai%2Fperplexity-aba0c21c569842e93e17b69cae9cee58d389fce9c2482f4d251fd8727db05679.yml
 openapi_spec_hash: 3d01b1c1425f7d43a8acf8b99bb9b321
-config_hash: 43831e7f153f67b8f23f7091d14db066
+config_hash: d7ba8374a217375f59388ce2ae8a5f90

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.13.0 (2025-10-02)
+
+Full Changelog: [v0.12.1...v0.13.0](https://github.com/perplexityai/perplexity-py/compare/v0.12.1...v0.13.0)
+
+### Features
+
+* **api:** manual updates ([f92e6d7](https://github.com/perplexityai/perplexity-py/commit/f92e6d70fd638d895b60227dd33bb7641c169a4f))
+
 ## 0.12.1 (2025-09-30)
 
 Full Changelog: [v0.12.0...v0.12.1](https://github.com/perplexityai/perplexity-py/compare/v0.12.0...v0.12.1)

README.md

@@ -53,7 +53,7 @@ client = Perplexity(
     api_key=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
-completion = client.chat.completions.create(
+stream_chunk = client.chat.completions.create(
     messages=[
         {
             "role": "user",
@@ -62,7 +62,7 @@ completion = client.chat.completions.create(
     ],
     model="sonar",
 )
-print(completion.id)
+print(stream_chunk.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -85,7 +85,7 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    completion = await client.chat.completions.create(
+    stream_chunk = await client.chat.completions.create(
         messages=[
             {
                 "role": "user",
@@ -94,7 +94,7 @@ async def main() -> None:
         ],
         model="sonar",
     )
-    print(completion.id)
+    print(stream_chunk.id)
 
 
 asyncio.run(main())
@@ -126,7 +126,7 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        completion = await client.chat.completions.create(
+        stream_chunk = await client.chat.completions.create(
             messages=[
                 {
                     "role": "user",
@@ -135,12 +135,56 @@ async def main() -> None:
             ],
             model="sonar",
         )
-        print(completion.id)
+        print(stream_chunk.id)
 
 
 asyncio.run(main())
 ```
 
+## Streaming responses
+
+We provide support for streaming responses using Server Side Events (SSE).
+
+```python
+from perplexity import Perplexity
+
+client = Perplexity()
+
+stream = client.chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
+    stream=True,
+)
+for stream_chunk in stream:
+    print(stream_chunk.id)
+```
+
+The async client uses the exact same interface.
+
+```python
+from perplexity import AsyncPerplexity
+
+client = AsyncPerplexity()
+
+stream = await client.chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
+    stream=True,
+)
+async for stream_chunk in stream:
+    print(stream_chunk.id)
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -159,7 +203,7 @@ from perplexity import Perplexity
 
 client = Perplexity()
 
-completion = client.chat.completions.create(
+stream_chunk = client.chat.completions.create(
     messages=[
         {
             "content": "string",
@@ -169,7 +213,7 @@ completion = client.chat.completions.create(
     model="model",
     debug_params={},
 )
-print(completion.debug_params)
+print(stream_chunk.debug_params)
 ```
 
 ## Handling errors

api.md

@@ -12,17 +12,17 @@ from perplexity.types import (
 
 # Chat
 
-## Completions
-
 Types:
 
 ```python
-from perplexity.types.chat import CompletionCreateResponse
+from perplexity.types import StreamChunk
 ```
 
+## Completions
+
 Methods:
 
-- <code title="post /chat/completions">client.chat.completions.<a href="./src/perplexity/resources/chat/completions.py">create</a>(\*\*<a href="src/perplexity/types/chat/completion_create_params.py">params</a>) -> <a href="./src/perplexity/types/chat/completion_create_response.py">CompletionCreateResponse</a></code>
+- <code title="post /chat/completions">client.chat.completions.<a href="./src/perplexity/resources/chat/completions.py">create</a>(\*\*<a href="src/perplexity/types/chat/completion_create_params.py">params</a>) -> <a href="./src/perplexity/types/stream_chunk.py">StreamChunk</a></code>
 
 # Async
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "perplexityai"
-version = "0.12.1"
+version = "0.13.0"
 description = "The official Python library for the perplexity API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/perplexity/_client.py

@@ -105,6 +105,8 @@ def __init__(
             _strict_response_validation=_strict_response_validation,
         )
 
+        self._default_stream_cls = Stream
+
         self.chat = chat.ChatResource(self)
         self.async_ = async_.AsyncResource(self)
         self.search = search.SearchResource(self)
@@ -277,6 +279,8 @@ def __init__(
             _strict_response_validation=_strict_response_validation,
         )
 
+        self._default_stream_cls = AsyncStream
+
         self.chat = chat.AsyncChatResource(self)
         self.async_ = async_.AsyncAsyncResource(self)
         self.search = search.AsyncSearchResource(self)

src/perplexity/_streaming.py

@@ -55,7 +55,26 @@ def __stream__(self) -> Iterator[_T]:
         iterator = self._iter_events()
 
         for sse in iterator:
-            yield process_data(data=sse.json(), cast_to=cast_to, response=response)
+            if sse.data.startswith("[DONE]"):
+                break
+
+            if sse.event == "error":
+                body = sse.data
+
+                try:
+                    body = sse.json()
+                    err_msg = f"{body}"
+                except Exception:
+                    err_msg = sse.data or f"Error code: {response.status_code}"
+
+                raise self._client._make_status_error(
+                    err_msg,
+                    body=body,
+                    response=self.response,
+                )
+
+            if sse.event is None:
+                yield process_data(data=sse.json(), cast_to=cast_to, response=response)
 
         # Ensure the entire stream is consumed
         for _sse in iterator:
@@ -119,7 +138,26 @@ async def __stream__(self) -> AsyncIterator[_T]:
         iterator = self._iter_events()
 
         async for sse in iterator:
-            yield process_data(data=sse.json(), cast_to=cast_to, response=response)
+            if sse.data.startswith("[DONE]"):
+                break
+
+            if sse.event == "error":
+                body = sse.data
+
+                try:
+                    body = sse.json()
+                    err_msg = f"{body}"
+                except Exception:
+                    err_msg = sse.data or f"Error code: {response.status_code}"
+
+                raise self._client._make_status_error(
+                    err_msg,
+                    body=body,
+                    response=self.response,
+                )
+
+            if sse.event is None:
+                yield process_data(data=sse.json(), cast_to=cast_to, response=response)
 
         # Ensure the entire stream is consumed
         async for _sse in iterator:

src/perplexity/_version.py

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