perplexityai 0.22.3__py3-none-any.whl

perplexity/types/chat/completion_create_params.py

@@ -0,0 +1,244 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from ..._types import SequenceNotStr
+from ..shared_params.chat_message_input import ChatMessageInput
+
+__all__ = [
+    "CompletionCreateParamsBase",
+    "ResponseFormat",
+    "ResponseFormatResponseFormatText",
+    "ResponseFormatResponseFormatJsonSchema",
+    "ResponseFormatResponseFormatJsonSchemaJsonSchema",
+    "ResponseFormatResponseFormatRegex",
+    "ResponseFormatResponseFormatRegexRegex",
+    "Tool",
+    "ToolFunction",
+    "ToolFunctionParameters",
+    "WebSearchOptions",
+    "WebSearchOptionsUserLocation",
+    "CompletionCreateParamsNonStreaming",
+    "CompletionCreateParamsStreaming",
+]
+
+
+class CompletionCreateParamsBase(TypedDict, total=False):
+    messages: Required[Iterable[ChatMessageInput]]
+
+    model: Required[str]
+
+    _debug_pro_search: bool
+
+    _force_new_agent: Optional[bool]
+
+    _inputs: Optional[Iterable[int]]
+
+    _prompt_token_length: Optional[int]
+
+    best_of: Optional[int]
+
+    country: Optional[str]
+
+    cum_logprobs: Optional[bool]
+
+    disable_search: Optional[bool]
+
+    diverse_first_token: Optional[bool]
+
+    enable_search_classifier: Optional[bool]
+
+    file_workspace_id: Optional[str]
+
+    frequency_penalty: Optional[float]
+
+    has_image_url: bool
+
+    image_domain_filter: Optional[SequenceNotStr[str]]
+
+    image_format_filter: Optional[SequenceNotStr[str]]
+
+    language_preference: Optional[str]
+
+    last_updated_after_filter: Optional[str]
+
+    last_updated_before_filter: Optional[str]
+
+    latitude: Optional[float]
+
+    logprobs: Optional[bool]
+
+    longitude: Optional[float]
+
+    max_tokens: Optional[int]
+
+    n: Optional[int]
+
+    num_images: int
+
+    num_search_results: int
+
+    parallel_tool_calls: Optional[bool]
+
+    presence_penalty: Optional[float]
+
+    ranking_model: Optional[str]
+
+    reasoning_effort: Optional[Literal["minimal", "low", "medium", "high"]]
+
+    response_format: Optional[ResponseFormat]
+
+    response_metadata: Optional[Dict[str, object]]
+
+    return_images: Optional[bool]
+
+    return_related_questions: Optional[bool]
+
+    safe_search: Optional[bool]
+
+    search_after_date_filter: Optional[str]
+
+    search_before_date_filter: Optional[str]
+
+    search_domain_filter: Optional[SequenceNotStr[str]]
+
+    search_internal_properties: Optional[Dict[str, object]]
+
+    search_language_filter: Optional[SequenceNotStr[str]]
+
+    search_mode: Optional[Literal["web", "academic", "sec"]]
+
+    search_recency_filter: Optional[Literal["hour", "day", "week", "month", "year"]]
+
+    search_tenant: Optional[str]
+
+    stop: Union[str, SequenceNotStr[str], None]
+
+    stream_mode: Literal["full", "concise"]
+
+    temperature: Optional[float]
+
+    thread_id: Optional[str]
+
+    tool_choice: Optional[Literal["none", "auto", "required"]]
+
+    tools: Optional[Iterable[Tool]]
+
+    top_k: Optional[int]
+
+    top_logprobs: Optional[int]
+
+    top_p: Optional[float]
+
+    updated_after_timestamp: Optional[int]
+
+    updated_before_timestamp: Optional[int]
+
+    use_threads: Optional[bool]
+
+    user_original_query: Optional[str]
+
+    web_search_options: WebSearchOptions
+
+
+class ResponseFormatResponseFormatText(TypedDict, total=False):
+    type: Required[Literal["text"]]
+
+
+class ResponseFormatResponseFormatJsonSchemaJsonSchema(TypedDict, total=False):
+    schema: Required[Dict[str, object]]
+
+    description: Optional[str]
+
+    name: Optional[str]
+
+    strict: Optional[bool]
+
+
+class ResponseFormatResponseFormatJsonSchema(TypedDict, total=False):
+    json_schema: Required[ResponseFormatResponseFormatJsonSchemaJsonSchema]
+
+    type: Required[Literal["json_schema"]]
+
+
+class ResponseFormatResponseFormatRegexRegex(TypedDict, total=False):
+    regex: Required[str]
+
+    description: Optional[str]
+
+    name: Optional[str]
+
+    strict: Optional[bool]
+
+
+class ResponseFormatResponseFormatRegex(TypedDict, total=False):
+    regex: Required[ResponseFormatResponseFormatRegexRegex]
+
+    type: Required[Literal["regex"]]
+
+
+ResponseFormat: TypeAlias = Union[
+    ResponseFormatResponseFormatText, ResponseFormatResponseFormatJsonSchema, ResponseFormatResponseFormatRegex
+]
+
+
+class ToolFunctionParameters(TypedDict, total=False):
+    properties: Required[Dict[str, object]]
+
+    type: Required[str]
+
+    additional_properties: Optional[bool]
+
+    required: Optional[SequenceNotStr[str]]
+
+
+class ToolFunction(TypedDict, total=False):
+    description: Required[str]
+
+    name: Required[str]
+
+    parameters: Required[ToolFunctionParameters]
+
+    strict: Optional[bool]
+
+
+class Tool(TypedDict, total=False):
+    function: Required[ToolFunction]
+
+    type: Required[Literal["function"]]
+
+
+class WebSearchOptionsUserLocation(TypedDict, total=False):
+    city: Optional[str]
+
+    country: Optional[str]
+
+    latitude: Optional[float]
+
+    longitude: Optional[float]
+
+    region: Optional[str]
+
+
+class WebSearchOptions(TypedDict, total=False):
+    image_results_enhanced_relevance: bool
+
+    search_context_size: Literal["low", "medium", "high"]
+
+    search_type: Optional[Literal["fast", "pro", "auto"]]
+
+    user_location: Optional[WebSearchOptionsUserLocation]
+
+
+class CompletionCreateParamsNonStreaming(CompletionCreateParamsBase, total=False):
+    stream: Optional[Literal[False]]
+
+
+class CompletionCreateParamsStreaming(CompletionCreateParamsBase):
+    stream: Required[Literal[True]]
+
+
+CompletionCreateParams = Union[CompletionCreateParamsNonStreaming, CompletionCreateParamsStreaming]

