perplexityai 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

perplexity/resources/chat/completions.py

@@ -0,0 +1,295 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Literal
+
+import httpx
+
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
+from ..._utils import maybe_transform, async_maybe_transform
+from ..._compat import cached_property
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ..._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ...types.chat import completion_create_params
+from ..._base_client import make_request_options
+from ...types.shared_params.chat_message import ChatMessage
+from ...types.chat.completion_create_response import CompletionCreateResponse
+
+__all__ = ["CompletionsResource", "AsyncCompletionsResource"]
+
+
+class CompletionsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> CompletionsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/ppl-ai/perplexity-py#accessing-raw-response-data-eg-headers
+        """
+        return CompletionsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> CompletionsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/ppl-ai/perplexity-py#with_streaming_response
+        """
+        return CompletionsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        messages: Iterable[ChatMessage],
+        model: Literal["sonar", "sonar-pro", "sonar-deep-research", "sonar-reasoning", "sonar-reasoning-pro"],
+        disable_search: bool | NotGiven = NOT_GIVEN,
+        enable_search_classifier: bool | NotGiven = NOT_GIVEN,
+        last_updated_after_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        last_updated_before_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        reasoning_effort: Optional[Literal["low", "medium", "high"]] | NotGiven = NOT_GIVEN,
+        return_images: bool | NotGiven = NOT_GIVEN,
+        return_related_questions: bool | NotGiven = NOT_GIVEN,
+        search_after_date_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        search_before_date_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        search_domain_filter: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
+        search_mode: Optional[Literal["web", "academic", "sec"]] | NotGiven = NOT_GIVEN,
+        search_recency_filter: Optional[Literal["hour", "day", "week", "month", "year"]] | NotGiven = NOT_GIVEN,
+        web_search_options: completion_create_params.WebSearchOptions | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> CompletionCreateResponse:
+        """
+        Generates a model's response for the given chat conversation with integrated
+        search capabilities
+
+        Args:
+          messages: A list of messages comprising the conversation so far
+
+          model: The name of the model that will complete your prompt
+
+          disable_search: Disables web search completely - model uses only training data
+
+          enable_search_classifier: Enables classifier that decides if web search is needed
+
+          last_updated_after_filter: Only include content last updated after this date (YYYY-MM-DD)
+
+          last_updated_before_filter: Only include content last updated before this date (YYYY-MM-DD)
+
+          reasoning_effort: Controls computational effort for sonar-deep-research model. Higher effort =
+              more thorough but more tokens
+
+          return_images: Whether to include images in search results
+
+          return_related_questions: Whether to return related questions
+
+          search_after_date_filter: Only include content published after this date (YYYY-MM-DD)
+
+          search_before_date_filter: Only include content published before this date (YYYY-MM-DD)
+
+          search_domain_filter: List of domains to limit search results to. Use '-' prefix to exclude domains
+
+          search_mode: Type of search: 'web' for general, 'academic' for scholarly, 'sec' for SEC
+              filings
+
+          search_recency_filter: Filter results by how recently they were published
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/chat/completions",
+            body=maybe_transform(
+                {
+                    "messages": messages,
+                    "model": model,
+                    "disable_search": disable_search,
+                    "enable_search_classifier": enable_search_classifier,
+                    "last_updated_after_filter": last_updated_after_filter,
+                    "last_updated_before_filter": last_updated_before_filter,
+                    "reasoning_effort": reasoning_effort,
+                    "return_images": return_images,
+                    "return_related_questions": return_related_questions,
+                    "search_after_date_filter": search_after_date_filter,
+                    "search_before_date_filter": search_before_date_filter,
+                    "search_domain_filter": search_domain_filter,
+                    "search_mode": search_mode,
+                    "search_recency_filter": search_recency_filter,
+                    "web_search_options": web_search_options,
+                },
+                completion_create_params.CompletionCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=CompletionCreateResponse,
+        )
+
+
+class AsyncCompletionsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncCompletionsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/ppl-ai/perplexity-py#accessing-raw-response-data-eg-headers
+        """
+        return AsyncCompletionsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncCompletionsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/ppl-ai/perplexity-py#with_streaming_response
+        """
+        return AsyncCompletionsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        messages: Iterable[ChatMessage],
+        model: Literal["sonar", "sonar-pro", "sonar-deep-research", "sonar-reasoning", "sonar-reasoning-pro"],
+        disable_search: bool | NotGiven = NOT_GIVEN,
+        enable_search_classifier: bool | NotGiven = NOT_GIVEN,
+        last_updated_after_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        last_updated_before_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        reasoning_effort: Optional[Literal["low", "medium", "high"]] | NotGiven = NOT_GIVEN,
+        return_images: bool | NotGiven = NOT_GIVEN,
+        return_related_questions: bool | NotGiven = NOT_GIVEN,
+        search_after_date_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        search_before_date_filter: Optional[str] | NotGiven = NOT_GIVEN,
+        search_domain_filter: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
+        search_mode: Optional[Literal["web", "academic", "sec"]] | NotGiven = NOT_GIVEN,
+        search_recency_filter: Optional[Literal["hour", "day", "week", "month", "year"]] | NotGiven = NOT_GIVEN,
+        web_search_options: completion_create_params.WebSearchOptions | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> CompletionCreateResponse:
+        """
+        Generates a model's response for the given chat conversation with integrated
+        search capabilities
+
+        Args:
+          messages: A list of messages comprising the conversation so far
+
+          model: The name of the model that will complete your prompt
+
+          disable_search: Disables web search completely - model uses only training data
+
+          enable_search_classifier: Enables classifier that decides if web search is needed
+
+          last_updated_after_filter: Only include content last updated after this date (YYYY-MM-DD)
+
+          last_updated_before_filter: Only include content last updated before this date (YYYY-MM-DD)
+
+          reasoning_effort: Controls computational effort for sonar-deep-research model. Higher effort =
+              more thorough but more tokens
+
+          return_images: Whether to include images in search results
+
+          return_related_questions: Whether to return related questions
+
+          search_after_date_filter: Only include content published after this date (YYYY-MM-DD)
+
+          search_before_date_filter: Only include content published before this date (YYYY-MM-DD)
+
+          search_domain_filter: List of domains to limit search results to. Use '-' prefix to exclude domains
+
+          search_mode: Type of search: 'web' for general, 'academic' for scholarly, 'sec' for SEC
+              filings
+
+          search_recency_filter: Filter results by how recently they were published
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/chat/completions",
+            body=await async_maybe_transform(
+                {
+                    "messages": messages,
+                    "model": model,
+                    "disable_search": disable_search,
+                    "enable_search_classifier": enable_search_classifier,
+                    "last_updated_after_filter": last_updated_after_filter,
+                    "last_updated_before_filter": last_updated_before_filter,
+                    "reasoning_effort": reasoning_effort,
+                    "return_images": return_images,
+                    "return_related_questions": return_related_questions,
+                    "search_after_date_filter": search_after_date_filter,
+                    "search_before_date_filter": search_before_date_filter,
+                    "search_domain_filter": search_domain_filter,
+                    "search_mode": search_mode,
+                    "search_recency_filter": search_recency_filter,
+                    "web_search_options": web_search_options,
+                },
+                completion_create_params.CompletionCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=CompletionCreateResponse,
+        )
+
+
+class CompletionsResourceWithRawResponse:
+    def __init__(self, completions: CompletionsResource) -> None:
+        self._completions = completions
+
+        self.create = to_raw_response_wrapper(
+            completions.create,
+        )
+
+
+class AsyncCompletionsResourceWithRawResponse:
+    def __init__(self, completions: AsyncCompletionsResource) -> None:
+        self._completions = completions
+
+        self.create = async_to_raw_response_wrapper(
+            completions.create,
+        )
+
+
+class CompletionsResourceWithStreamingResponse:
+    def __init__(self, completions: CompletionsResource) -> None:
+        self._completions = completions
+
+        self.create = to_streamed_response_wrapper(
+            completions.create,
+        )
+
+
+class AsyncCompletionsResourceWithStreamingResponse:
+    def __init__(self, completions: AsyncCompletionsResource) -> None:
+        self._completions = completions
+
+        self.create = async_to_streamed_response_wrapper(
+            completions.create,
+        )

