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

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"""

perplexity/types/chat/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .completion_create_params import CompletionCreateParams as CompletionCreateParams
+from .completion_create_response import CompletionCreateResponse as CompletionCreateResponse

perplexity/types/chat/completion_create_params.py

@@ -0,0 +1,90 @@
+# 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", "WebSearchOptions", "WebSearchOptionsUserLocation"]
+
+
+class CompletionCreateParams(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: WebSearchOptions
+
+
+class WebSearchOptionsUserLocation(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 WebSearchOptions(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: WebSearchOptionsUserLocation

perplexity/types/chat/completion_create_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from ..shared.usage_info import UsageInfo
+from ..shared.chat_choice import ChatChoice
+from ..shared.search_result import SearchResult
+
+__all__ = ["CompletionCreateResponse"]
+
+
+class CompletionCreateResponse(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"""

perplexity/types/content_create_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["ContentCreateParams"]
+
+
+class ContentCreateParams(TypedDict, total=False):
+    urls: Required[SequenceNotStr[str]]
+    """List of URLs to retrieve content from"""

perplexity/types/content_create_response.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["ContentCreateResponse", "Result"]
+
+
+class Result(BaseModel):
+    content: str
+    """The full text content of the web page or document"""
+
+    title: str
+    """The title of the web page or document"""
+
+    url: str
+    """The URL of the web page or document"""
+
+    date: Optional[str] = None
+    """The publication date of the content (if available)"""
+
+
+class ContentCreateResponse(BaseModel):
+    id: str
+    """Unique identifier for this content retrieval request"""
+
+    results: List[Result]
+    """Array of content objects retrieved from the requested URLs"""

perplexity/types/search_create_params.py

@@ -12,25 +12,51 @@ __all__ = ["SearchCreateParams"]
 
 class SearchCreateParams(TypedDict, total=False):
     query: Required[Union[str, SequenceNotStr[str]]]
+    """Search query string or array of query strings to search for"""
 
     country: Optional[str]
+    """Country code to bias search results towards (e.g., 'US', 'GB', 'CA')"""
 
     last_updated_after_filter: Optional[str]
+    """Only include results last updated after this date (ISO 8601 format: YYYY-MM-DD)"""
 
     last_updated_before_filter: Optional[str]
+    """
+    Only include results last updated before this date (ISO 8601 format: YYYY-MM-DD)
+    """
 
     max_results: int
+    """Maximum number of search results to return"""
 
     max_tokens: int
+    """Maximum number of tokens to return across all results"""
+
+    max_tokens_per_page: int
+    """Maximum number of tokens to return per individual search result"""
 
     safe_search: Optional[bool]
+    """Enable safe search filtering to exclude adult content"""
 
     search_after_date_filter: Optional[str]
+    """Only include results published after this date (ISO 8601 format: YYYY-MM-DD)"""
 
     search_before_date_filter: Optional[str]
+    """Only include results published before this date (ISO 8601 format: YYYY-MM-DD)"""
 
     search_domain_filter: Optional[SequenceNotStr[str]]
+    """
+    List of domains to restrict search results to (e.g., ['example.com',
+    'another.com'])
+    """
 
     search_mode: Optional[Literal["web", "academic", "sec"]]
+    """
+    Type of search to perform: 'web' for general web search, 'academic' for
+    scholarly articles, 'sec' for SEC filings
+    """
 
     search_recency_filter: Optional[Literal["hour", "day", "week", "month", "year"]]
+    """
+    Filter results by how recently they were published (hour, day, week, month, or
+    year)
+    """

perplexity/types/search_create_response.py

@@ -9,17 +9,24 @@ __all__ = ["SearchCreateResponse", "Result"]
 
 class Result(BaseModel):
     snippet: str
+    """A brief excerpt or summary of the page content"""
 
     title: str
+    """The title of the search result page"""
 
     url: str
+    """The URL of the search result page"""
 
     date: Optional[str] = None
+    """The publication date of the content (if available)"""
 
     last_updated: Optional[str] = None
+    """When the content was last updated (if available)"""
 
 
 class SearchCreateResponse(BaseModel):
     id: str
+    """Unique identifier for this search request"""
 
     results: List[Result]
+    """Array of search result pages matching the query"""

perplexity/types/shared/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .usage_info import UsageInfo as UsageInfo
+from .chat_choice import ChatChoice as ChatChoice
+from .chat_message import ChatMessage as ChatMessage
+from .search_result import SearchResult as SearchResult

perplexity/types/shared/chat_choice.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .chat_message import ChatMessage
+
+__all__ = ["ChatChoice"]
+
+
+class ChatChoice(BaseModel):
+    index: int
+
+    message: ChatMessage
+
+    finish_reason: Optional[Literal["stop", "length"]] = None

perplexity/types/shared/chat_message.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ChatMessage", "ContentMultipartContent", "ContentMultipartContentImageURL"]
+
+
+class ContentMultipartContentImageURL(BaseModel):
+    url: str
+    """URL of the image (base64 or HTTPS)"""
+
+
+class ContentMultipartContent(BaseModel):
+    type: Literal["text", "image_url"]
+    """The type of content"""
+
+    image_url: Optional[ContentMultipartContentImageURL] = None
+
+    text: Optional[str] = None
+    """Text content"""
+
+
+class ChatMessage(BaseModel):
+    content: Union[str, List[ContentMultipartContent]]
+    """The content of the message"""
+
+    role: Literal["system", "user", "assistant"]
+    """The role of the message author"""

perplexity/types/shared/search_result.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["SearchResult"]
+
+
+class SearchResult(BaseModel):
+    title: str
+
+    url: str
+
+    date: Optional[str] = None

perplexity/types/shared/usage_info.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["UsageInfo"]
+
+
+class UsageInfo(BaseModel):
+    completion_tokens: int
+
+    prompt_tokens: int
+
+    total_tokens: int
+
+    citation_tokens: Optional[int] = None
+
+    num_search_queries: Optional[int] = None
+
+    reasoning_tokens: Optional[int] = None
+
+    search_context_size: Optional[str] = None

perplexity/types/shared_params/__init__.py

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

perplexity/types/shared_params/chat_message.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ChatMessage", "ContentMultipartContent", "ContentMultipartContentImageURL"]
+
+
+class ContentMultipartContentImageURL(TypedDict, total=False):
+    url: Required[str]
+    """URL of the image (base64 or HTTPS)"""
+
+
+class ContentMultipartContent(TypedDict, total=False):
+    type: Required[Literal["text", "image_url"]]
+    """The type of content"""
+
+    image_url: Optional[ContentMultipartContentImageURL]
+
+    text: Optional[str]
+    """Text content"""
+
+
+class ChatMessage(TypedDict, total=False):
+    content: Required[Union[str, Iterable[ContentMultipartContent]]]
+    """The content of the message"""
+
+    role: Required[Literal["system", "user", "assistant"]]
+    """The role of the message author"""