perplexity/types/search_create_params.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["SearchCreateParams"]
+
+
+class SearchCreateParams(TypedDict, total=False):
+    query: Required[Union[str, SequenceNotStr[str]]]
+
+    country: Optional[str]
+
+    display_server_time: bool
+
+    last_updated_after_filter: Optional[str]
+
+    last_updated_before_filter: Optional[str]
+
+    max_results: int
+
+    max_tokens: int
+
+    max_tokens_per_page: int
+
+    search_after_date_filter: Optional[str]
+
+    search_before_date_filter: Optional[str]
+
+    search_domain_filter: Optional[SequenceNotStr[str]]
+
+    search_language_filter: Optional[SequenceNotStr[str]]
+
+    search_mode: Optional[Literal["web", "academic", "sec"]]
+
+    search_recency_filter: Optional[Literal["hour", "day", "week", "month", "year"]]

perplexity/types/search_create_response.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["SearchCreateResponse", "Result"]
+
+
+class Result(BaseModel):
+    snippet: str
+
+    title: str
+
+    url: str
+
+    date: Optional[str] = None
+
+    last_updated: Optional[str] = None
+
+
+class SearchCreateResponse(BaseModel):
+    id: str
+
+    results: List[Result]
+
+    server_time: Optional[str] = None

perplexity/types/shared/__init__.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .choice import Choice as Choice
+from .usage_info import UsageInfo as UsageInfo
+from .chat_message_input import ChatMessageInput as ChatMessageInput
+from .chat_message_output import ChatMessageOutput as ChatMessageOutput
+from .api_public_search_result import APIPublicSearchResult as APIPublicSearchResult