perplexity/resources/content.py

@@ -53,9 +53,11 @@ class ContentResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ContentCreateResponse:
         """
-        Get Urls Content
+        Retrieve the full content from specified URLs
 
         Args:
+          urls: List of URLs to retrieve content from
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -106,9 +108,11 @@ class AsyncContentResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ContentCreateResponse:
         """
-        Get Urls Content
+        Retrieve the full content from specified URLs
 
         Args:
+          urls: List of URLs to retrieve content from
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request

perplexity/resources/search.py

@@ -68,9 +68,38 @@ class SearchResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SearchCreateResponse:
         """
-        Search
+        Perform a search query with various filtering and customization options
 
         Args:
+          query: Search query string or array of query strings to search for
+
+          country: Country code to bias search results towards (e.g., 'US', 'GB', 'CA')
+
+          last_updated_after_filter: Only include results last updated after this date (ISO 8601 format: YYYY-MM-DD)
+
+          last_updated_before_filter: Only include results last updated before this date (ISO 8601 format: YYYY-MM-DD)
+
+          max_results: Maximum number of search results to return
+
+          max_tokens: Maximum number of tokens to return across all results
+
+          max_tokens_per_page: Maximum number of tokens to return per individual search result
+
+          safe_search: Enable safe search filtering to exclude adult content
+
+          search_after_date_filter: Only include results published after this date (ISO 8601 format: YYYY-MM-DD)
+
+          search_before_date_filter: Only include results published before this date (ISO 8601 format: YYYY-MM-DD)
+
+          search_domain_filter: List of domains to restrict search results to (e.g., ['example.com',
+              'another.com'])
+
+          search_mode: Type of search to perform: 'web' for general web search, 'academic' for
+              scholarly articles, 'sec' for SEC filings
+
+          search_recency_filter: Filter results by how recently they were published (hour, day, week, month, or
+              year)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -150,9 +179,38 @@ class AsyncSearchResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SearchCreateResponse:
         """
