perplexityai 0.3.0__tar.gz → 0.5.0__tar.gz

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

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

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

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.5.0 (2025-09-08)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/ppl-ai/perplexity-py/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** change bearer_token to api_key ([875bba1](https://github.com/ppl-ai/perplexity-py/commit/875bba126072093d572f00818746b0637a1a56a6))
+
+## 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.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: perplexityai
-Version: 0.3.0
+Version: 0.5.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
@@ -64,19 +64,19 @@ import os
 from perplexity import Perplexity
 
 client = Perplexity(
-    bearer_token=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
+    api_key=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,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PERPLEXITY_API_KEY="My Bearer Token"` to your `.env` file
-so that your Bearer Token is not stored in source control.
+to add `PERPLEXITY_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -88,15 +88,15 @@ import asyncio
 from perplexity import AsyncPerplexity
 
 client = AsyncPerplexity(
-    bearer_token=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
+    api_key=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
 
 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())
@@ -125,13 +125,13 @@ from perplexity import AsyncPerplexity
 
 async def main() -> None:
     async with AsyncPerplexity(
-        bearer_token="My Bearer Token",
+        api_key="My API Key",
         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.5.0}/README.md

@@ -29,19 +29,19 @@ import os
 from perplexity import Perplexity
 
 client = Perplexity(
-    bearer_token=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
+    api_key=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,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PERPLEXITY_API_KEY="My Bearer Token"` to your `.env` file
-so that your Bearer Token is not stored in source control.
+to add `PERPLEXITY_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -53,15 +53,15 @@ import asyncio
 from perplexity import AsyncPerplexity
 
 client = AsyncPerplexity(
-    bearer_token=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
+    api_key=os.environ.get("PERPLEXITY_API_KEY"),  # This is the default and can be omitted
 )
 
 
 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())
@@ -90,13 +90,13 @@ from perplexity import AsyncPerplexity
 
 async def main() -> None:
     async with AsyncPerplexity(
-        bearer_token="My Bearer Token",
+        api_key="My API Key",
         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.5.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.5.0}/pyproject.toml

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

{perplexityai-0.3.0 → perplexityai-0.5.0}/src/perplexity/_client.py

@@ -48,12 +48,12 @@ class Perplexity(SyncAPIClient):
     with_streaming_response: PerplexityWithStreamedResponse
 
     # client options
-    bearer_token: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -75,15 +75,15 @@ class Perplexity(SyncAPIClient):
     ) -> None:
         """Construct a new synchronous Perplexity client instance.
 
-        This automatically infers the `bearer_token` argument from the `PERPLEXITY_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `PERPLEXITY_API_KEY` environment variable if it is not provided.
         """
-        if bearer_token is None:
-            bearer_token = os.environ.get("PERPLEXITY_API_KEY")
-        if bearer_token is None:
+        if api_key is None:
+            api_key = os.environ.get("PERPLEXITY_API_KEY")
+        if api_key is None:
             raise PerplexityError(
-                "The bearer_token client option must be set either by passing bearer_token to the client or by setting the PERPLEXITY_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the PERPLEXITY_API_KEY environment variable"
             )
-        self.bearer_token = bearer_token
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("PERPLEXITY_BASE_URL")
@@ -113,8 +113,8 @@ class Perplexity(SyncAPIClient):
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        bearer_token = self.bearer_token
-        return {"Authorization": f"Bearer {bearer_token}"}
+        api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
 
     @property
     @override
@@ -128,7 +128,7 @@ class Perplexity(SyncAPIClient):
     def copy(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -162,7 +162,7 @@ class Perplexity(SyncAPIClient):
 
         http_client = http_client or self._client
         return self.__class__(
-            bearer_token=bearer_token or self.bearer_token,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -216,12 +216,12 @@ class AsyncPerplexity(AsyncAPIClient):
     with_streaming_response: AsyncPerplexityWithStreamedResponse
 
     # client options
-    bearer_token: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -243,15 +243,15 @@ class AsyncPerplexity(AsyncAPIClient):
     ) -> None:
         """Construct a new async AsyncPerplexity client instance.
 
-        This automatically infers the `bearer_token` argument from the `PERPLEXITY_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `PERPLEXITY_API_KEY` environment variable if it is not provided.
         """
-        if bearer_token is None:
-            bearer_token = os.environ.get("PERPLEXITY_API_KEY")
-        if bearer_token is None:
+        if api_key is None:
+            api_key = os.environ.get("PERPLEXITY_API_KEY")
+        if api_key is None:
             raise PerplexityError(
-                "The bearer_token client option must be set either by passing bearer_token to the client or by setting the PERPLEXITY_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the PERPLEXITY_API_KEY environment variable"
             )
-        self.bearer_token = bearer_token
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("PERPLEXITY_BASE_URL")
@@ -281,8 +281,8 @@ class AsyncPerplexity(AsyncAPIClient):
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        bearer_token = self.bearer_token
-        return {"Authorization": f"Bearer {bearer_token}"}
+        api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
 
     @property
     @override
@@ -296,7 +296,7 @@ class AsyncPerplexity(AsyncAPIClient):
     def copy(
         self,
         *,
-        bearer_token: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -330,7 +330,7 @@ class AsyncPerplexity(AsyncAPIClient):
 
         http_client = http_client or self._client
         return self.__class__(
-            bearer_token=bearer_token or self.bearer_token,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

{perplexityai-0.3.0 → perplexityai-0.5.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.5.0"  # x-release-please-version

{perplexityai-0.3.0 → perplexityai-0.5.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.5.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.5.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.5.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]