perplexityai 0.3.0__tar.gz → 0.4.0__tar.gz

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

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

{perplexityai-0.3.0 → perplexityai-0.4.0}/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.4.0 (2025-09-07)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/ppl-ai/perplexity-py/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** update from perform -> create ([35d2c42](https://github.com/ppl-ai/perplexity-py/commit/35d2c42567e59d53b37be7d4699f80755c09ca30))
+
+
+### Chores
+
+* update SDK settings ([a5a9d00](https://github.com/ppl-ai/perplexity-py/commit/a5a9d0009d07b48cf9b5f4521705acdb6878c904))
+
 ## 0.3.0 (2025-09-07)
 
 Full Changelog: [v0.2.1...v0.3.0](https://github.com/ppl-ai/perplexity-py/compare/v0.2.1...v0.3.0)

{perplexityai-0.3.0 → perplexityai-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: perplexityai
-Version: 0.3.0
+Version: 0.4.0
 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,10 @@ client = Perplexity(
     bearer_token=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.search.perform(
+search = client.search.create(
     query="string",
 )
-print(response.id)
+print(search.id)
 ```
 
 While you can provide a `bearer_token` keyword argument,
@@ -93,10 +93,10 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    response = await client.search.perform(
+    search = await client.search.create(
         query="string",
     )
-    print(response.id)
+    print(search.id)
 
 
 asyncio.run(main())
@@ -128,10 +128,10 @@ async def main() -> None:
         bearer_token="My Bearer Token",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.search.perform(
+        search = await client.search.create(
             query="string",
         )
-        print(response.id)
+        print(search.id)
 
 
 asyncio.run(main())
@@ -162,7 +162,7 @@ from perplexity import Perplexity
 client = Perplexity()
 
 try:
-    client.search.perform(
+    client.search.create(
         query="string",
     )
 except perplexity.APIConnectionError as e:
@@ -207,7 +207,7 @@ client = Perplexity(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).search.perform(
+client.with_options(max_retries=5).search.create(
     query="string",
 )
 ```
@@ -232,7 +232,7 @@ client = Perplexity(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).search.perform(
+client.with_options(timeout=5.0).search.create(
     query="string",
 )
 ```
@@ -275,12 +275,12 @@ 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.perform(
+response = client.search.with_raw_response.create(
     query="string",
 )
 print(response.headers.get('X-My-Header'))
 
-search = response.parse()  # get the object that `search.perform()` would have returned
+search = response.parse()  # get the object that `search.create()` would have returned
 print(search.id)
 ```
 
@@ -295,7 +295,7 @@ 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.perform(
+with client.search.with_streaming_response.create(
     query="string",
 ) as response:
     print(response.headers.get("X-My-Header"))

{perplexityai-0.3.0 → perplexityai-0.4.0}/README.md

@@ -32,10 +32,10 @@ client = Perplexity(
     bearer_token=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
-response = client.search.perform(
+search = client.search.create(
     query="string",
 )
-print(response.id)
+print(search.id)
 ```
 
 While you can provide a `bearer_token` keyword argument,
@@ -58,10 +58,10 @@ client = AsyncPerplexity(
 
 
 async def main() -> None:
-    response = await client.search.perform(
+    search = await client.search.create(
         query="string",
     )
-    print(response.id)
+    print(search.id)
 
 
 asyncio.run(main())
@@ -93,10 +93,10 @@ async def main() -> None:
         bearer_token="My Bearer Token",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        response = await client.search.perform(
+        search = await client.search.create(
             query="string",
         )
-        print(response.id)
+        print(search.id)
 
 
 asyncio.run(main())
@@ -127,7 +127,7 @@ from perplexity import Perplexity
 client = Perplexity()
 
 try:
-    client.search.perform(
+    client.search.create(
         query="string",
     )
 except perplexity.APIConnectionError as e:
@@ -172,7 +172,7 @@ client = Perplexity(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).search.perform(
+client.with_options(max_retries=5).search.create(
     query="string",
 )
 ```
@@ -197,7 +197,7 @@ client = Perplexity(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).search.perform(
+client.with_options(timeout=5.0).search.create(
     query="string",
 )
 ```
@@ -240,12 +240,12 @@ 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.perform(
+response = client.search.with_raw_response.create(
     query="string",
 )
 print(response.headers.get('X-My-Header'))
 
-search = response.parse()  # get the object that `search.perform()` would have returned
+search = response.parse()  # get the object that `search.create()` would have returned
 print(search.id)
 ```
 
@@ -260,7 +260,7 @@ 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.perform(
+with client.search.with_streaming_response.create(
     query="string",
 ) as response:
     print(response.headers.get("X-My-Header"))

perplexityai-0.4.0/api.md

@@ -0,0 +1,11 @@
+# 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>

{perplexityai-0.3.0 → perplexityai-0.4.0}/pyproject.toml

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

{perplexityai-0.3.0 → perplexityai-0.4.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.3.0"  # x-release-please-version
+__version__ = "0.4.0"  # x-release-please-version

{perplexityai-0.3.0 → perplexityai-0.4.0}/src/perplexity/resources/search.py

@@ -7,7 +7,7 @@ from typing_extensions import Literal
 
 import httpx
 
-from ..types import search_perform_params
+from ..types import search_create_params
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
@@ -19,7 +19,7 @@ from .._response import (
     async_to_streamed_response_wrapper,
 )
 from .._base_client import make_request_options
-from ..types.search_perform_response import SearchPerformResponse
+from ..types.search_create_response import SearchCreateResponse
 
 __all__ = ["SearchResource", "AsyncSearchResource"]
 
@@ -44,7 +44,7 @@ class SearchResource(SyncAPIResource):
         """
         return SearchResourceWithStreamingResponse(self)
 
-    def perform(
+    def create(
         self,
         *,
         query: Union[str, SequenceNotStr[str]],
@@ -65,7 +65,7 @@ class SearchResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SearchPerformResponse:
+    ) -> SearchCreateResponse:
         """
         Search
 
@@ -95,12 +95,12 @@ class SearchResource(SyncAPIResource):
                     "search_mode": search_mode,
                     "search_recency_filter": search_recency_filter,
                 },
-                search_perform_params.SearchPerformParams,
+                search_create_params.SearchCreateParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SearchPerformResponse,
+            cast_to=SearchCreateResponse,
         )
 
 
@@ -124,7 +124,7 @@ class AsyncSearchResource(AsyncAPIResource):
         """
         return AsyncSearchResourceWithStreamingResponse(self)
 
-    async def perform(
+    async def create(
         self,
         *,
         query: Union[str, SequenceNotStr[str]],
@@ -145,7 +145,7 @@ class AsyncSearchResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SearchPerformResponse:
+    ) -> SearchCreateResponse:
         """
         Search
 
@@ -175,12 +175,12 @@ class AsyncSearchResource(AsyncAPIResource):
                     "search_mode": search_mode,
                     "search_recency_filter": search_recency_filter,
                 },
-                search_perform_params.SearchPerformParams,
+                search_create_params.SearchCreateParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=SearchPerformResponse,
+            cast_to=SearchCreateResponse,
         )
 
 
@@ -188,8 +188,8 @@ class SearchResourceWithRawResponse:
     def __init__(self, search: SearchResource) -> None:
         self._search = search
 
-        self.perform = to_raw_response_wrapper(
-            search.perform,
+        self.create = to_raw_response_wrapper(
+            search.create,
         )
 
 
@@ -197,8 +197,8 @@ class AsyncSearchResourceWithRawResponse:
     def __init__(self, search: AsyncSearchResource) -> None:
         self._search = search
 
-        self.perform = async_to_raw_response_wrapper(
-            search.perform,
+        self.create = async_to_raw_response_wrapper(
+            search.create,
         )
 
 
@@ -206,8 +206,8 @@ class SearchResourceWithStreamingResponse:
     def __init__(self, search: SearchResource) -> None:
         self._search = search
 
-        self.perform = to_streamed_response_wrapper(
-            search.perform,
+        self.create = to_streamed_response_wrapper(
+            search.create,
         )
 
 
@@ -215,6 +215,6 @@ class AsyncSearchResourceWithStreamingResponse:
     def __init__(self, search: AsyncSearchResource) -> None:
         self._search = search
 
-        self.perform = async_to_streamed_response_wrapper(
-            search.perform,
+        self.create = async_to_streamed_response_wrapper(
+            search.create,
         )

perplexityai-0.4.0/src/perplexity/types/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .search_create_params import SearchCreateParams as SearchCreateParams
+from .search_create_response import SearchCreateResponse as SearchCreateResponse

perplexityai-0.3.0/src/perplexity/types/search_perform_params.py → perplexityai-0.4.0/src/perplexity/types/search_create_params.py

@@ -7,10 +7,10 @@ from typing_extensions import Literal, Required, TypedDict
 
 from .._types import SequenceNotStr
 
-__all__ = ["SearchPerformParams"]
+__all__ = ["SearchCreateParams"]
 
 
-class SearchPerformParams(TypedDict, total=False):
+class SearchCreateParams(TypedDict, total=False):
     query: Required[Union[str, SequenceNotStr[str]]]
 
     country: Optional[str]

perplexityai-0.3.0/src/perplexity/types/search_perform_response.py → perplexityai-0.4.0/src/perplexity/types/search_create_response.py

@@ -4,7 +4,7 @@ from typing import List, Optional
 
 from .._models import BaseModel
 
-__all__ = ["SearchPerformResponse", "Result"]
+__all__ = ["SearchCreateResponse", "Result"]
 
 
 class Result(BaseModel):
@@ -19,7 +19,7 @@ class Result(BaseModel):
     last_updated: Optional[str] = None
 
 
-class SearchPerformResponse(BaseModel):
+class SearchCreateResponse(BaseModel):
     id: str
 
     results: List[Result]

{perplexityai-0.3.0 → perplexityai-0.4.0}/tests/api_resources/test_search.py

@@ -9,7 +9,7 @@ import pytest
 
 from perplexity import Perplexity, AsyncPerplexity
 from tests.utils import assert_matches_type
-from perplexity.types import SearchPerformResponse
+from perplexity.types import SearchCreateResponse
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -19,16 +19,16 @@ class TestSearch:
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    def test_method_perform(self, client: Perplexity) -> None:
-        search = client.search.perform(
+    def test_method_create(self, client: Perplexity) -> None:
+        search = client.search.create(
             query="string",
         )
-        assert_matches_type(SearchPerformResponse, search, path=["response"])
+        assert_matches_type(SearchCreateResponse, search, path=["response"])
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    def test_method_perform_with_all_params(self, client: Perplexity) -> None:
-        search = client.search.perform(
+    def test_method_create_with_all_params(self, client: Perplexity) -> None:
+        search = client.search.create(
             query="string",
             country="country",
             last_updated_after_filter="last_updated_after_filter",
@@ -42,31 +42,31 @@ class TestSearch:
             search_mode="web",
             search_recency_filter="hour",
         )
-        assert_matches_type(SearchPerformResponse, search, path=["response"])
+        assert_matches_type(SearchCreateResponse, search, path=["response"])
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    def test_raw_response_perform(self, client: Perplexity) -> None:
-        response = client.search.with_raw_response.perform(
+    def test_raw_response_create(self, client: Perplexity) -> None:
+        response = client.search.with_raw_response.create(
             query="string",
         )
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         search = response.parse()
-        assert_matches_type(SearchPerformResponse, search, path=["response"])
+        assert_matches_type(SearchCreateResponse, search, path=["response"])
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    def test_streaming_response_perform(self, client: Perplexity) -> None:
-        with client.search.with_streaming_response.perform(
+    def test_streaming_response_create(self, client: Perplexity) -> None:
+        with client.search.with_streaming_response.create(
             query="string",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             search = response.parse()
-            assert_matches_type(SearchPerformResponse, search, path=["response"])
+            assert_matches_type(SearchCreateResponse, search, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -78,16 +78,16 @@ class TestAsyncSearch:
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    async def test_method_perform(self, async_client: AsyncPerplexity) -> None:
-        search = await async_client.search.perform(
+    async def test_method_create(self, async_client: AsyncPerplexity) -> None:
+        search = await async_client.search.create(
             query="string",
         )
-        assert_matches_type(SearchPerformResponse, search, path=["response"])
+        assert_matches_type(SearchCreateResponse, search, path=["response"])
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    async def test_method_perform_with_all_params(self, async_client: AsyncPerplexity) -> None:
-        search = await async_client.search.perform(
+    async def test_method_create_with_all_params(self, async_client: AsyncPerplexity) -> None:
+        search = await async_client.search.create(
             query="string",
             country="country",
             last_updated_after_filter="last_updated_after_filter",
@@ -101,30 +101,30 @@ class TestAsyncSearch:
             search_mode="web",
             search_recency_filter="hour",
         )
-        assert_matches_type(SearchPerformResponse, search, path=["response"])
+        assert_matches_type(SearchCreateResponse, search, path=["response"])
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    async def test_raw_response_perform(self, async_client: AsyncPerplexity) -> None:
-        response = await async_client.search.with_raw_response.perform(
+    async def test_raw_response_create(self, async_client: AsyncPerplexity) -> None:
+        response = await async_client.search.with_raw_response.create(
             query="string",
         )
 
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         search = await response.parse()
-        assert_matches_type(SearchPerformResponse, search, path=["response"])
+        assert_matches_type(SearchCreateResponse, search, path=["response"])
 
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
-    async def test_streaming_response_perform(self, async_client: AsyncPerplexity) -> None:
-        async with async_client.search.with_streaming_response.perform(
+    async def test_streaming_response_create(self, async_client: AsyncPerplexity) -> None:
+        async with async_client.search.with_streaming_response.create(
             query="string",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             search = await response.parse()
-            assert_matches_type(SearchPerformResponse, search, path=["response"])
+            assert_matches_type(SearchCreateResponse, search, path=["response"])
 
         assert cast(Any, response.is_closed) is True

{perplexityai-0.3.0 → perplexityai-0.4.0}/tests/test_client.py

@@ -745,7 +745,7 @@ class TestPerplexity:
         respx_mock.post("/search").mock(side_effect=httpx.TimeoutException("Test timeout error"))
 
         with pytest.raises(APITimeoutError):
-            client.search.with_streaming_response.perform(query="string").__enter__()
+            client.search.with_streaming_response.create(query="string").__enter__()
 
         assert _get_open_connections(self.client) == 0
 
@@ -755,7 +755,7 @@ class TestPerplexity:
         respx_mock.post("/search").mock(return_value=httpx.Response(500))
 
         with pytest.raises(APIStatusError):
-            client.search.with_streaming_response.perform(query="string").__enter__()
+            client.search.with_streaming_response.create(query="string").__enter__()
         assert _get_open_connections(self.client) == 0
 
     @pytest.mark.parametrize("failures_before_success", [0, 2, 4])
@@ -784,7 +784,7 @@ class TestPerplexity:
 
         respx_mock.post("/search").mock(side_effect=retry_handler)
 
-        response = client.search.with_raw_response.perform(query="string")
+        response = client.search.with_raw_response.create(query="string")
 
         assert response.retries_taken == failures_before_success
         assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success
@@ -808,7 +808,7 @@ class TestPerplexity:
 
         respx_mock.post("/search").mock(side_effect=retry_handler)
 
-        response = client.search.with_raw_response.perform(
+        response = client.search.with_raw_response.create(
             query="string", extra_headers={"x-stainless-retry-count": Omit()}
         )
 
@@ -833,7 +833,7 @@ class TestPerplexity:
 
         respx_mock.post("/search").mock(side_effect=retry_handler)
 
-        response = client.search.with_raw_response.perform(
+        response = client.search.with_raw_response.create(
             query="string", extra_headers={"x-stainless-retry-count": "42"}
         )
 
@@ -1584,7 +1584,7 @@ class TestAsyncPerplexity:
         respx_mock.post("/search").mock(side_effect=httpx.TimeoutException("Test timeout error"))
 
         with pytest.raises(APITimeoutError):
-            await async_client.search.with_streaming_response.perform(query="string").__aenter__()
+            await async_client.search.with_streaming_response.create(query="string").__aenter__()
 
         assert _get_open_connections(self.client) == 0
 
@@ -1596,7 +1596,7 @@ class TestAsyncPerplexity:
         respx_mock.post("/search").mock(return_value=httpx.Response(500))
 
         with pytest.raises(APIStatusError):
-            await async_client.search.with_streaming_response.perform(query="string").__aenter__()
+            await async_client.search.with_streaming_response.create(query="string").__aenter__()
         assert _get_open_connections(self.client) == 0
 
     @pytest.mark.parametrize("failures_before_success", [0, 2, 4])
@@ -1626,7 +1626,7 @@ class TestAsyncPerplexity:
 
         respx_mock.post("/search").mock(side_effect=retry_handler)
 
-        response = await client.search.with_raw_response.perform(query="string")
+        response = await client.search.with_raw_response.create(query="string")
 
         assert response.retries_taken == failures_before_success
         assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success
@@ -1651,7 +1651,7 @@ class TestAsyncPerplexity:
 
         respx_mock.post("/search").mock(side_effect=retry_handler)
 
-        response = await client.search.with_raw_response.perform(
+        response = await client.search.with_raw_response.create(
             query="string", extra_headers={"x-stainless-retry-count": Omit()}
         )
 
@@ -1677,7 +1677,7 @@ class TestAsyncPerplexity:
 
         respx_mock.post("/search").mock(side_effect=retry_handler)
 
-        response = await client.search.with_raw_response.perform(
+        response = await client.search.with_raw_response.create(
             query="string", extra_headers={"x-stainless-retry-count": "42"}
         )
 

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

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

perplexityai-0.3.0/api.md

@@ -1,11 +0,0 @@
-# Search
-
-Types:
-
-```python
-from perplexity.types import SearchPerformResponse
-```
-
-Methods:
-
-- <code title="post /search">client.search.<a href="./src/perplexity/resources/search.py">perform</a>(\*\*<a href="src/perplexity/types/search_perform_params.py">params</a>) -> <a href="./src/perplexity/types/search_perform_response.py">SearchPerformResponse</a></code>

perplexityai-0.3.0/src/perplexity/types/__init__.py

@@ -1,6 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from __future__ import annotations
-
-from .search_perform_params import SearchPerformParams as SearchPerformParams
-from .search_perform_response import SearchPerformResponse as SearchPerformResponse