fiddler-client 3.11.0__tar.gz → 3.12.0__tar.gz

{fiddler_client-3.11.0/fiddler_client.egg-info → fiddler_client-3.12.0}/PKG-INFO

@@ -1,35 +1,31 @@
 Metadata-Version: 2.4
 Name: fiddler-client
-Version: 3.11.0
+Version: 3.12.0
 Summary: Python client for Fiddler Platform
-Home-page: https://fiddler.ai
 Author: Fiddler Labs
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://fiddler.ai
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
+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: Operating System :: OS Independent
-Requires-Python: >=3.10.0
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: pip>=21.0
 Requires-Dist: requests<3
 Requires-Dist: requests-toolbelt
-Requires-Dist: pydantic>=1.10.17
-Requires-Dist: deprecated==1.2.18
+Requires-Dist: pydantic>=2.0
+Requires-Dist: deprecated>=1.2.18
 Requires-Dist: tqdm
 Requires-Dist: simplejson>=3.17.0
 Requires-Dist: pyyaml
 Requires-Dist: typing-extensions<5,>=4.6.0
-Requires-Dist: pandas>=1.2.5
-Requires-Dist: pyarrow>=15.0.0
-Dynamic: author
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: pyarrow>=17.0.0
 Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # fiddler-client
 
@@ -62,7 +58,7 @@ pip install fiddler-client
 
 ## Requirements
 
-- Python 3.9 or higher
+- Python 3.10 or higher
 - pip 19.0 or higher (latest release preferred)
 
 ## Quick Start