perplexity/types/shared/api_public_search_result.py

@@ -0,0 +1,22 @@
+# 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
+
+__all__ = ["APIPublicSearchResult"]
+
+
+class APIPublicSearchResult(BaseModel):
+    title: str
+
+    url: str
+
+    date: Optional[str] = None
+
+    last_updated: Optional[str] = None
+
+    snippet: Optional[str] = None
+
+    source: Optional[Literal["web", "attachment"]] = None

perplexity/types/shared/chat_message_input.py

@@ -0,0 +1,176 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+from .api_public_search_result import APIPublicSearchResult
+
+__all__ = [
+    "ChatMessageInput",
+    "ContentStructuredContent",
+    "ContentStructuredContentChatMessageContentTextChunk",
+    "ContentStructuredContentChatMessageContentImageChunk",
+    "ContentStructuredContentChatMessageContentImageChunkImageURL",
+    "ContentStructuredContentChatMessageContentImageChunkImageURLURL",
+    "ContentStructuredContentChatMessageContentFileChunk",
+    "ContentStructuredContentChatMessageContentFileChunkFileURL",
+    "ContentStructuredContentChatMessageContentFileChunkFileURLURL",
+    "ContentStructuredContentChatMessageContentPdfChunk",
+    "ContentStructuredContentChatMessageContentPdfChunkPdfURL",
+    "ContentStructuredContentChatMessageContentPdfChunkPdfURLURL",
+    "ContentStructuredContentChatMessageContentVideoChunk",
+    "ContentStructuredContentChatMessageContentVideoChunkVideoURL",
+    "ContentStructuredContentChatMessageContentVideoChunkVideoURLVideoURL",
+    "ReasoningStep",
+    "ReasoningStepExecutePython",
+    "ReasoningStepFetchURLContent",
+    "ReasoningStepWebSearch",
+    "ToolCall",
+    "ToolCallFunction",
+]
+
+
+class ContentStructuredContentChatMessageContentTextChunk(BaseModel):
+    text: str
+
+    type: Literal["text"]
+
+
+class ContentStructuredContentChatMessageContentImageChunkImageURLURL(BaseModel):
+    url: str
+
+
+ContentStructuredContentChatMessageContentImageChunkImageURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentImageChunkImageURLURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentImageChunk(BaseModel):
+    image_url: ContentStructuredContentChatMessageContentImageChunkImageURL
+
+    type: Literal["image_url"]
+
+
+class ContentStructuredContentChatMessageContentFileChunkFileURLURL(BaseModel):
+    url: str
+
+
+ContentStructuredContentChatMessageContentFileChunkFileURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentFileChunkFileURLURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentFileChunk(BaseModel):
+    file_url: ContentStructuredContentChatMessageContentFileChunkFileURL
+
+    type: Literal["file_url"]
+
+    file_name: Optional[str] = None
+
+
+class ContentStructuredContentChatMessageContentPdfChunkPdfURLURL(BaseModel):
+    url: str
+
+
+ContentStructuredContentChatMessageContentPdfChunkPdfURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentPdfChunkPdfURLURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentPdfChunk(BaseModel):
+    pdf_url: ContentStructuredContentChatMessageContentPdfChunkPdfURL
+
+    type: Literal["pdf_url"]
+
+
+class ContentStructuredContentChatMessageContentVideoChunkVideoURLVideoURL(BaseModel):
+    url: str
+
+    frame_interval: Union[str, int, None] = None
+
+
+ContentStructuredContentChatMessageContentVideoChunkVideoURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentVideoChunkVideoURLVideoURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentVideoChunk(BaseModel):
+    type: Literal["video_url"]
+
+    video_url: ContentStructuredContentChatMessageContentVideoChunkVideoURL
+
+
+ContentStructuredContent: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentTextChunk,
+    ContentStructuredContentChatMessageContentImageChunk,
+    ContentStructuredContentChatMessageContentFileChunk,
+    ContentStructuredContentChatMessageContentPdfChunk,
+    ContentStructuredContentChatMessageContentVideoChunk,
+]
+
+
+class ReasoningStepExecutePython(BaseModel):
+    """Code generation step details wrapper class"""
+
+    code: str
+
+    result: str
+
+
+class ReasoningStepFetchURLContent(BaseModel):
+    """Fetch url content step details wrapper class"""
+
+    contents: List[APIPublicSearchResult]
+
+
+class ReasoningStepWebSearch(BaseModel):
+    """Web search step details wrapper class"""
+
+    search_keywords: List[str]
+
+    search_results: List[APIPublicSearchResult]
+
+
+class ReasoningStep(BaseModel):
+    """Reasoning step wrapper class"""
+
+    thought: str
+
+    execute_python: Optional[ReasoningStepExecutePython] = None
+    """Code generation step details wrapper class"""
+
+    fetch_url_content: Optional[ReasoningStepFetchURLContent] = None
+    """Fetch url content step details wrapper class"""
+
+    type: Optional[str] = None
+
+    web_search: Optional[ReasoningStepWebSearch] = None
+    """Web search step details wrapper class"""
+
+
+class ToolCallFunction(BaseModel):
+    arguments: Optional[str] = None
+
+    name: Optional[str] = None
+
+
+class ToolCall(BaseModel):
+    id: Optional[str] = None
+
+    function: Optional[ToolCallFunction] = None
+
+    type: Optional[Literal["function"]] = None
+
+
+class ChatMessageInput(BaseModel):
+    content: Union[str, List[ContentStructuredContent], None] = None
+
+    role: Literal["system", "user", "assistant", "tool"]
+    """Chat roles enum"""
+
+    reasoning_steps: Optional[List[ReasoningStep]] = None
+
+    tool_call_id: Optional[str] = None
+
+    tool_calls: Optional[List[ToolCall]] = None

