perplexityai 0.12.1__tar.gz → 0.14.0__tar.gz

perplexityai-0.14.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.14.0"
+}

{perplexityai-0.12.1 → perplexityai-0.14.0}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.14.0 (2025-10-08)
+
+Full Changelog: [v0.13.0...v0.14.0](https://github.com/perplexityai/perplexity-py/compare/v0.13.0...v0.14.0)
+
+### Features
+
+* **api:** manual updates ([6c510ea](https://github.com/perplexityai/perplexity-py/commit/6c510eaf7239b14380059214d2fdb65fe2048d5c))
+
+## 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)

{perplexityai-0.12.1 → perplexityai-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: perplexityai
-Version: 0.12.1
+Version: 0.14.0
 Summary: The official Python library for the perplexity API
 Project-URL: Homepage, https://github.com/perplexityai/perplexity-py
 Project-URL: Repository, https://github.com/perplexityai/perplexity-py
@@ -88,7 +88,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",
@@ -97,7 +97,7 @@ completion = client.chat.completions.create(
     ],
     model="sonar",
 )
-print(completion.id)
+print(stream_chunk.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -120,7 +120,7 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    completion = await client.chat.completions.create(
+    stream_chunk = await client.chat.completions.create(
         messages=[
             {
                 "role": "user",
@@ -129,7 +129,7 @@ async def main() -> None:
         ],
         model="sonar",
     )
-    print(completion.id)
+    print(stream_chunk.id)
 
 
 asyncio.run(main())
@@ -161,7 +161,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",
@@ -170,12 +170,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:
@@ -194,7 +238,7 @@ from perplexity import Perplexity
 
 client = Perplexity()
 
-completion = client.chat.completions.create(
+stream_chunk = client.chat.completions.create(
     messages=[
         {
             "content": "string",
@@ -204,7 +248,7 @@ completion = client.chat.completions.create(
     model="model",
     debug_params={},
 )
-print(completion.debug_params)
+print(stream_chunk.debug_params)
 ```
 
 ## Handling errors

{perplexityai-0.12.1 → perplexityai-0.14.0}/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

{perplexityai-0.12.1 → perplexityai-0.14.0}/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
 

{perplexityai-0.12.1 → perplexityai-0.14.0}/pyproject.toml

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

{perplexityai-0.12.1 → perplexityai-0.14.0}/src/perplexity/_client.py

@@ -105,6 +105,8 @@ class Perplexity(SyncAPIClient):
             _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 @@ class AsyncPerplexity(AsyncAPIClient):
             _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)

{perplexityai-0.12.1 → perplexityai-0.14.0}/src/perplexity/_streaming.py

@@ -55,7 +55,26 @@ class Stream(Generic[_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 @@ class AsyncStream(Generic[_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:

{perplexityai-0.12.1 → perplexityai-0.14.0}/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.14.0"  # x-release-please-version

{perplexityai-0.12.1 → perplexityai-0.14.0}/src/perplexity/resources/async_/chat/completions.py

@@ -58,10 +58,7 @@ class CompletionsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CompletionCreateResponse:
         """
-        FastAPI wrapper around async chat completions
-
-        This endpoint creates an asynchronous chat completion job and returns a job ID
-        that can be used to poll for results.
+        Submit an asynchronous chat completion request.
 
         Args:
           extra_headers: Send extra headers
@@ -97,7 +94,7 @@ class CompletionsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CompletionListResponse:
-        """list all async chat completion requests for a given user."""
+        """Retrieve a list of all asynchronous chat completion requests for a given user."""
         return self._get(
             "/async/chat/completions",
             options=make_request_options(
@@ -113,6 +110,7 @@ class CompletionsResource(SyncAPIResource):
         local_mode: bool | Omit = omit,
         x_client_env: str | Omit = omit,
         x_client_name: str | Omit = omit,
+        x_created_at_epoch_seconds: str | Omit = omit,
         x_request_time: str | Omit = omit,
         x_usage_tier: str | Omit = omit,
         x_user_id: str | Omit = omit,
@@ -124,7 +122,7 @@ class CompletionsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CompletionGetResponse:
         """
-        get the response for a given async chat completion request.
+        Retrieve the response for a given asynchronous chat completion request.
 
         Args:
           extra_headers: Send extra headers
@@ -142,6 +140,7 @@ class CompletionsResource(SyncAPIResource):
                 {
                     "x-client-env": x_client_env,
                     "x-client-name": x_client_name,
+                    "x-created-at-epoch-seconds": x_created_at_epoch_seconds,
                     "x-request-time": x_request_time,
                     "x-usage-tier": x_usage_tier,
                     "x-user-id": x_user_id,
@@ -195,10 +194,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CompletionCreateResponse:
         """
-        FastAPI wrapper around async chat completions
-
-        This endpoint creates an asynchronous chat completion job and returns a job ID
-        that can be used to poll for results.
+        Submit an asynchronous chat completion request.
 
         Args:
           extra_headers: Send extra headers
@@ -234,7 +230,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CompletionListResponse:
-        """list all async chat completion requests for a given user."""
+        """Retrieve a list of all asynchronous chat completion requests for a given user."""
         return await self._get(
             "/async/chat/completions",
             options=make_request_options(
@@ -250,6 +246,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
         local_mode: bool | Omit = omit,
         x_client_env: str | Omit = omit,
         x_client_name: str | Omit = omit,
+        x_created_at_epoch_seconds: str | Omit = omit,
         x_request_time: str | Omit = omit,
         x_usage_tier: str | Omit = omit,
         x_user_id: str | Omit = omit,
@@ -261,7 +258,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CompletionGetResponse:
         """
-        get the response for a given async chat completion request.
+        Retrieve the response for a given asynchronous chat completion request.
 
         Args:
           extra_headers: Send extra headers
@@ -279,6 +276,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
                 {
                     "x-client-env": x_client_env,
                     "x-client-name": x_client_name,
+                    "x-created-at-epoch-seconds": x_created_at_epoch_seconds,
                     "x-request-time": x_request_time,
                     "x-usage-tier": x_usage_tier,
                     "x-user-id": x_user_id,