perplexityai 0.6.0__tar.gz → 0.7.1__tar.gz

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

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

{perplexityai-0.6.0 → perplexityai-0.7.1}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.7.1 (2025-09-10)
+
+Full Changelog: [v0.7.0...v0.7.1](https://github.com/ppl-ai/perplexity-py/compare/v0.7.0...v0.7.1)
+
+### Chores
+
+* remove custom code ([3270d55](https://github.com/ppl-ai/perplexity-py/commit/3270d55b91143e4b9dbc118f39791d36444e0409))
+
+## 0.7.0 (2025-09-10)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/ppl-ai/perplexity-py/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** add /chat/completions and /async/chat/completions ([945f7c2](https://github.com/ppl-ai/perplexity-py/commit/945f7c27c80ca90f6c703590578a414351e0adb2))
+
 ## 0.6.0 (2025-09-08)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/ppl-ai/perplexity-py/compare/v0.5.0...v0.6.0)

{perplexityai-0.6.0 → perplexityai-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: perplexityai
-Version: 0.6.0
+Version: 0.7.1
 Summary: The official Python library for the perplexity API
 Project-URL: Homepage, https://github.com/ppl-ai/perplexity-py
 Project-URL: Repository, https://github.com/ppl-ai/perplexity-py
@@ -67,10 +67,16 @@ client = Perplexity(
     api_key=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
-search = client.search.create(
-    query="string",
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "Tell me about the latest developments in AI",
+        }
+    ],
+    model="sonar",
 )
-print(search.id)
+print(completion.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -93,10 +99,16 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    search = await client.search.create(
-        query="string",
+    completion = await client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": "Tell me about the latest developments in AI",
+            }
+        ],
+        model="sonar",
     )
-    print(search.id)
+    print(completion.id)
 
 
 asyncio.run(main())
@@ -128,10 +140,16 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        search = await client.search.create(
-            query="string",
+        completion = await client.chat.completions.create(
+            messages=[
+                {
+                    "role": "user",
+                    "content": "Tell me about the latest developments in AI",
+                }
+            ],
+            model="sonar",
         )
-        print(search.id)
+        print(completion.id)
 
 
 asyncio.run(main())
@@ -146,6 +164,28 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from perplexity import Perplexity
+
+client = Perplexity()
+
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="sonar",
+    web_search_options={},
+)
+print(completion.web_search_options)
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `perplexity.APIConnectionError` is raised.
@@ -162,8 +202,14 @@ from perplexity import Perplexity
 client = Perplexity()
 
 try:
-    client.search.create(
-        query="string",
+    client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": "What is the capital of France?",
+            }
+        ],
+        model="sonar",
     )
 except perplexity.APIConnectionError as e:
     print("The server could not be reached")
@@ -207,8 +253,14 @@ client = Perplexity(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).search.create(
-    query="string",
+client.with_options(max_retries=5).chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 )
 ```
 
@@ -232,8 +284,14 @@ client = Perplexity(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).search.create(
-    query="string",
+client.with_options(timeout=5.0).chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 )
 ```
 
@@ -275,13 +333,17 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from perplexity import Perplexity
 
 client = Perplexity()
-response = client.search.with_raw_response.create(
-    query="string",
+response = client.chat.completions.with_raw_response.create(
+    messages=[{
+        "role": "user",
+        "content": "What is the capital of France?",
+    }],
+    model="sonar",
 )
 print(response.headers.get('X-My-Header'))
 
-search = response.parse()  # get the object that `search.create()` would have returned
-print(search.id)
+completion = response.parse()  # get the object that `chat.completions.create()` would have returned
+print(completion.id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/ppl-ai/perplexity-py/tree/main/src/perplexity/_response.py) object.
@@ -295,8 +357,14 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.search.with_streaming_response.create(
-    query="string",
+with client.chat.completions.with_streaming_response.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{perplexityai-0.6.0 → perplexityai-0.7.1}/README.md

@@ -32,10 +32,16 @@ client = Perplexity(
     api_key=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
-search = client.search.create(
-    query="string",
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "Tell me about the latest developments in AI",
+        }
+    ],
+    model="sonar",
 )
-print(search.id)
+print(completion.id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -58,10 +64,16 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    search = await client.search.create(
-        query="string",
+    completion = await client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": "Tell me about the latest developments in AI",
+            }
+        ],
+        model="sonar",
     )