-        Search
+        Perform a search query with various filtering and customization options
 
         Args:
+          query: Search query string or array of query strings to search for
+
+          country: Country code to bias search results towards (e.g., 'US', 'GB', 'CA')
+
+          last_updated_after_filter: Only include results last updated after this date (ISO 8601 format: YYYY-MM-DD)
+
+          last_updated_before_filter: Only include results last updated before this date (ISO 8601 format: YYYY-MM-DD)
+
+          max_results: Maximum number of search results to return
+
+          max_tokens: Maximum number of tokens to return across all results
+
+          max_tokens_per_page: Maximum number of tokens to return per individual search result
+
+          safe_search: Enable safe search filtering to exclude adult content
+
+          search_after_date_filter: Only include results published after this date (ISO 8601 format: YYYY-MM-DD)
+
+          search_before_date_filter: Only include results published before this date (ISO 8601 format: YYYY-MM-DD)
+
+          search_domain_filter: List of domains to restrict search results to (e.g., ['example.com',
+              'another.com'])
+
+          search_mode: Type of search to perform: 'web' for general web search, 'academic' for
+              scholarly articles, 'sec' for SEC filings
+
+          search_recency_filter: Filter results by how recently they were published (hour, day, week, month, or
+              year)
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request

perplexity/types/__init__.py

@@ -2,6 +2,12 @@
 
 from __future__ import annotations
 
+from .shared import (
+    UsageInfo as UsageInfo,
+    ChatChoice as ChatChoice,
+    ChatMessage as ChatMessage,
+    SearchResult as SearchResult,
+)
 from .search_create_params import SearchCreateParams as SearchCreateParams
 from .content_create_params import ContentCreateParams as ContentCreateParams
 from .search_create_response import SearchCreateResponse as SearchCreateResponse

perplexity/types/async_/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations

perplexity/types/async_/chat/__init__.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .completion_list_params import CompletionListParams as CompletionListParams
+from .completion_get_response import CompletionGetResponse as CompletionGetResponse
+from .completion_create_params import CompletionCreateParams as CompletionCreateParams
+from .completion_list_response import CompletionListResponse as CompletionListResponse
+from .completion_create_response import CompletionCreateResponse as CompletionCreateResponse

perplexity/types/async_/chat/completion_create_params.py

@@ -0,0 +1,94 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from ...._types import SequenceNotStr
+from ...shared_params.chat_message import ChatMessage
+
+__all__ = ["CompletionCreateParams", "Request", "RequestWebSearchOptions", "RequestWebSearchOptionsUserLocation"]
+
+
+class CompletionCreateParams(TypedDict, total=False):
+    request: Required[Request]
+
+
+class RequestWebSearchOptionsUserLocation(TypedDict, total=False):
+    city: Optional[str]
+
+    country: Optional[str]
+    """Two-letter ISO country code"""
+
+    latitude: Optional[float]
+
+    longitude: Optional[float]
+
+    region: Optional[str]
+    """State/province name"""
+
+
+class RequestWebSearchOptions(TypedDict, total=False):
+    image_search_relevance_enhanced: bool
+    """Improves relevance of image search results"""
+
+    search_context_size: Literal["low", "medium", "high"]
+    """
+    Amount of search context retrieved: low (cost-saving), medium (balanced), high
+    (comprehensive)
+    """
+
+    user_location: RequestWebSearchOptionsUserLocation
+
+
+class Request(TypedDict, total=False):
+    messages: Required[Iterable[ChatMessage]]
+    """A list of messages comprising the conversation so far"""
+
+    model: Required[Literal["sonar", "sonar-pro", "sonar-deep-research", "sonar-reasoning", "sonar-reasoning-pro"]]
+    """The name of the model that will complete your prompt"""
+
+    disable_search: bool
+    """Disables web search completely - model uses only training data"""
+
+    enable_search_classifier: bool
+    """Enables classifier that decides if web search is needed"""
+
+    last_updated_after_filter: Optional[str]
+    """Only include content last updated after this date (YYYY-MM-DD)"""
+
+    last_updated_before_filter: Optional[str]
+    """Only include content last updated before this date (YYYY-MM-DD)"""
+
+    reasoning_effort: Optional[Literal["low", "medium", "high"]]
+    """Controls computational effort for sonar-deep-research model.
+
+    Higher effort = more thorough but more tokens
+    """
+
+    return_images: bool
+    """Whether to include images in search results"""
+
+    return_related_questions: bool
+    """Whether to return related questions"""
+
+    search_after_date_filter: Optional[str]
+    """Only include content published after this date (YYYY-MM-DD)"""
+
+    search_before_date_filter: Optional[str]
+    """Only include content published before this date (YYYY-MM-DD)"""
+
+    search_domain_filter: Optional[SequenceNotStr[str]]
+    """List of domains to limit search results to. Use '-' prefix to exclude domains"""
+
+    search_mode: Optional[Literal["web", "academic", "sec"]]
+    """
+    Type of search: 'web' for general, 'academic' for scholarly, 'sec' for SEC
+    filings
+    """
+
+    search_recency_filter: Optional[Literal["hour", "day", "week", "month", "year"]]
+    """Filter results by how recently they were published"""
+
+    web_search_options: RequestWebSearchOptions

