perplexityai 0.7.2__py3-none-any.whl → 0.9.0__py3-none-any.whl

perplexity/resources/chat/completions.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable, Optional
+from typing import Dict, Union, Iterable, Optional
 from typing_extensions import Literal
 
 import httpx
@@ -19,8 +19,8 @@ from ..._response import (
 )
 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
+from ...types.shared_params.chat_message_input import ChatMessageInput
 
 __all__ = ["CompletionsResource", "AsyncCompletionsResource"]
 
@@ -48,20 +48,59 @@ class CompletionsResource(SyncAPIResource):
     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,
+        messages: Iterable[ChatMessageInput],
+        model: str,
+        _debug_pro_search: bool | NotGiven = NOT_GIVEN,
+        _inputs: Optional[Iterable[int]] | NotGiven = NOT_GIVEN,
+        _is_browser_agent: Optional[bool] | NotGiven = NOT_GIVEN,
+        _prompt_token_length: Optional[int] | NotGiven = NOT_GIVEN,
+        best_of: Optional[int] | NotGiven = NOT_GIVEN,
+        country: Optional[str] | NotGiven = NOT_GIVEN,
+        cum_logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
+        debug_params: Optional[completion_create_params.DebugParams] | NotGiven = NOT_GIVEN,
+        disable_search: Optional[bool] | NotGiven = NOT_GIVEN,
+        diverse_first_token: Optional[bool] | NotGiven = NOT_GIVEN,
+        enable_search_classifier: Optional[bool] | NotGiven = NOT_GIVEN,
+        file_workspace_id: Optional[str] | NotGiven = NOT_GIVEN,
+        frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
+        has_image_url: bool | NotGiven = NOT_GIVEN,
+        image_domain_filter: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
+        image_format_filter: Optional[SequenceNotStr[str]] | 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,
+        latitude: Optional[float] | NotGiven = NOT_GIVEN,
+        logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
+        longitude: Optional[float] | NotGiven = NOT_GIVEN,
+        max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
+        n: Optional[int] | NotGiven = NOT_GIVEN,
+        num_images: int | NotGiven = NOT_GIVEN,
+        num_search_results: int | NotGiven = NOT_GIVEN,
+        parallel_tool_calls: Optional[bool] | NotGiven = NOT_GIVEN,
+        presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
+        ranking_model: Optional[str] | NotGiven = NOT_GIVEN,
+        reasoning_effort: Optional[Literal["minimal", "low", "medium", "high"]] | NotGiven = NOT_GIVEN,
+        response_format: Optional[completion_create_params.ResponseFormat] | NotGiven = NOT_GIVEN,
+        response_metadata: Optional[Dict[str, object]] | NotGiven = NOT_GIVEN,
+        return_images: Optional[bool] | NotGiven = NOT_GIVEN,
+        return_related_questions: Optional[bool] | NotGiven = NOT_GIVEN,
+        safe_search: Optional[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_internal_properties: Optional[Dict[str, object]] | 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,
+        search_tenant: Optional[str] | NotGiven = NOT_GIVEN,
+        stop: Union[str, SequenceNotStr[str], None] | NotGiven = NOT_GIVEN,
+        stream: Optional[bool] | NotGiven = NOT_GIVEN,
+        temperature: Optional[float] | NotGiven = NOT_GIVEN,
+        tool_choice: Optional[Literal["none", "auto", "required"]] | NotGiven = NOT_GIVEN,
+        tools: Optional[Iterable[completion_create_params.Tool]] | NotGiven = NOT_GIVEN,
+        top_k: Optional[int] | NotGiven = NOT_GIVEN,
+        top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
+        top_p: Optional[float] | NotGiven = NOT_GIVEN,
+        updated_after_timestamp: Optional[int] | NotGiven = NOT_GIVEN,
+        updated_before_timestamp: Optional[int] | 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.
@@ -71,40 +110,9 @@ class CompletionsResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CompletionCreateResponse:
         """
-        Generates a model's response for the given chat conversation with integrated
-        search capabilities
+        FastAPI wrapper around chat completions
 
         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
@@ -119,18 +127,57 @@ class CompletionsResource(SyncAPIResource):
                 {
                     "messages": messages,
                     "model": model,
+                    "_debug_pro_search": _debug_pro_search,
+                    "_inputs": _inputs,
+                    "_is_browser_agent": _is_browser_agent,
+                    "_prompt_token_length": _prompt_token_length,
+                    "best_of": best_of,
+                    "country": country,
+                    "cum_logprobs": cum_logprobs,
+                    "debug_params": debug_params,
                     "disable_search": disable_search,
+                    "diverse_first_token": diverse_first_token,
                     "enable_search_classifier": enable_search_classifier,
+                    "file_workspace_id": file_workspace_id,
+                    "frequency_penalty": frequency_penalty,
+                    "has_image_url": has_image_url,
+                    "image_domain_filter": image_domain_filter,
+                    "image_format_filter": image_format_filter,
                     "last_updated_after_filter": last_updated_after_filter,
                     "last_updated_before_filter": last_updated_before_filter,
+                    "latitude": latitude,
+                    "logprobs": logprobs,
+                    "longitude": longitude,
+                    "max_tokens": max_tokens,
+                    "n": n,
+                    "num_images": num_images,
+                    "num_search_results": num_search_results,
+                    "parallel_tool_calls": parallel_tool_calls,
+                    "presence_penalty": presence_penalty,
+                    "ranking_model": ranking_model,
                     "reasoning_effort": reasoning_effort,
+                    "response_format": response_format,
+                    "response_metadata": response_metadata,
                     "return_images": return_images,
                     "return_related_questions": return_related_questions,
+                    "safe_search": safe_search,
                     "search_after_date_filter": search_after_date_filter,
                     "search_before_date_filter": search_before_date_filter,
                     "search_domain_filter": search_domain_filter,
+                    "search_internal_properties": search_internal_properties,
                     "search_mode": search_mode,
                     "search_recency_filter": search_recency_filter,
+                    "search_tenant": search_tenant,
+                    "stop": stop,
+                    "stream": stream,
+                    "temperature": temperature,
+                    "tool_choice": tool_choice,
+                    "tools": tools,
+                    "top_k": top_k,
+                    "top_logprobs": top_logprobs,
+                    "top_p": top_p,
+                    "updated_after_timestamp": updated_after_timestamp,
+                    "updated_before_timestamp": updated_before_timestamp,
                     "web_search_options": web_search_options,
                 },
                 completion_create_params.CompletionCreateParams,
@@ -165,20 +212,59 @@ class AsyncCompletionsResource(AsyncAPIResource):
     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,
+        messages: Iterable[ChatMessageInput],
+        model: str,
+        _debug_pro_search: bool | NotGiven = NOT_GIVEN,
+        _inputs: Optional[Iterable[int]] | NotGiven = NOT_GIVEN,
+        _is_browser_agent: Optional[bool] | NotGiven = NOT_GIVEN,
+        _prompt_token_length: Optional[int] | NotGiven = NOT_GIVEN,
+        best_of: Optional[int] | NotGiven = NOT_GIVEN,
+        country: Optional[str] | NotGiven = NOT_GIVEN,
+        cum_logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
+        debug_params: Optional[completion_create_params.DebugParams] | NotGiven = NOT_GIVEN,
+        disable_search: Optional[bool] | NotGiven = NOT_GIVEN,
+        diverse_first_token: Optional[bool] | NotGiven = NOT_GIVEN,
+        enable_search_classifier: Optional[bool] | NotGiven = NOT_GIVEN,
+        file_workspace_id: Optional[str] | NotGiven = NOT_GIVEN,
+        frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
+        has_image_url: bool | NotGiven = NOT_GIVEN,
+        image_domain_filter: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
+        image_format_filter: Optional[SequenceNotStr[str]] | 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,
+        latitude: Optional[float] | NotGiven = NOT_GIVEN,
+        logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
+        longitude: Optional[float] | NotGiven = NOT_GIVEN,
+        max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
+        n: Optional[int] | NotGiven = NOT_GIVEN,
+        num_images: int | NotGiven = NOT_GIVEN,
+        num_search_results: int | NotGiven = NOT_GIVEN,
+        parallel_tool_calls: Optional[bool] | NotGiven = NOT_GIVEN,
+        presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
+        ranking_model: Optional[str] | NotGiven = NOT_GIVEN,
+        reasoning_effort: Optional[Literal["minimal", "low", "medium", "high"]] | NotGiven = NOT_GIVEN,
+        response_format: Optional[completion_create_params.ResponseFormat] | NotGiven = NOT_GIVEN,
+        response_metadata: Optional[Dict[str, object]] | NotGiven = NOT_GIVEN,
+        return_images: Optional[bool] | NotGiven = NOT_GIVEN,
+        return_related_questions: Optional[bool] | NotGiven = NOT_GIVEN,
+        safe_search: Optional[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_internal_properties: Optional[Dict[str, object]] | 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,
+        search_tenant: Optional[str] | NotGiven = NOT_GIVEN,
+        stop: Union[str, SequenceNotStr[str], None] | NotGiven = NOT_GIVEN,
+        stream: Optional[bool] | NotGiven = NOT_GIVEN,
+        temperature: Optional[float] | NotGiven = NOT_GIVEN,
+        tool_choice: Optional[Literal["none", "auto", "required"]] | NotGiven = NOT_GIVEN,
+        tools: Optional[Iterable[completion_create_params.Tool]] | NotGiven = NOT_GIVEN,
+        top_k: Optional[int] | NotGiven = NOT_GIVEN,
+        top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
+        top_p: Optional[float] | NotGiven = NOT_GIVEN,
+        updated_after_timestamp: Optional[int] | NotGiven = NOT_GIVEN,
+        updated_before_timestamp: Optional[int] | 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.
@@ -188,40 +274,9 @@ class AsyncCompletionsResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> CompletionCreateResponse:
         """
-        Generates a model's response for the given chat conversation with integrated
-        search capabilities
+        FastAPI wrapper around chat completions
 
         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
@@ -236,18 +291,57 @@ class AsyncCompletionsResource(AsyncAPIResource):
                 {
                     "messages": messages,
                     "model": model,
+                    "_debug_pro_search": _debug_pro_search,
+                    "_inputs": _inputs,
+                    "_is_browser_agent": _is_browser_agent,
+                    "_prompt_token_length": _prompt_token_length,
+                    "best_of": best_of,
+                    "country": country,
+                    "cum_logprobs": cum_logprobs,
+                    "debug_params": debug_params,
                     "disable_search": disable_search,
+                    "diverse_first_token": diverse_first_token,
                     "enable_search_classifier": enable_search_classifier,
+                    "file_workspace_id": file_workspace_id,
+                    "frequency_penalty": frequency_penalty,
+                    "has_image_url": has_image_url,
+                    "image_domain_filter": image_domain_filter,
+                    "image_format_filter": image_format_filter,
                     "last_updated_after_filter": last_updated_after_filter,
                     "last_updated_before_filter": last_updated_before_filter,
+                    "latitude": latitude,
+                    "logprobs": logprobs,
+                    "longitude": longitude,
+                    "max_tokens": max_tokens,
+                    "n": n,
+                    "num_images": num_images,
+                    "num_search_results": num_search_results,
+                    "parallel_tool_calls": parallel_tool_calls,
+                    "presence_penalty": presence_penalty,
+                    "ranking_model": ranking_model,
                     "reasoning_effort": reasoning_effort,
+                    "response_format": response_format,
+                    "response_metadata": response_metadata,
                     "return_images": return_images,
                     "return_related_questions": return_related_questions,
+                    "safe_search": safe_search,
                     "search_after_date_filter": search_after_date_filter,
                     "search_before_date_filter": search_before_date_filter,
                     "search_domain_filter": search_domain_filter,
+                    "search_internal_properties": search_internal_properties,
                     "search_mode": search_mode,
                     "search_recency_filter": search_recency_filter,
+                    "search_tenant": search_tenant,
+                    "stop": stop,
+                    "stream": stream,
+                    "temperature": temperature,
+                    "tool_choice": tool_choice,
+                    "tools": tools,
+                    "top_k": top_k,
+                    "top_logprobs": top_logprobs,
+                    "top_p": top_p,
+                    "updated_after_timestamp": updated_after_timestamp,
+                    "updated_before_timestamp": updated_before_timestamp,
                     "web_search_options": web_search_options,
                 },
                 completion_create_params.CompletionCreateParams,

perplexity/resources/search.py

@@ -68,38 +68,9 @@ class SearchResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SearchCreateResponse:
         """
-        Perform a search query with various filtering and customization options
+        Search
 
         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
@@ -179,38 +150,9 @@ class AsyncSearchResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SearchCreateResponse:
         """
-        Perform a search query with various filtering and customization options
+        Search
 
         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

@@ -3,12 +3,11 @@
 from __future__ import annotations
 
 from .shared import (
+    Choice as Choice,
     UsageInfo as UsageInfo,
-    ChatChoice as ChatChoice,
-    ChatMessage as ChatMessage,
-    SearchResult as SearchResult,
+    ChatMessageInput as ChatMessageInput,
+    ChatMessageOutput as ChatMessageOutput,
+    APIPublicSearchResult as APIPublicSearchResult,
 )
 from .search_create_params import SearchCreateParams as SearchCreateParams
-from .content_create_params import ContentCreateParams as ContentCreateParams
 from .search_create_response import SearchCreateResponse as SearchCreateResponse
-from .content_create_response import ContentCreateResponse as ContentCreateResponse

perplexity/types/async_/chat/__init__.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from .completion_list_params import CompletionListParams as CompletionListParams
+from .completion_get_params import CompletionGetParams as CompletionGetParams
 from .completion_get_response import CompletionGetResponse as CompletionGetResponse
 from .completion_create_params import CompletionCreateParams as CompletionCreateParams
 from .completion_list_response import CompletionListResponse as CompletionListResponse