-    print(search.id)
+    print(completion.id)
 
 
 asyncio.run(main())
@@ -93,10 +105,16 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        search = await client.search.create(
-            query="string",
+        completion = await client.chat.completions.create(
+            messages=[
+                {
+                    "role": "user",
+                    "content": "Tell me about the latest developments in AI",
+                }
+            ],
+            model="sonar",
         )
-        print(search.id)
+        print(completion.id)
 
 
 asyncio.run(main())
@@ -111,6 +129,28 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from perplexity import Perplexity
+
+client = Perplexity()
+
+completion = client.chat.completions.create(
+    messages=[
+        {
+            "content": "string",
+            "role": "system",
+        }
+    ],
+    model="sonar",
+    web_search_options={},
+)
+print(completion.web_search_options)
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `perplexity.APIConnectionError` is raised.
@@ -127,8 +167,14 @@ from perplexity import Perplexity
 client = Perplexity()
 
 try:
-    client.search.create(
-        query="string",
+    client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": "What is the capital of France?",
+            }
+        ],
+        model="sonar",
     )
 except perplexity.APIConnectionError as e:
     print("The server could not be reached")
@@ -172,8 +218,14 @@ client = Perplexity(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).search.create(
-    query="string",
+client.with_options(max_retries=5).chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 )
 ```
 
@@ -197,8 +249,14 @@ client = Perplexity(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).search.create(
-    query="string",
+client.with_options(timeout=5.0).chat.completions.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 )
 ```
 
@@ -240,13 +298,17 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from perplexity import Perplexity
 
 client = Perplexity()