@@ -84,11 +80,10 @@ for project in fdl.Project.list():
 ## Documentation
 
 * 📚 [Complete Documentation](https://docs.fiddler.ai/)
-* 🚀 [Getting Started with LLMs](https://docs.fiddler.ai/first-steps/getting-started-with-llm-monitoring)
-  * [LLM Quick Start Guide](https://docs.fiddler.ai/tutorials-and-quick-starts/llm-and-genai/simple-llm-monitoring)
-* 🚀 [Getting Started with ML](https://docs.fiddler.ai/first-steps/getting-started-with-ml-model-observability)
-  * [ML Quick Start Guide](https://docs.fiddler.ai/tutorials-and-quick-starts/ml-observability/quick-start)
-* 📖 [API Reference](https://docs.fiddler.ai/reference/about-the-fiddler-client)
+* 🚀 [Getting Started with LLMs](https://docs.fiddler.ai/getting-started/llm-monitoring)
+* 🚀 [Getting Started with ML](https://docs.fiddler.ai/getting-started/ml-observability)
+* 🤖 [Getting Started with Agentic Monitoring](https://docs.fiddler.ai/getting-started/agentic-monitoring)
+* 📖 [API Reference](https://docs.fiddler.ai/api/fiddler-python-client-sdk/python-client)
 * 💡 [Example Notebooks](https://github.com/fiddler-labs/fiddler-examples)
 
 ## Example Notebooks
@@ -103,12 +98,12 @@ Check out our [GitHub repository](https://github.com/fiddler-labs/fiddler-exampl
 
 ## Version History
 
-See our [release notes](https://docs.fiddler.ai/history/python-client-history) for detailed version history.
+See our [release notes](https://docs.fiddler.ai/changelog/release-notes/python-sdk) for detailed version history.
 
 ## Support
 
-- 📧 Email: [support@fiddler.ai](support@fiddler.ai)
-- 💬 Community: [Join our Slack](https://www.fiddler.ai/slack)
+- 📧 Email: [support@fiddler.ai](mailto:support@fiddler.ai)
+- 💬 Community: [Join our Slack](https://www.fiddler.ai/slackinvite)
 
 ## License
 

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/PUBLIC.md

@@ -29,7 +29,7 @@ pip install fiddler-client
 
 ## Requirements
 
-- Python 3.9 or higher
+- Python 3.10 or higher
 - pip 19.0 or higher (latest release preferred)
 
 ## Quick Start
@@ -51,11 +51,10 @@ for project in fdl.Project.list():
 ## Documentation
 
 * 📚 [Complete Documentation](https://docs.fiddler.ai/)
-* 🚀 [Getting Started with LLMs](https://docs.fiddler.ai/first-steps/getting-started-with-llm-monitoring)
-  * [LLM Quick Start Guide](https://docs.fiddler.ai/tutorials-and-quick-starts/llm-and-genai/simple-llm-monitoring)
-* 🚀 [Getting Started with ML](https://docs.fiddler.ai/first-steps/getting-started-with-ml-model-observability)
-  * [ML Quick Start Guide](https://docs.fiddler.ai/tutorials-and-quick-starts/ml-observability/quick-start)
-* 📖 [API Reference](https://docs.fiddler.ai/reference/about-the-fiddler-client)
+* 🚀 [Getting Started with LLMs](https://docs.fiddler.ai/getting-started/llm-monitoring)
+* 🚀 [Getting Started with ML](https://docs.fiddler.ai/getting-started/ml-observability)
+* 🤖 [Getting Started with Agentic Monitoring](https://docs.fiddler.ai/getting-started/agentic-monitoring)
+* 📖 [API Reference](https://docs.fiddler.ai/api/fiddler-python-client-sdk/python-client)
 * 💡 [Example Notebooks](https://github.com/fiddler-labs/fiddler-examples)
 
 ## Example Notebooks
@@ -70,12 +69,12 @@ Check out our [GitHub repository](https://github.com/fiddler-labs/fiddler-exampl
 
 ## Version History
 
-See our [release notes](https://docs.fiddler.ai/history/python-client-history) for detailed version history.
+See our [release notes](https://docs.fiddler.ai/changelog/release-notes/python-sdk) for detailed version history.
 
 ## Support
 
-- 📧 Email: [support@fiddler.ai](support@fiddler.ai)
-- 💬 Community: [Join our Slack](https://www.fiddler.ai/slack)
+- 📧 Email: [support@fiddler.ai](mailto:support@fiddler.ai)
+- 💬 Community: [Join our Slack](https://www.fiddler.ai/slackinvite)
 
 ## License
 

fiddler_client-3.12.0/fiddler/VERSION

@@ -0,0 +1 @@
+3.12.0

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/connection.py

@@ -36,7 +36,7 @@ class Connection:
 
     Attributes:
         url: Base URL of the Fiddler platform instance
-        token: Authentication token for API access
+        token: API key obtained from the Fiddler UI Credentials tab (named ``token`` for backward compatibility)
         proxies: Optional proxy configuration for HTTP requests
         timeout: HTTP request timeout settings
         verify: Whether to verify SSL/TLS certificates
@@ -87,7 +87,7 @@ class Connection:
 
         Args:
             url: The base URL to your Fiddler platform instance
-            token: Authentication token obtained from the Fiddler UI
+            token: API key obtained from the Fiddler UI Credentials tab
             proxies: Dictionary mapping protocol to proxy URL for HTTP requests
             timeout: HTTP request timeout settings (float or tuple of connect/read timeouts)
             verify: Whether to verify server's TLS certificate (default: True)
@@ -346,7 +346,7 @@ def init(  # pylint: disable=too-many-arguments
 
     Args:
         url: The base URL to your Fiddler platform instance
-        token: Authentication token obtained from the Fiddler UI Credentials tab
+        token: API key obtained from the Fiddler UI Credentials tab
         proxies: Dictionary mapping protocol to proxy URL for HTTP requests
         timeout: HTTP request timeout settings (float or tuple of connect/read timeouts)
         verify: Whether to verify server's TLS certificate (default: True)

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/decorators.py

@@ -3,7 +3,7 @@ from functools import wraps
 from http import HTTPStatus
 from typing import Any, Callable, TypeVar, cast
 
-import pydantic.v1
+import pydantic
 import requests
 
 from fiddler.exceptions import ApiError, Conflict, HttpError, NotFound, Unsupported
@@ -26,7 +26,7 @@ def handle_api_error(func: _WrappedFuncType) -> _WrappedFuncType:  # noqa: C901
             # This often is premature use of `json()`. Calling code should
             # first check the response for the expected status code, and only
             # then attempt JSON-deserialization.
-            raise HttpError(message=f'Invalid JSON response - {e.doc}')  # type: ignore
+            raise HttpError(message=f'Invalid JSON response - {e.doc}')
         except requests.HTTPError as http_exc:
             # Note(JP): when we're here it means we got an HTTP response.
             # That's how this exception is documented.
@@ -57,7 +57,7 @@ def handle_api_error(func: _WrappedFuncType) -> _WrappedFuncType:  # noqa: C901
             try:
                 # https://github.com/fiddler-labs/fiddler/issues/9314
                 error_resp = ErrorResponse(**http_exc.response.json())
-            except pydantic.v1.ValidationError:
+            except pydantic.ValidationError:
                 # We couldn't turn the HTTP error response into an object
                 # satisfying model='ErrorResponse'. Now, instead of exposing
                 # this to users as a pydantic.ValidationError (which is kinda

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/entities/alert_rule.py

@@ -73,7 +73,7 @@ from datetime import datetime
 from typing import Any, Iterator
 from uuid import UUID
 
-from pydantic.v1 import ValidationError
+from pydantic import ValidationError
 
 from fiddler.constants.alert_rule import (
     AlertCondition,
@@ -457,7 +457,7 @@ class AlertRule(
                 )
 
         _filter = QueryCondition(rules=rules)
-        params: dict[str, Any] = {'filter': _filter.json()}
+        params: dict[str, Any] = {'filter': _filter.model_dump_json()}
 
         if ordering:
             params['ordering'] = ','.join(ordering)
@@ -568,7 +568,7 @@ class AlertRule(
                 pagerduty_services=pagerduty_services,
                 pagerduty_severity=pagerduty_severity,
                 webhooks=webhooks,
-            ).dict(exclude_none=True)
+            ).model_dump(exclude_none=True)
         except ValidationError as e:
             logger.exception('Invalid input: The format of input is not correct')
             raise e

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/entities/baseline.py

@@ -356,7 +356,7 @@ class Baseline(BaseEntity, ModelCompactMixin, ProjectCompactMixin, DatasetCompac
 
         response = cls._client().get(
             url=cls._get_url(),
-            params={'filter': _filter.json()},
+            params={'filter': _filter.model_dump_json()},
         )
         if response.json()['data']['total'] == 0:
             raise_not_found('Baseline not found for the given identifier')
@@ -389,7 +389,7 @@ class Baseline(BaseEntity, ModelCompactMixin, ProjectCompactMixin, DatasetCompac
             )
 
         _filter = QueryCondition(rules=rules)
-        params: dict[str, Any] = {'filter': _filter.json()}
+        params: dict[str, Any] = {'filter': _filter.model_dump_json()}
 
         url = f'/v3/models/{model_id}/baselines'
         for baseline in cls._paginate(url=url, params=params):

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/entities/custom_expression.py

@@ -254,7 +254,7 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
             ]
         )
         params: dict[str, Any] = {
-            "filter": _filter.json(),
+            "filter": _filter.model_dump_json(),
         }
 
         response = cls._client().get(

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/entities/dataset.py

@@ -284,7 +284,7 @@ class Dataset(BaseEntity, ProjectCompactMixin):
 
         response = cls._client().get(
             url=cls._get_url(),
-            params={'filter': _filter.json()},
+            params={'filter': _filter.model_dump_json()},
         )
 
         if response.json()['data']['total'] == 0:

{fiddler_client-3.11.0 → fiddler_client-3.12.0}/fiddler/entities/events.py

@@ -3,8 +3,9 @@ from __future__ import annotations
 import logging
 import os
 import tempfile
+import warnings
 from pathlib import Path
-from typing import Any, Callable
+from typing import Any
 from uuid import UUID
 
 import pandas as pd
@@ -43,7 +44,11 @@ class EventPublisher(ConnectionMixin):
         update: bool = False,
     ) -> list[UUID] | Job:
         """
-        Publish Pre-production or Production data
+        Publish Pre-production or Production data.
+
+        .. deprecated::
+            Use :meth:`publish_stream` for streaming events (list of dicts)
+            or :meth:`publish_batch` for batch publishing (file path or DataFrame).
 
         :param source: one of:
             Path or str path: path for data file.
@@ -55,29 +60,112 @@ class EventPublisher(ConnectionMixin):
 
         :return: list[UUID] for list of dicts source and Job object for file path or dataframe source.
         """
+        warnings.warn(
+            'publish() is deprecated. Use publish_stream() for streaming events '
+            '(list of dicts) or publish_batch() for batch publishing '
+            '(file path or DataFrame).',
+            DeprecationWarning,
+            stacklevel=2,
+        )
 
-        publish_method = self._get_publish_method(source=source)
+        if isinstance(source, list):
+            return self._publish_stream(
+                source=source,
+                environment=environment,
+                dataset_name=dataset_name,
+                update=update,
+            )
 
-        return publish_method(
+        return self._publish_batch(
             source=source,
             environment=environment,
             dataset_name=dataset_name,
             update=update,
         )
 
-    def _get_publish_method(
-        self, source: list[dict[str, Any]] | str | Path | pd.DataFrame
-    ) -> Callable:
-        if isinstance(source, (str, Path)):
-            return self._publish_file
+    @handle_api_error
+    def publish_stream(
+        self,
+        events: list[dict[str, Any]],
+        environment: EnvType = EnvType.PRODUCTION,
+        dataset_name: str | None = None,
+        update: bool = False,
+    ) -> list[UUID]:
+        """
+        Publish events via streaming.
+
+        Sends events synchronously to Fiddler. Events are written to an
+        in-memory queue and asynchronously persisted.
 
+        :param events: List of event dicts matching the model schema.
+        :param environment: Either EnvType.PRE_PRODUCTION or EnvType.PRODUCTION
+        :param dataset_name: Name of the dataset. Not supported for EnvType.PRODUCTION
+        :param update: flag indicating if the events are updates to previously published rows
+
+        :return: list[UUID] of published event IDs.
+        """
+        return self._publish_stream(
+            source=events,
+            environment=environment,
+            dataset_name=dataset_name,
+            update=update,
+        )
+
+    @handle_api_error
+    def publish_batch(
+        self,
+        source: str | Path | pd.DataFrame,
+        environment: EnvType = EnvType.PRODUCTION,
+        dataset_name: str | None = None,
+        update: bool = False,
+    ) -> Job:
+        """
+        Publish data via batch upload.
+
+        Uploads data as a file and kicks off an asynchronous server-side job.
+        Use the returned Job object to track progress.
+
+        :param source: One of:
+            - str or Path: path to a CSV or Parquet file.
+            - pd.DataFrame: events dataframe (converted to Parquet/CSV internally).
+        :param environment: Either EnvType.PRE_PRODUCTION or EnvType.PRODUCTION
+        :param dataset_name: Name of the dataset. Not supported for EnvType.PRODUCTION
+        :param update: flag indicating if the events are updates to previously published rows
+
+        :return: Job object for tracking the async upload.
+        """
+        return self._publish_batch(
+            source=source,
+            environment=environment,
+            dataset_name=dataset_name,
+            update=update,
+        )
+
+    def _publish_batch(
+        self,
+        source: str | Path | pd.DataFrame,
+        environment: EnvType = EnvType.PRODUCTION,
+        dataset_name: str | None = None,
+        update: bool = False,
+    ) -> Job:
+        """Internal dispatch for batch publishing."""
         if isinstance(source, pd.DataFrame):
-            return self._publish_df
+            return self._publish_df(
+                source=source,
+                environment=environment,
+                dataset_name=dataset_name,
+                update=update,
+            )
 
-        if isinstance(source, list):
-            return self._publish_stream
+        if isinstance(source, (str, Path)):
+            return self._publish_file(
+                source=source,
+                environment=environment,
+                dataset_name=dataset_name,
+                update=update,
+            )
 
-        raise ValueError(f'Unsupported source - {type(source)}')
+        raise ValueError(f'Unsupported batch source type - {type(source)}')
 
     def _publish_df(
         self,
@@ -188,7 +276,7 @@ class EventPublisher(ConnectionMixin):
         return method(
             url='/v3/events',
             data={
-                'source': source.dict(),
+                'source': source.model_dump(),
                 'model_id': self.model_id,
                 'env_type': environment,
                 'env_name': dataset_name,