perplexity/types/async_/chat/completion_create_response.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+from ...shared.usage_info import UsageInfo
+from ...shared.chat_choice import ChatChoice
+from ...shared.search_result import SearchResult
+
+__all__ = ["CompletionCreateResponse", "Response"]
+
+
+class Response(BaseModel):
+    id: str
+    """Unique identifier for the chat completion"""
+
+    choices: List[ChatChoice]
+
+    created: int
+    """Unix timestamp of creation"""
+
+    model: str
+    """The model used"""
+
+    object: str
+
+    usage: UsageInfo
+
+    search_results: Optional[List[SearchResult]] = None
+    """Search results used in generating the response"""
+
+
+class CompletionCreateResponse(BaseModel):
+    id: str
+    """Unique identifier for the async job"""
+
+    created_at: int
+    """Unix timestamp of creation"""
+
+    model: str
+
+    status: Literal["CREATED", "IN_PROGRESS", "COMPLETED", "FAILED"]
+
+    completed_at: Optional[int] = None
+
+    error_message: Optional[str] = None
+
+    failed_at: Optional[int] = None
+
+    response: Optional[Response] = None
+    """The completion response when status is COMPLETED"""
+
+    started_at: Optional[int] = None

perplexity/types/async_/chat/completion_get_response.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+from ...shared.usage_info import UsageInfo
+from ...shared.chat_choice import ChatChoice
+from ...shared.search_result import SearchResult
+
+__all__ = ["CompletionGetResponse", "Response"]
+
+
+class Response(BaseModel):
+    id: str
+    """Unique identifier for the chat completion"""
+
+    choices: List[ChatChoice]
+
+    created: int
+    """Unix timestamp of creation"""
+
+    model: str
+    """The model used"""
+
+    object: str
+
+    usage: UsageInfo
+
+    search_results: Optional[List[SearchResult]] = None
+    """Search results used in generating the response"""
+
+
+class CompletionGetResponse(BaseModel):
+    id: str
+    """Unique identifier for the async job"""
+
+    created_at: int
+    """Unix timestamp of creation"""
+
+    model: str
+
+    status: Literal["CREATED", "IN_PROGRESS", "COMPLETED", "FAILED"]
+
+    completed_at: Optional[int] = None
+
+    error_message: Optional[str] = None
+
+    failed_at: Optional[int] = None
+
+    response: Optional[Response] = None
+    """The completion response when status is COMPLETED"""
+
+    started_at: Optional[int] = None

perplexity/types/async_/chat/completion_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["CompletionListParams"]
+
+
+class CompletionListParams(TypedDict, total=False):
+    limit: int
+    """Maximum number of requests to return"""
+
+    next_token: str
+    """Token for fetching the next page of results"""

perplexity/types/async_/chat/completion_list_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["CompletionListResponse", "Request"]
+
+
+class Request(BaseModel):
+    id: str
+
+    created_at: int
+
+    model: str
+
+    status: Literal["CREATED", "IN_PROGRESS", "COMPLETED", "FAILED"]
+
+    completed_at: Optional[int] = None
+
+    failed_at: Optional[int] = None
+
+    started_at: Optional[int] = None
+
+
+class CompletionListResponse(BaseModel):
+    requests: List[Request]
+
+    next_token: Optional[str] = None
+    """Token for pagination"""