Metadata-Version: 2.4
Name: genkit-plugin-firebase
Version: 0.5.1
Summary: Genkit Firebase Plugin
Project-URL: Bug Tracker, https://github.com/firebase/genkit/issues
Project-URL: Changelog, https://github.com/firebase/genkit/blob/main/py/plugins/firebase/CHANGELOG.md
Project-URL: Documentation, https://firebase.google.com/docs/genkit
Project-URL: Homepage, https://github.com/firebase/genkit
Project-URL: Repository, https://github.com/firebase/genkit/tree/main/py
Author: Google
Author-email: Yesudeep Mangalapilly <yesudeep@google.com>, Elisa Shen <mengqin@google.com>, Niraj Nepal <nnepal@google.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: ai,artificial-intelligence,firebase,firestore,generative-ai,genkit,google,llm,machine-learning,telemetry
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Framework :: Pydantic
Classifier: Framework :: Pydantic :: 2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: genkit
Requires-Dist: genkit-plugin-google-cloud
Requires-Dist: google-cloud-firestore
Requires-Dist: strenum>=0.4.15; python_version < '3.11'
Provides-Extra: telemetry
Requires-Dist: genkit-plugin-google-cloud; extra == 'telemetry'
Description-Content-Type: text/markdown

# Genkit Firebase plugin

This Genkit plugin provides a set of tools and utilities for working with
Firebase.

## Telemetry

The Firebase plugin provides easy integration with Google Cloud Observability (Cloud Trace and Cloud Monitoring).

To enable telemetry:

```python
from genkit.plugins.firebase import add_firebase_telemetry

# Enable telemetry (defaults to production-only export)
add_firebase_telemetry()
```

### Configuration

`add_firebase_telemetry` supports the following options:

- `project_id`: Firebase project ID (optional, auto-detected).
- `force_dev_export`: Set to `True` to export telemetry in dev environment (defaults to `False`).
- `log_input_and_output`: Set to `True` to log model inputs and outputs (defaults to `False` / redacted).
- `disable_metrics`: Set to `True` to disable metrics export.
- `disable_traces`: Set to `True` to disable trace export.
