perplexity-haystack 0.1.0__py3-none-any.whl

haystack_integrations/components/embedders/perplexity/__init__.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.embedders.perplexity.document_embedder import (
+    PerplexityDocumentEmbedder,
+)
+from haystack_integrations.components.embedders.perplexity.text_embedder import (
+    PerplexityTextEmbedder,
+)
+
+__all__ = ["PerplexityDocumentEmbedder", "PerplexityTextEmbedder"]

haystack_integrations/components/embedders/perplexity/document_embedder.py

@@ -0,0 +1,165 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib.metadata
+from typing import Any, ClassVar
+
+from haystack import component, default_from_dict, default_to_dict
+from haystack.components.embedders import OpenAIDocumentEmbedder
+from haystack.utils.auth import Secret
+
+_INTEGRATION_SLUG = "haystack"
+_PACKAGE_NAME = "perplexity-haystack"
+
+
+def _attribution_header() -> str:
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_SLUG}/{version}"
+
+
+def _http_client_kwargs_with_attribution(
+    http_client_kwargs: dict[str, Any] | None,
+) -> dict[str, Any]:
+    kwargs = dict(http_client_kwargs or {})
+    headers = dict(kwargs.get("headers", {}))
+    headers["X-Pplx-Integration"] = _attribution_header()
+    kwargs["headers"] = headers
+    return kwargs
+
+
+@component
+class PerplexityDocumentEmbedder(OpenAIDocumentEmbedder):
+    """
+    A component for computing Document embeddings using Perplexity models.
+
+    The embedding of each Document is stored in the `embedding` field of the Document.
+    For supported models, see the
+    [Perplexity Embeddings API reference](https://docs.perplexity.ai/api-reference/embeddings-post).
+
+    Usage example:
+    ```python
+    from haystack import Document
+    from haystack_integrations.components.embedders.perplexity import PerplexityDocumentEmbedder
+
+    doc = Document(content="I love pizza!")
+
+    document_embedder = PerplexityDocumentEmbedder()
+
+    result = document_embedder.run([doc])
+    print(result['documents'][0].embedding)
+    ```
+    """
+
+    SUPPORTED_MODELS: ClassVar[list[str]] = [
+        "pplx-embed-v1-0.6b",
+        "pplx-embed-v1-4b",
+    ]
+    """A list of models supported by the Perplexity Embeddings API.
+    See https://docs.perplexity.ai/api-reference/embeddings-post for the current list of model IDs."""
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("PERPLEXITY_API_KEY"),
+        model: str = "pplx-embed-v1-0.6b",
+        api_base_url: str | None = "https://api.perplexity.ai/v1",
+        prefix: str = "",
+        suffix: str = "",
+        batch_size: int = 32,
+        progress_bar: bool = True,
+        meta_fields_to_embed: list[str] | None = None,
+        embedding_separator: str = "\n",
+        timeout: float | None = None,
+        max_retries: int | None = None,
+        http_client_kwargs: dict[str, Any] | None = None,
+    ) -> None:
+        """
+        Creates a PerplexityDocumentEmbedder component.
+
+        :param api_key:
+            The Perplexity API key.
+        :param model:
+            The name of the model to use.
+        :param api_base_url:
+            The Perplexity API base URL.
+        :param prefix:
+            A string to add to the beginning of each text.
+        :param suffix:
+            A string to add to the end of each text.
+        :param batch_size:
+            Number of Documents to encode at once.
+        :param progress_bar:
+            Whether to show a progress bar or not. Can be helpful to disable in production deployments to keep
+            the logs clean.
+        :param meta_fields_to_embed:
+            List of meta fields that should be embedded along with the Document text.
+        :param embedding_separator:
+            Separator used to concatenate the meta fields to the Document text.
+        :param timeout:
+            Timeout for Perplexity client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
+            variable, or 30 seconds.
+        :param max_retries:
+            Maximum number of retries to contact Perplexity after an internal error.
+            If not set, it defaults to either the `OPENAI_MAX_RETRIES` environment variable, or set to 5.
+        :param http_client_kwargs:
+            A dictionary of keyword arguments to configure a custom `httpx.Client`or `httpx.AsyncClient`.
+            For more information, see the [HTTPX documentation](https://www.python-httpx.org/api/#client).
+        """
+        super(PerplexityDocumentEmbedder, self).__init__(  # noqa: UP008
+            api_key=api_key,
+            model=model,
+            dimensions=None,
+            api_base_url=api_base_url,
+            organization=None,
+            prefix=prefix,
+            suffix=suffix,
+            batch_size=batch_size,
+            progress_bar=progress_bar,
+            meta_fields_to_embed=meta_fields_to_embed,
+            embedding_separator=embedding_separator,
+            timeout=timeout,
+            max_retries=max_retries,
+            http_client_kwargs=_http_client_kwargs_with_attribution(http_client_kwargs),
+        )
+        self.http_client_kwargs = http_client_kwargs
+        self.timeout = timeout
+        self.max_retries = max_retries
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serializes the component to a dictionary.
+
+        :returns:
+            Dictionary with serialized data.
+        """
+        return default_to_dict(
+            self,
+            api_key=self.api_key.to_dict(),
+            model=self.model,
+            api_base_url=self.api_base_url,
+            prefix=self.prefix,
+            suffix=self.suffix,
+            batch_size=self.batch_size,
+            progress_bar=self.progress_bar,
+            meta_fields_to_embed=self.meta_fields_to_embed,
+            embedding_separator=self.embedding_separator,
+            timeout=self.timeout,
+            max_retries=self.max_retries,
+            http_client_kwargs=self.http_client_kwargs,
+        )
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "PerplexityDocumentEmbedder":
+        """
+        Deserializes the component from a dictionary.
+
+        :param data:
+            Dictionary to deserialize from.
+        :returns:
+            Deserialized component.
+        """
+        return default_from_dict(cls, data)

haystack_integrations/components/embedders/perplexity/text_embedder.py

@@ -0,0 +1,140 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib.metadata
+from typing import Any, ClassVar
+
+from haystack import component, default_from_dict, default_to_dict
+from haystack.components.embedders import OpenAITextEmbedder
+from haystack.utils.auth import Secret
+
+_INTEGRATION_SLUG = "haystack"
+_PACKAGE_NAME = "perplexity-haystack"
+
+
+def _attribution_header() -> str:
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_SLUG}/{version}"
+
+
+def _http_client_kwargs_with_attribution(
+    http_client_kwargs: dict[str, Any] | None,
+) -> dict[str, Any]:
+    kwargs = dict(http_client_kwargs or {})
+    headers = dict(kwargs.get("headers", {}))
+    headers["X-Pplx-Integration"] = _attribution_header()
+    kwargs["headers"] = headers
+    return kwargs
+
+
+@component
+class PerplexityTextEmbedder(OpenAITextEmbedder):
+    """
+    A component for embedding strings using Perplexity models.
+
+    For supported models, see the
+    [Perplexity Embeddings API reference](https://docs.perplexity.ai/api-reference/embeddings-post).
+
+    Usage example:
+     ```python
+    from haystack_integrations.components.embedders.perplexity.text_embedder import PerplexityTextEmbedder
+
+    text_to_embed = "I love pizza!"
+    text_embedder = PerplexityTextEmbedder()
+    print(text_embedder.run(text_to_embed))
+    ```
+    """
+
+    SUPPORTED_MODELS: ClassVar[list[str]] = [
+        "pplx-embed-v1-0.6b",
+        "pplx-embed-v1-4b",
+    ]
+    """A list of models supported by the Perplexity Embeddings API.
+    See https://docs.perplexity.ai/api-reference/embeddings-post for the current list of model IDs."""
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("PERPLEXITY_API_KEY"),
+        model: str = "pplx-embed-v1-0.6b",
+        api_base_url: str | None = "https://api.perplexity.ai/v1",
+        prefix: str = "",
+        suffix: str = "",
+        timeout: float | None = None,
+        max_retries: int | None = None,
+        http_client_kwargs: dict[str, Any] | None = None,
+    ) -> None:
+        """
+        Creates a PerplexityTextEmbedder component.
+
+        :param api_key:
+            The Perplexity API key.
+        :param model:
+            The name of the Perplexity embedding model to be used.
+        :param api_base_url:
+            The Perplexity API base URL.
+        :param prefix:
+            A string to add to the beginning of each text.
+        :param suffix:
+            A string to add to the end of each text.
+        :param timeout:
+            Timeout for Perplexity client calls. If not set, it defaults to either the `OPENAI_TIMEOUT` environment
+            variable, or 30 seconds.
+        :param max_retries:
+            Maximum number of retries to contact Perplexity after an internal error.
+            If not set, it defaults to either the `OPENAI_MAX_RETRIES` environment variable, or set to 5.
+        :param http_client_kwargs:
+            A dictionary of keyword arguments to configure a custom `httpx.Client`or `httpx.AsyncClient`.
+            For more information, see the [HTTPX documentation](https://www.python-httpx.org/api/#client).
+        """
+
+        super(PerplexityTextEmbedder, self).__init__(  # noqa: UP008
+            api_key=api_key,
+            model=model,
+            dimensions=None,
+            api_base_url=api_base_url,
+            organization=None,
+            prefix=prefix,
+            suffix=suffix,
+            timeout=timeout,
+            max_retries=max_retries,
+            http_client_kwargs=_http_client_kwargs_with_attribution(http_client_kwargs),
+        )
+        self.http_client_kwargs = http_client_kwargs
+        self.timeout = timeout
+        self.max_retries = max_retries
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serializes the component to a dictionary.
+
+        :returns:
+            Dictionary with serialized data.
+        """
+        return default_to_dict(
+            self,
+            api_key=self.api_key.to_dict(),
+            model=self.model,
+            api_base_url=self.api_base_url,
+            prefix=self.prefix,
+            suffix=self.suffix,
+            timeout=self.timeout,
+            max_retries=self.max_retries,
+            http_client_kwargs=self.http_client_kwargs,
+        )
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "PerplexityTextEmbedder":
+        """
+        Deserializes the component from a dictionary.
+
+        :param data:
+            Dictionary to deserialize from.
+        :returns:
+            Deserialized component.
+        """
+        return default_from_dict(cls, data)

haystack_integrations/components/generators/perplexity/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.generators.perplexity.chat.chat_generator import (
+    PerplexityChatGenerator,
+)
+
+__all__ = ["PerplexityChatGenerator"]

haystack_integrations/components/generators/perplexity/chat/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.generators.perplexity.chat.chat_generator import (
+    PerplexityChatGenerator,
+)
+
+__all__ = ["PerplexityChatGenerator"]

haystack_integrations/components/generators/perplexity/chat/chat_generator.py

@@ -0,0 +1,175 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib.metadata
+from typing import Any, ClassVar
+
+from haystack import component, default_from_dict
+from haystack.components.generators.chat import OpenAIResponsesChatGenerator
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.dataclasses import StreamingCallbackT
+from haystack.tools import ToolsType, deserialize_tools_or_toolset_inplace
+from haystack.utils import deserialize_callable
+from haystack.utils.auth import Secret
+
+_INTEGRATION_SLUG = "haystack"
+_PACKAGE_NAME = "perplexity-haystack"
+
+
+def _attribution_header() -> str:
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_SLUG}/{version}"
+
+
+def _perplexity_headers(extra_headers: dict[str, Any] | None = None) -> dict[str, Any]:
+    return {
+        **(extra_headers or {}),
+        "X-Pplx-Integration": _attribution_header(),
+    }
+
+
+def _with_default_headers(client: Any, headers: dict[str, Any]) -> Any:
+    with_options = getattr(client, "with_options", None)
+    if with_options is not None:
+        return with_options(default_headers=headers)
+
+    client._custom_headers = {**getattr(client, "_custom_headers", {}), **headers}
+    return client
+
+
+@component
+class PerplexityChatGenerator(OpenAIResponsesChatGenerator):
+    """
+    Completes chats using Perplexity models.
+
+    Powered by the Perplexity Agent API (`POST /v1/agent`, OpenAI Responses-compatible).
+    See the [Perplexity Agent API quickstart](https://docs.perplexity.ai/docs/agent-api/quickstart)
+    for details.
+
+    It uses the [ChatMessage](https://docs.haystack.deepset.ai/docs/chatmessage) format in input and output.
+    You can customize generation by passing Perplexity Agent API parameters through `generation_kwargs`.
+
+    ### Usage example
+    ```python
+    from haystack.dataclasses import ChatMessage
+    from haystack_integrations.components.generators.perplexity import PerplexityChatGenerator
+
+    messages = [ChatMessage.from_user("What's Natural Language Processing?")]
+
+    client = PerplexityChatGenerator()
+    response = client.run(messages)
+    print(response)
+    ```
+    """
+
+    SUPPORTED_MODELS: ClassVar[list[str]] = [
+        "openai/gpt-5.5",
+        "openai/gpt-5.4",
+        "openai/gpt-4o",
+        "anthropic/claude-sonnet-4-6",
+        "xai/grok-4-1",
+        "google/gemini-3-flash-preview",
+    ]
+    """A non-exhaustive list of Agent API models supported by this component.
+    See https://docs.perplexity.ai/docs/agent-api/models for the full and current list."""
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("PERPLEXITY_API_KEY"),
+        model: str = "openai/gpt-5.4",
+        api_base_url: str | None = "https://api.perplexity.ai/v1",
+        streaming_callback: StreamingCallbackT | None = None,
+        organization: str | None = None,
+        generation_kwargs: dict[str, Any] | None = None,
+        tools: ToolsType | list[dict[str, Any]] | None = None,
+        tools_strict: bool = False,
+        timeout: float | None = None,
+        extra_headers: dict[str, Any] | None = None,
+        max_retries: int | None = None,
+        http_client_kwargs: dict[str, Any] | None = None,
+    ) -> None:
+        """
+        Initialize the PerplexityChatGenerator component.
+
+        :param api_key:
+            The Perplexity API key.
+        :param model:
+            The Perplexity Agent API model to use.
+        :param api_base_url:
+            The Perplexity API base URL.
+        :param streaming_callback:
+            A callback function called when a new token is received from the stream.
+        :param organization:
+            Organization ID forwarded to the OpenAI-compatible client.
+        :param generation_kwargs:
+            Additional parameters sent directly to the Perplexity Agent API.
+        :param tools:
+            A list of Haystack tools, a Toolset, or OpenAI-compatible tool definitions.
+        :param tools_strict:
+            Whether to enable strict schema adherence for Haystack tool calls.
+        :param timeout:
+            Timeout for Perplexity API calls.
+        :param extra_headers:
+            Additional HTTP headers to include in requests to the Perplexity API.
+        :param max_retries:
+            Maximum number of retries to contact Perplexity after an internal error.
+        :param http_client_kwargs:
+            A dictionary of keyword arguments to configure a custom `httpx.Client` or `httpx.AsyncClient`.
+        """
+        self.extra_headers = extra_headers
+        super(PerplexityChatGenerator, self).__init__(  # noqa: UP008
+            api_key=api_key,
+            model=model,
+            streaming_callback=streaming_callback,
+            api_base_url=api_base_url,
+            organization=organization,
+            generation_kwargs=generation_kwargs,
+            timeout=timeout,
+            max_retries=max_retries,
+            tools=tools,
+            tools_strict=tools_strict,
+            http_client_kwargs=http_client_kwargs,
+        )
+
+        default_headers = _perplexity_headers(extra_headers)
+        self.client = _with_default_headers(self.client, default_headers)
+        self.async_client = _with_default_headers(self.async_client, default_headers)
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+
+        :returns:
+            The serialized component as a dictionary.
+        """
+        data = super(PerplexityChatGenerator, self).to_dict()  # noqa: UP008
+        data["type"] = generate_qualified_class_name(type(self))
+        data["init_parameters"]["extra_headers"] = self.extra_headers
+        return data
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "PerplexityChatGenerator":
+        """
+        Deserialize this component from a dictionary.
+
+        :param data: The dictionary representation of this component.
+        :returns:
+            The deserialized component instance.
+        """
+        tools = data["init_parameters"].get("tools")
+        if tools and (
+            (isinstance(tools, dict) and tools.get("type") == "haystack.tools.toolset.Toolset")
+            or (isinstance(tools, list) and tools[0].get("type") == "haystack.tools.tool.Tool")
+        ):
+            deserialize_tools_or_toolset_inplace(data["init_parameters"], key="tools")
+
+        serialized_callback_handler = data.get("init_parameters", {}).get("streaming_callback")
+        if serialized_callback_handler:
+            data["init_parameters"]["streaming_callback"] = deserialize_callable(serialized_callback_handler)
+
+        return default_from_dict(cls, data)

haystack_integrations/components/websearch/perplexity/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.websearch.perplexity.perplexity_websearch import (
+    PerplexityWebSearch,
+)
+
+__all__ = ["PerplexityWebSearch"]

haystack_integrations/components/websearch/perplexity/perplexity_websearch.py

@@ -0,0 +1,191 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib.metadata
+from typing import Any
+
+import httpx
+from haystack import Document, component, logging
+from haystack.utils import Secret
+
+logger = logging.getLogger(__name__)
+
+PERPLEXITY_SEARCH_URL = "https://api.perplexity.ai/search"
+_INTEGRATION_SLUG = "haystack"
+_PACKAGE_NAME = "perplexity-haystack"
+
+
+def _attribution_header() -> str:
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_SLUG}/{version}"
+
+
+@component
+class PerplexityWebSearch:
+    """
+    A component that uses Perplexity to search the web and return results as Haystack Documents.
+
+    This component wraps the Perplexity Search API, enabling web search queries that return
+    structured documents with content and links.
+
+    You need a Perplexity API key from [perplexity.ai](https://www.perplexity.ai/).
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.components.websearch.perplexity import PerplexityWebSearch
+    from haystack.utils import Secret
+
+    websearch = PerplexityWebSearch(
+        api_key=Secret.from_env_var("PERPLEXITY_API_KEY"),
+        top_k=5,
+    )
+    result = websearch.run(query="What is Haystack by deepset?")
+    documents = result["documents"]
+    links = result["links"]
+    ```
+    """
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("PERPLEXITY_API_KEY"),
+        top_k: int | None = 10,
+        search_params: dict[str, Any] | None = None,
+        timeout: float = 30.0,
+    ) -> None:
+        """
+        Initialize the PerplexityWebSearch component.
+
+        :param api_key:
+            API key for Perplexity. Defaults to the `PERPLEXITY_API_KEY` environment variable.
+        :param top_k:
+            Maximum number of results to return. Maps to the `max_results` API parameter (1-20).
+        :param search_params:
+            Additional parameters passed to the Perplexity Search API.
+            See the [Perplexity Search API reference](https://docs.perplexity.ai/api-reference/search-post)
+            for available options. Supported keys include: `max_tokens_per_page`, `country`,
+            `search_recency_filter`, `search_domain_filter`, `search_language_filter`,
+            `last_updated_after_filter`, `last_updated_before_filter`,
+            `search_after_date_filter`, `search_before_date_filter`.
+        :param timeout:
+            Request timeout in seconds.
+        """
+        self.api_key = api_key
+        self.top_k = top_k
+        self.search_params = search_params
+        self.timeout = timeout
+        self._client: httpx.Client | None = None
+        self._async_client: httpx.AsyncClient | None = None
+
+    def _build_headers(self) -> dict[str, str]:
+        return {
+            "Authorization": f"Bearer {self.api_key.resolve_value()}",
+            "Content-Type": "application/json",
+            "X-Pplx-Integration": _attribution_header(),
+        }
+
+    def _build_body(self, query: str, search_params: dict[str, Any] | None) -> dict[str, Any]:
+        params = (search_params if search_params is not None else self.search_params or {}).copy()
+        if "max_results" not in params and self.top_k is not None:
+            params["max_results"] = self.top_k
+        body: dict[str, Any] = {"query": query}
+        body.update({k: v for k, v in params.items() if v is not None})
+        return body
+
+    def warm_up(self) -> None:
+        """
+        Initialize the sync and async HTTP clients.
+
+        Called automatically on first use. Can be called explicitly to avoid cold-start latency.
+        """
+        if self._client is None:
+            self._client = httpx.Client(timeout=self.timeout)
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(timeout=self.timeout)
+
+    @component.output_types(documents=list[Document], links=list[str])
+    def run(
+        self,
+        query: str,
+        search_params: dict[str, Any] | None = None,
+    ) -> dict[str, list[Document] | list[str]]:
+        """
+        Search the web using Perplexity and return results as Documents.
+
+        :param query: Search query string.
+        :param search_params:
+            Optional per-run override of search parameters.
+            If provided, fully replaces the init-time `search_params`.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result content.
+            - `links`: List of URLs from the search results.
+        """
+        if self._client is None:
+            self.warm_up()
+
+        response = self._client.post(  # type: ignore[union-attr]
+            PERPLEXITY_SEARCH_URL,
+            headers=self._build_headers(),
+            json=self._build_body(query, search_params),
+        )
+        response.raise_for_status()
+        return self._parse_response(response.json())
+
+    @component.output_types(documents=list[Document], links=list[str])
+    async def run_async(
+        self,
+        query: str,
+        search_params: dict[str, Any] | None = None,
+    ) -> dict[str, list[Document] | list[str]]:
+        """
+        Asynchronously search the web using Perplexity and return results as Documents.
+
+        :param query: Search query string.
+        :param search_params:
+            Optional per-run override of search parameters.
+            If provided, fully replaces the init-time `search_params`.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result content.
+            - `links`: List of URLs from the search results.
+        """
+        if self._async_client is None:
+            self.warm_up()
+
+        response = await self._async_client.post(  # type: ignore[union-attr]
+            PERPLEXITY_SEARCH_URL,
+            headers=self._build_headers(),
+            json=self._build_body(query, search_params),
+        )
+        response.raise_for_status()
+        return self._parse_response(response.json())
+
+    @staticmethod
+    def _parse_response(response: dict[str, Any]) -> dict[str, Any]:
+        """
+        Convert a Perplexity search response to Haystack Documents and links.
+
+        :param response: Perplexity search response dictionary.
+        :returns: Dictionary with `documents` and `links` keys.
+        """
+        documents: list[Document] = []
+        links: list[str] = []
+
+        for result in response.get("results", []):
+            url = result.get("url", "")
+            title = result.get("title", "")
+            snippet = result.get("snippet", "")
+            meta = {"title": title, "url": url}
+            for optional_key in ("date", "last_updated"):
+                value = result.get(optional_key)
+                if value is not None:
+                    meta[optional_key] = value
+            documents.append(Document(content=snippet, meta=meta))
+            if url:
+                links.append(url)
+
+        return {"documents": documents, "links": links}

perplexity_haystack-0.1.0.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: perplexity-haystack
+Version: 0.1.0
+Summary: Haystack integration for Perplexity Web Search
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/perplexity#readme
+Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
+Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/perplexity
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: AI Search,Haystack,Perplexity,Web Search
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: haystack-ai>=2.24.1
+Requires-Dist: httpx>=0.27.0
+Description-Content-Type: text/markdown
+
+# perplexity-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/perplexity-haystack.svg)](https://pypi.org/project/perplexity-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/perplexity-haystack.svg)](https://pypi.org/project/perplexity-haystack)
+
+- [Integration page](https://haystack.deepset.ai/integrations/perplexity)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/perplexity/CHANGELOG.md)
+
+---
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+To run integration tests locally, you need to export the `PERPLEXITY_API_KEY` environment variable.

perplexity_haystack-0.1.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+haystack_integrations/components/embedders/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/embedders/perplexity/__init__.py,sha256=urlizaaYLxiBdkcyNUtVHlOHyMXR0-c4SVgdvUGw550,411
+haystack_integrations/components/embedders/perplexity/document_embedder.py,sha256=elxQNI74tb3MKzdugECqFzJ54LV6JmPFVizURQOGrkE,5970
+haystack_integrations/components/embedders/perplexity/text_embedder.py,sha256=FMWm02dCJqWHP8sogFeJ4Gl0BqFs9dfVRXqhJhL5mdo,4760
+haystack_integrations/components/generators/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/generators/perplexity/__init__.py,sha256=PXu_E8nogOoVD73ftOD7tQT31O-DmWLNf5TTK5UCvr4,270
+haystack_integrations/components/generators/perplexity/chat/__init__.py,sha256=PXu_E8nogOoVD73ftOD7tQT31O-DmWLNf5TTK5UCvr4,270
+haystack_integrations/components/generators/perplexity/chat/chat_generator.py,sha256=n-IWj6IAgFDWvir72rhG-slGXeApc8o26YV3JKni0po,6819
+haystack_integrations/components/websearch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/websearch/perplexity/__init__.py,sha256=toNidyIAFqV6-IDr-cbgTLyclrTCAIWi9PiXDJ2yXZo,262
+haystack_integrations/components/websearch/perplexity/perplexity_websearch.py,sha256=4ajbIZGrOMwshTVwuS3Vu1D2uH6bKZY2PXqrGSKH4JQ,7121
+perplexity_haystack-0.1.0.dist-info/METADATA,sha256=VIiP4f9NH9LhDBGnG0ni38mAVIzE8jLaje3FjnOooQs,2000
+perplexity_haystack-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+perplexity_haystack-0.1.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
+perplexity_haystack-0.1.0.dist-info/RECORD,,

perplexity_haystack-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

perplexity_haystack-0.1.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-present deepset GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.