perplexity/types/shared/chat_message_output.py

@@ -0,0 +1,176 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+from .api_public_search_result import APIPublicSearchResult
+
+__all__ = [
+    "ChatMessageOutput",
+    "ContentStructuredContent",
+    "ContentStructuredContentChatMessageContentTextChunk",
+    "ContentStructuredContentChatMessageContentImageChunk",
+    "ContentStructuredContentChatMessageContentImageChunkImageURL",
+    "ContentStructuredContentChatMessageContentImageChunkImageURLURL",
+    "ContentStructuredContentChatMessageContentFileChunk",
+    "ContentStructuredContentChatMessageContentFileChunkFileURL",
+    "ContentStructuredContentChatMessageContentFileChunkFileURLURL",
+    "ContentStructuredContentChatMessageContentPdfChunk",
+    "ContentStructuredContentChatMessageContentPdfChunkPdfURL",
+    "ContentStructuredContentChatMessageContentPdfChunkPdfURLURL",
+    "ContentStructuredContentChatMessageContentVideoChunk",
+    "ContentStructuredContentChatMessageContentVideoChunkVideoURL",
+    "ContentStructuredContentChatMessageContentVideoChunkVideoURLVideoURL",
+    "ReasoningStep",
+    "ReasoningStepExecutePython",
+    "ReasoningStepFetchURLContent",
+    "ReasoningStepWebSearch",
+    "ToolCall",
+    "ToolCallFunction",
+]
+
+
+class ContentStructuredContentChatMessageContentTextChunk(BaseModel):
+    text: str
+
+    type: Literal["text"]
+
+
+class ContentStructuredContentChatMessageContentImageChunkImageURLURL(BaseModel):
+    url: str
+
+
+ContentStructuredContentChatMessageContentImageChunkImageURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentImageChunkImageURLURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentImageChunk(BaseModel):
+    image_url: ContentStructuredContentChatMessageContentImageChunkImageURL
+
+    type: Literal["image_url"]
+
+
+class ContentStructuredContentChatMessageContentFileChunkFileURLURL(BaseModel):
+    url: str
+
+
+ContentStructuredContentChatMessageContentFileChunkFileURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentFileChunkFileURLURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentFileChunk(BaseModel):
+    file_url: ContentStructuredContentChatMessageContentFileChunkFileURL
+
+    type: Literal["file_url"]
+
+    file_name: Optional[str] = None
+
+
+class ContentStructuredContentChatMessageContentPdfChunkPdfURLURL(BaseModel):
+    url: str
+
+
+ContentStructuredContentChatMessageContentPdfChunkPdfURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentPdfChunkPdfURLURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentPdfChunk(BaseModel):
+    pdf_url: ContentStructuredContentChatMessageContentPdfChunkPdfURL
+
+    type: Literal["pdf_url"]
+
+
+class ContentStructuredContentChatMessageContentVideoChunkVideoURLVideoURL(BaseModel):
+    url: str
+
+    frame_interval: Union[str, int, None] = None
+
+
+ContentStructuredContentChatMessageContentVideoChunkVideoURL: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentVideoChunkVideoURLVideoURL, str
+]
+
+
+class ContentStructuredContentChatMessageContentVideoChunk(BaseModel):
+    type: Literal["video_url"]
+
+    video_url: ContentStructuredContentChatMessageContentVideoChunkVideoURL
+
+
+ContentStructuredContent: TypeAlias = Union[
+    ContentStructuredContentChatMessageContentTextChunk,
+    ContentStructuredContentChatMessageContentImageChunk,
+    ContentStructuredContentChatMessageContentFileChunk,
+    ContentStructuredContentChatMessageContentPdfChunk,
+    ContentStructuredContentChatMessageContentVideoChunk,
+]
+
+
+class ReasoningStepExecutePython(BaseModel):
+    """Code generation step details wrapper class"""
+
+    code: str
+
+    result: str
+
+
+class ReasoningStepFetchURLContent(BaseModel):
+    """Fetch url content step details wrapper class"""
+
+    contents: List[APIPublicSearchResult]
+
+
+class ReasoningStepWebSearch(BaseModel):
+    """Web search step details wrapper class"""
+
+    search_keywords: List[str]
+
+    search_results: List[APIPublicSearchResult]
+
+
+class ReasoningStep(BaseModel):
+    """Reasoning step wrapper class"""
+
+    thought: str
+
+    execute_python: Optional[ReasoningStepExecutePython] = None
+    """Code generation step details wrapper class"""
+
+    fetch_url_content: Optional[ReasoningStepFetchURLContent] = None
+    """Fetch url content step details wrapper class"""
+
+    type: Optional[str] = None
+
+    web_search: Optional[ReasoningStepWebSearch] = None
+    """Web search step details wrapper class"""
+
+
+class ToolCallFunction(BaseModel):
+    arguments: Optional[str] = None
+
+    name: Optional[str] = None
+
+
+class ToolCall(BaseModel):
+    id: Optional[str] = None
+
+    function: Optional[ToolCallFunction] = None
+
+    type: Optional[Literal["function"]] = None
+
+
+class ChatMessageOutput(BaseModel):
+    content: Union[str, List[ContentStructuredContent], None] = None
+
+    role: Literal["system", "user", "assistant", "tool"]
+    """Chat roles enum"""
+
+    reasoning_steps: Optional[List[ReasoningStep]] = None
+
+    tool_call_id: Optional[str] = None
+
+    tool_calls: Optional[List[ToolCall]] = None