-response = client.search.with_raw_response.create(
-    query="string",
+response = client.chat.completions.with_raw_response.create(
+    messages=[{
+        "role": "user",
+        "content": "What is the capital of France?",
+    }],
+    model="sonar",
 )
 print(response.headers.get('X-My-Header'))
 
-search = response.parse()  # get the object that `search.create()` would have returned
-print(search.id)
+completion = response.parse()  # get the object that `chat.completions.create()` would have returned
+print(completion.id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/ppl-ai/perplexity-py/tree/main/src/perplexity/_response.py) object.
@@ -260,8 +322,14 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.search.with_streaming_response.create(
-    query="string",
+with client.chat.completions.with_streaming_response.create(
+    messages=[
+        {
+            "role": "user",
+            "content": "What is the capital of France?",
+        }
+    ],
+    model="sonar",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

perplexityai-0.7.1/api.md

@@ -0,0 +1,65 @@
+# Shared Types
+
+```python
+from perplexity.types import ChatChoice, ChatMessage, SearchResult, UsageInfo
+```
+
+# Chat
+
+## Completions
+
+Types:
+
+```python
+from perplexity.types.chat import CompletionCreateResponse
+```
+
+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>
+
+# Async
+
+## Chat
+
+### Completions
+
+Types:
+
+```python
+from perplexity.types.async_.chat import (
+    CompletionCreateResponse,
+    CompletionListResponse,
+    CompletionGetResponse,
+)
+```
+
+Methods:
+
+- <code title="post /async/chat/completions">client.async*.chat.completions.<a href="./src/perplexity/resources/async*/chat/completions.py">create</a>(\*\*<a href="src/perplexity/types/async_/chat/completion_create_params.py">params</a>) -> <a href="./src/perplexity/types/async_/chat/completion_create_response.py">CompletionCreateResponse</a></code>
+- <code title="get /async/chat/completions">client.async*.chat.completions.<a href="./src/perplexity/resources/async*/chat/completions.py">list</a>(\*\*<a href="src/perplexity/types/async_/chat/completion_list_params.py">params</a>) -> <a href="./src/perplexity/types/async_/chat/completion_list_response.py">CompletionListResponse</a></code>
+- <code title="get /async/chat/completions/{request_id}">client.async*.chat.completions.<a href="./src/perplexity/resources/async*/chat/completions.py">get</a>(request*id) -> <a href="./src/perplexity/types/async*/chat/completion_get_response.py">CompletionGetResponse</a></code>
+
+# Search
+
+Types:
+
+```python
+from perplexity.types import SearchCreateResponse
+```
+
+Methods:
+
+- <code title="post /search">client.search.<a href="./src/perplexity/resources/search.py">create</a>(\*\*<a href="src/perplexity/types/search_create_params.py">params</a>) -> <a href="./src/perplexity/types/search_create_response.py">SearchCreateResponse</a></code>
+
+# Content
+
+Types:
+
+```python
+from perplexity.types import ContentCreateResponse
+```
+
+Methods:
+
+- <code title="post /content">client.content.<a href="./src/perplexity/resources/content.py">create</a>(\*\*<a href="src/perplexity/types/content_create_params.py">params</a>) -> <a href="./src/perplexity/types/content_create_response.py">ContentCreateResponse</a></code>

{perplexityai-0.6.0 → perplexityai-0.7.1}/pyproject.toml

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

{perplexityai-0.6.0 → perplexityai-0.7.1}/src/perplexity/_client.py

@@ -29,6 +29,8 @@ from ._base_client import (
     SyncAPIClient,
     AsyncAPIClient,
 )
+from .resources.chat import chat
+from .resources.async_ import async_
 
 __all__ = [
     "Timeout",
@@ -43,6 +45,8 @@ __all__ = [
 
 
 class Perplexity(SyncAPIClient):
+    chat: chat.ChatResource
+    async_: async_.AsyncResource
     search: search.SearchResource
     content: content.ContentResource
     with_raw_response: PerplexityWithRawResponse
@@ -102,6 +106,8 @@ class Perplexity(SyncAPIClient):
             _strict_response_validation=_strict_response_validation,
         )
 
+        self.chat = chat.ChatResource(self)
+        self.async_ = async_.AsyncResource(self)
         self.search = search.SearchResource(self)
         self.content = content.ContentResource(self)
         self.with_raw_response = PerplexityWithRawResponse(self)
@@ -213,6 +219,8 @@ class Perplexity(SyncAPIClient):
 
 
 class AsyncPerplexity(AsyncAPIClient):
+    chat: chat.AsyncChatResource
+    async_: async_.AsyncAsyncResource
     search: search.AsyncSearchResource
     content: content.AsyncContentResource
     with_raw_response: AsyncPerplexityWithRawResponse
@@ -272,6 +280,8 @@ class AsyncPerplexity(AsyncAPIClient):
             _strict_response_validation=_strict_response_validation,
         )
 
+        self.chat = chat.AsyncChatResource(self)
+        self.async_ = async_.AsyncAsyncResource(self)
         self.search = search.AsyncSearchResource(self)
         self.content = content.AsyncContentResource(self)
         self.with_raw_response = AsyncPerplexityWithRawResponse(self)
@@ -384,24 +394,32 @@ class AsyncPerplexity(AsyncAPIClient):
 
 class PerplexityWithRawResponse:
     def __init__(self, client: Perplexity) -> None:
+        self.chat = chat.ChatResourceWithRawResponse(client.chat)
+        self.async_ = async_.AsyncResourceWithRawResponse(client.async_)
         self.search = search.SearchResourceWithRawResponse(client.search)
         self.content = content.ContentResourceWithRawResponse(client.content)
 
 
 class AsyncPerplexityWithRawResponse:
     def __init__(self, client: AsyncPerplexity) -> None:
+        self.chat = chat.AsyncChatResourceWithRawResponse(client.chat)
+        self.async_ = async_.AsyncAsyncResourceWithRawResponse(client.async_)
         self.search = search.AsyncSearchResourceWithRawResponse(client.search)
         self.content = content.AsyncContentResourceWithRawResponse(client.content)
 
 
 class PerplexityWithStreamedResponse:
     def __init__(self, client: Perplexity) -> None:
+        self.chat = chat.ChatResourceWithStreamingResponse(client.chat)
+        self.async_ = async_.AsyncResourceWithStreamingResponse(client.async_)
         self.search = search.SearchResourceWithStreamingResponse(client.search)
         self.content = content.ContentResourceWithStreamingResponse(client.content)
 
 
 class AsyncPerplexityWithStreamedResponse:
     def __init__(self, client: AsyncPerplexity) -> None:
+        self.chat = chat.AsyncChatResourceWithStreamingResponse(client.chat)
+        self.async_ = async_.AsyncAsyncResourceWithStreamingResponse(client.async_)
         self.search = search.AsyncSearchResourceWithStreamingResponse(client.search)
         self.content = content.AsyncContentResourceWithStreamingResponse(client.content)
 

{perplexityai-0.6.0 → perplexityai-0.7.1}/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.6.0"  # x-release-please-version
+__version__ = "0.7.1"  # x-release-please-version

{perplexityai-0.6.0 → perplexityai-0.7.1}/src/perplexity/resources/__init__.py

@@ -1,5 +1,21 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from .chat import (
+    ChatResource,
+    AsyncChatResource,
+    ChatResourceWithRawResponse,
+    AsyncChatResourceWithRawResponse,
+    ChatResourceWithStreamingResponse,
+    AsyncChatResourceWithStreamingResponse,
+)
+from .async_ import (
+    AsyncResource,
+    AsyncAsyncResource,
+    AsyncResourceWithRawResponse,
+    AsyncAsyncResourceWithRawResponse,
+    AsyncResourceWithStreamingResponse,
+    AsyncAsyncResourceWithStreamingResponse,
+)
 from .search import (
     SearchResource,
     AsyncSearchResource,
@@ -18,6 +34,18 @@ from .content import (
 )
 
 __all__ = [
+    "ChatResource",
+    "AsyncChatResource",
+    "ChatResourceWithRawResponse",
+    "AsyncChatResourceWithRawResponse",
+    "ChatResourceWithStreamingResponse",
+    "AsyncChatResourceWithStreamingResponse",
+    "AsyncResource",
+    "AsyncAsyncResource",
+    "AsyncResourceWithRawResponse",
+    "AsyncAsyncResourceWithRawResponse",
+    "AsyncResourceWithStreamingResponse",
+    "AsyncAsyncResourceWithStreamingResponse",
     "SearchResource",
     "AsyncSearchResource",
     "SearchResourceWithRawResponse",

perplexityai-0.7.1/src/perplexity/resources/async_/__init__.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .chat import (
+    ChatResource,
+    AsyncChatResource,
+    ChatResourceWithRawResponse,
+    AsyncChatResourceWithRawResponse,
+    ChatResourceWithStreamingResponse,
+    AsyncChatResourceWithStreamingResponse,
+)
+from .async_ import (
+    AsyncResource,
+    AsyncAsyncResource,
+    AsyncResourceWithRawResponse,
+    AsyncAsyncResourceWithRawResponse,
+    AsyncResourceWithStreamingResponse,
+    AsyncAsyncResourceWithStreamingResponse,
+)
+
+__all__ = [
+    "ChatResource",
+    "AsyncChatResource",
+    "ChatResourceWithRawResponse",
+    "AsyncChatResourceWithRawResponse",
+    "ChatResourceWithStreamingResponse",
+    "AsyncChatResourceWithStreamingResponse",
+    "AsyncResource",
+    "AsyncAsyncResource",
+    "AsyncResourceWithRawResponse",
+    "AsyncAsyncResourceWithRawResponse",
+    "AsyncResourceWithStreamingResponse",
+    "AsyncAsyncResourceWithStreamingResponse",
+]