genkit-plugin-firebase 0.3.2__tar.gz → 0.5.0__tar.gz

{genkit_plugin_firebase-0.3.2 → genkit_plugin_firebase-0.5.0}/PKG-INFO

@@ -1,10 +1,15 @@
 Metadata-Version: 2.4
 Name: genkit-plugin-firebase
-Version: 0.3.2
+Version: 0.5.0
 Summary: Genkit Firebase Plugin
+Project-URL: Bug Tracker, https://github.com/firebase/genkit/issues
+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
-License: Apache-2.0
+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
@@ -17,8 +22,10 @@ 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: google-cloud-firestore

genkit_plugin_firebase-0.5.0/pyproject.toml

@@ -0,0 +1,73 @@
+# Copyright 2025 Google LLC
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+[project]
+authors = [{ name = "Google" }]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Environment :: Web Environment",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+  "Topic :: Software Development :: Libraries",
+  "Typing :: Typed",
+  "License :: OSI Approved :: Apache Software License",
+]
+dependencies = [
+  "genkit",
+  "google-cloud-firestore",
+  "strenum>=0.4.15; python_version < '3.11'",
+]
+description = "Genkit Firebase Plugin"
+keywords = [
+  "genkit",
+  "ai",
+  "llm",
+  "machine-learning",
+  "artificial-intelligence",
+  "generative-ai",
+  "firebase",
+  "google",
+  "firestore",
+  "telemetry",
+]
+license = "Apache-2.0"
+name = "genkit-plugin-firebase"
+readme = "README.md"
+requires-python = ">=3.10"
+version = "0.5.0"
+
+[project.urls]
+"Bug Tracker"   = "https://github.com/firebase/genkit/issues"
+"Documentation" = "https://firebase.google.com/docs/genkit"
+"Homepage"      = "https://github.com/firebase/genkit"
+"Repository"    = "https://github.com/firebase/genkit/tree/main/py"
+
+[build-system]
+build-backend = "hatchling.build"
+requires      = ["hatchling"]
+
+[tool.hatch.build.targets.wheel]
+only-include = ["src/genkit/plugins/firebase"]
+sources = ["src"]

genkit_plugin_firebase-0.5.0/src/genkit/plugins/firebase/__init__.py

@@ -0,0 +1,205 @@
+# Copyright 2025 Google LLC
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Firebase plugin for Genkit.
+
+This plugin provides Firebase integrations for Genkit, including Firestore
+vector stores for RAG and Firebase telemetry export to Google Cloud.
+
+Key Concepts (ELI5)::
+
+    ┌─────────────────────┬────────────────────────────────────────────────────┐
+    │ Concept             │ ELI5 Explanation                                   │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ Firebase            │ Google's app development platform. Like a         │
+    │                     │ toolbox for building apps with database, auth.    │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ Firestore           │ A NoSQL database that syncs in real-time.         │
+    │                     │ Store data as flexible documents.                 │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ Vector Store        │ A database that can find "similar" items.         │
+    │                     │ Like Google but for YOUR documents.               │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ RAG                 │ Retrieval-Augmented Generation. AI looks up       │
+    │                     │ your docs before answering. Fewer hallucinations! │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ Embeddings          │ Convert text to numbers that capture meaning.     │
+    │                     │ "Cat" and "kitten" become similar numbers.        │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ Indexer             │ Stores documents with their embeddings.           │
+    │                     │ Like adding books to a library catalog.           │
+    ├─────────────────────┼────────────────────────────────────────────────────┤
+    │ Retriever           │ Finds documents matching a query.                 │
+    │                     │ Like a librarian finding relevant books.          │
+    └─────────────────────┴────────────────────────────────────────────────────┘
+
+Data Flow (RAG with Firestore)::
+
+    ┌─────────────────────────────────────────────────────────────────────────┐
+    │                  HOW FIRESTORE VECTOR SEARCH WORKS                      │
+    │                                                                         │
+    │    STEP 1: INDEXING (Store your documents)                              │
+    │    ────────────────────────────────────────                             │
+    │    Your Documents                                                       │
+    │    ["How to reset password", "Billing FAQ", ...]                        │
+    │         │                                                               │
+    │         │  (1) Convert text to embeddings                               │
+    │         ▼                                                               │
+    │    ┌─────────────────┐                                                  │
+    │    │  Embedder       │   "Reset password" → [0.12, -0.34, ...]          │
+    │    │  (Gemini, etc.) │                                                  │
+    │    └────────┬────────┘                                                  │
+    │             │                                                           │
+    │             │  (2) Store in Firestore with vectors                      │
+    │             ▼                                                           │
+    │    ┌─────────────────┐                                                  │
+    │    │  Firestore      │   Document + embedding stored together           │
+    │    │  (Vector Index) │                                                  │
+    │    └─────────────────┘                                                  │
+    │                                                                         │
+    │    STEP 2: RETRIEVAL (Find relevant documents)                          │
+    │    ─────────────────────────────────────────────                        │
+    │    User Query: "How do I change my password?"                           │
+    │         │                                                               │
+    │         │  (3) Convert query to embedding                               │
+    │         ▼                                                               │
+    │    ┌─────────────────┐                                                  │
+    │    │  Embedder       │   Query → [0.11, -0.33, ...] (similar!)          │
+    │    └────────┬────────┘                                                  │
+    │             │                                                           │
+    │             │  (4) Find nearest neighbors                               │
+    │             ▼                                                           │
+    │    ┌─────────────────┐                                                  │
+    │    │  Firestore      │   "Reset password" doc is 95% match!             │
+    │    │  Vector Search  │                                                  │
+    │    └────────┬────────┘                                                  │
+    │             │                                                           │
+    │             │  (5) Return matching documents                            │
+    │             ▼                                                           │
+    │    ┌─────────────────┐                                                  │
+    │    │  Your App       │   AI uses these docs to answer accurately        │
+    │    └─────────────────┘                                                  │
+    └─────────────────────────────────────────────────────────────────────────┘
+
+Architecture Overview::
+
+    ┌─────────────────────────────────────────────────────────────────────────┐
+    │                        Firebase Plugin                                  │
+    ├─────────────────────────────────────────────────────────────────────────┤
+    │  Plugin Entry Point (__init__.py)                                       │
+    │  ├── define_firestore_vector_store() - Create Firestore vector store    │
+    │  └── add_firebase_telemetry() - Enable Cloud observability              │
+    ├─────────────────────────────────────────────────────────────────────────┤
+    │  firestore.py - Firestore Vector Store                                  │
+    │  ├── define_firestore_vector_store() - Main factory function            │
+    │  ├── Firestore indexer implementation                                   │
+    │  └── Firestore retriever implementation                                 │
+    ├─────────────────────────────────────────────────────────────────────────┤
+    │  retriever.py - Retriever Implementation                                │
+    │  └── FirestoreRetriever (vector similarity search)                      │
+    └─────────────────────────────────────────────────────────────────────────┘
+
+    ┌─────────────────────────────────────────────────────────────────────────┐
+    │                     Firestore Vector Store Flow                         │
+    │                                                                         │
+    │  Documents ──► Embedder ──► Firestore (with vector index)               │
+    │                                                                         │
+    │  Query ──► Embedder ──► Firestore Vector Search ──► Results             │
+    └─────────────────────────────────────────────────────────────────────────┘
+
+Overview:
+    The Firebase plugin enables:
+    - Firestore as a vector store for document retrieval (RAG)
+    - Telemetry export to Google Cloud Trace and Monitoring
+
+Key Components:
+    ┌─────────────────────────────────────────────────────────────────────────┐
+    │ Component                    │ Purpose                                  │
+    ├──────────────────────────────┼──────────────────────────────────────────┤
+    │ define_firestore_vector_store│ Create a Firestore-backed vector store   │
+    │ add_firebase_telemetry()     │ Enable Cloud Trace/Monitoring export     │
+    └──────────────────────────────┴──────────────────────────────────────────┘
+
+Example:
+    Using Firestore vector store:
+
+    ```python
+    from genkit import Genkit
+    from genkit.plugins.firebase import define_firestore_vector_store
+
+    ai = Genkit(...)
+
+    # Define a Firestore vector store
+    store = define_firestore_vector_store(
+        ai,
+        name='my_store',
+        collection='documents',
+        embedder='vertexai/text-embedding-005',
+    )
+
+    # Index documents
+    await ai.index(indexer=store.indexer, documents=[...])
+
+    # Retrieve documents
+    docs = await ai.retrieve(retriever=store.retriever, query='...')
+    ```
+
+    Enabling telemetry:
+
+    ```python
+    from genkit.plugins.firebase import add_firebase_telemetry
+
+    # Export traces to Cloud Trace (disabled in dev mode by default)
+    add_firebase_telemetry()
+    ```
+
+Caveats:
+    - Requires firebase-admin SDK and Google Cloud credentials
+    - Telemetry is disabled by default in development mode (GENKIT_ENV=dev)
+
+See Also:
+    - Firestore: https://firebase.google.com/docs/firestore
+    - Genkit documentation: https://genkit.dev/
+"""
+
+from genkit.plugins.google_cloud.telemetry.tracing import add_gcp_telemetry
+
+from .firestore import define_firestore_vector_store
+
+
+def package_name() -> str:
+    """Get the package name for the Firebase plugin.
+
+    Returns:
+        The fully qualified package name as a string.
+    """
+    return 'genkit.plugins.firebase'
+
+
+def add_firebase_telemetry() -> None:
+    """Add Firebase telemetry export to Google Cloud Observability.
+
+    Exports traces to Cloud Trace and metrics to Cloud Monitoring.
+    In development (GENKIT_ENV=dev), telemetry is disabled by default.
+    """
+    add_gcp_telemetry(force_export=False)
+
+
+__all__ = [
+    'add_firebase_telemetry',
+    'define_firestore_vector_store',
+    'package_name',
+]

genkit_plugin_firebase-0.5.0/src/genkit/plugins/firebase/firestore.py

@@ -0,0 +1,103 @@
+# Copyright 2025 Google LLC
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+
+"""Firestore vector store operations for Genkit."""
+
+from collections.abc import Callable
+
+from google.cloud import firestore
+from google.cloud.firestore_v1 import DocumentSnapshot
+from google.cloud.firestore_v1.base_vector_query import DistanceMeasure
+
+from genkit.ai import Genkit
+from genkit.blocks.retriever import RetrieverOptions, retriever_action_metadata
+from genkit.core.action.types import ActionKind
+from genkit.core.typing import DocumentPart
+from genkit.plugins.firebase.retriever import FirestoreRetriever
+
+from .constant import MetadataTransformFn
+
+
+def firestore_action_name(name: str) -> str:
+    """Create a firestore action name.
+
+    Args:
+        name: Base name for the action
+
+    Returns:
+        str: Firestore action name.
+
+    """
+    return f'firestore/{name}'
+
+
+def define_firestore_vector_store(
+    ai: Genkit,
+    *,
+    name: str,
+    embedder: str,
+    embedder_options: dict[str, object] | None = None,
+    collection: str,
+    vector_field: str,
+    content_field: str | Callable[[DocumentSnapshot], list['DocumentPart']],
+    firestore_client: firestore.Client,
+    distance_measure: DistanceMeasure = DistanceMeasure.COSINE,
+    metadata_fields: list[str] | MetadataTransformFn | None = None,
+) -> str:
+    """Define and register a Firestore vector store retriever.
+
+    Args:
+        ai: The Genkit instance to register the retriever with.
+        name: Name of the retriever.
+        embedder: The embedder to use (e.g., 'vertexai/text-embedding-004').
+        embedder_options: Optional configuration to pass to the embedder.
+        collection: The name of the Firestore collection to query.
+        vector_field: The name of the field containing the vector embeddings.
+        content_field: The name of the field containing the document content, you wish to return.
+        firestore_client: The Firestore database instance from which to query.
+        distance_measure: The distance measure to use when comparing vectors. Defaults to 'COSINE'.
+        metadata_fields: Optional list of metadata fields to include.
+
+    Returns:
+        The registered retriever name.
+    """
+    retriever = FirestoreRetriever(
+        ai=ai,
+        name=name,
+        embedder=embedder,
+        embedder_options=embedder_options,
+        firestore_client=firestore_client,
+        collection=collection,
+        vector_field=vector_field,
+        content_field=content_field,
+        distance_measure=distance_measure,
+        metadata_fields=metadata_fields,
+    )
+
+    action_name = firestore_action_name(name)
+
+    ai.registry.register_action(
+        kind=ActionKind.RETRIEVER,
+        name=action_name,
+        fn=retriever.retrieve,
+        metadata=retriever_action_metadata(
+            name=action_name,
+            options=RetrieverOptions(label=name),
+        ).metadata,
+    )
+
+    return action_name

{genkit_plugin_firebase-0.3.2 → genkit_plugin_firebase-0.5.0}/src/genkit/plugins/firebase/retriever.py

@@ -14,14 +14,18 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+
+"""Firestore retriever implementation for Genkit."""
+
 from collections.abc import Callable
-from typing import Any
 
+from google.cloud import firestore
 from google.cloud.firestore_v1 import DocumentSnapshot
 from google.cloud.firestore_v1.base_vector_query import DistanceMeasure
 from google.cloud.firestore_v1.vector import Vector
 
 from genkit.ai import Genkit
+from genkit.core.typing import DocumentPart, TextPart
 from genkit.types import ActionRunContext, Document, GenkitError, RetrieverRequest, RetrieverResponse
 
 from .constant import MetadataTransformFn
@@ -31,45 +35,58 @@ class FirestoreRetriever:
     """Retrieves documents from Google Cloud Firestore using vector similarity search.
 
     Attributes:
-        ai: An instance of the Genkit AI registry.
-        params: A FirestoreRetrieverConfig object containing the configuration
-            for the retriever
+        ai: Genkit instance used to embed queries.
+        name: Name of the retriever.
+        embedder: The embedder to use for query embeddings.
+        embedder_options: Optional configuration to pass to the embedder.
         firestore_client: The initialized Firestore client from the configuration.
+        collection: The name of the Firestore collection to query.
+        vector_field: The name of the field containing the vector embeddings.
+        content_field: The name of the field containing the document content.
+        distance_measure: The distance measure to use when comparing vectors.
+        metadata_fields: Optional list of metadata fields to include.
     """
 
     def __init__(
         self,
         ai: Genkit,
         name: str,
-        firestore_client: Any,
+        embedder: str,
+        embedder_options: dict[str, object] | None,
+        firestore_client: firestore.Client,
         collection: str,
         vector_field: str,
-        content_field: str | Callable[[DocumentSnapshot], list[dict[str, str]]],
-        embedder: str,
-        embedder_options: dict[str, Any] | None = None,
+        content_field: str | Callable[[DocumentSnapshot], list[DocumentPart]],
         distance_measure: DistanceMeasure = DistanceMeasure.COSINE,
         metadata_fields: list[str] | MetadataTransformFn | None = None,
-    ):
+    ) -> None:
         """Initialize the FirestoreRetriever.
 
         Args:
-            ai: An instance of the Genkit AI registry.
-            params: A FirestoreRetrieverConfig object containing the configuration
-                for the retriever
+            ai: Genkit instance used to embed queries.
+            name: Name of the retriever.
+            embedder: The embedder to use for query embeddings.
+            embedder_options: Optional configuration to pass to the embedder.
+            firestore_client: The Firestore database instance from which to query.
+            collection: The name of the Firestore collection to query.
+            vector_field: The name of the field containing the vector embeddings.
+            content_field: The name of the field containing the document content.
+            distance_measure: The distance measure to use when comparing vectors.
+            metadata_fields: Optional list of metadata fields to include.
         """
         self.ai = ai
         self.name = name
+        self.embedder = embedder
+        self.embedder_options = embedder_options
         self.firestore_client = firestore_client
         self.collection = collection
         self.vector_field = vector_field
         self.content_field = content_field
-        self.embedder = embedder
-        self.embedder_options = embedder_options
         self.distance_measure = distance_measure
         self.metadata_fields = metadata_fields
         self._validate_config()
 
-    def _validate_config(self):
+    def _validate_config(self) -> None:
         """Validate the FirestoreRetriever configuration.
 
         Raises:
@@ -84,7 +101,7 @@ class FirestoreRetriever:
         if not self.firestore_client:
             raise ValueError('Firestore Retriever config must include firestore client.')
 
-    def _to_content(self, doc_snapshot: DocumentSnapshot) -> list[dict[str, str]]:
+    def _to_content(self, doc_snapshot: DocumentSnapshot) -> list[DocumentPart]:
         """Convert a Firestore document snapshot to a list of content dictionaries.
 
         Args:
@@ -98,9 +115,9 @@ class FirestoreRetriever:
             return content_field(doc_snapshot)
         else:
             content = doc_snapshot.get(content_field)
-            return [{'text': content}] if content else []
+            return [DocumentPart(root=TextPart(text=str(content)))] if content else []
 
-    def _to_metadata(self, doc_snapshot: DocumentSnapshot) -> Document:
+    def _to_metadata(self, doc_snapshot: DocumentSnapshot) -> dict[str, object]:
         """Convert a Firestore document snapshot to a list of metadata dictionaries.
 
         Args:
@@ -109,17 +126,19 @@ class FirestoreRetriever:
         Returns:
             A list of dictionaries containing the metadata of the document.
         """
-        metadata: dict[str, Any] = {}
+        metadata: dict[str, object] = {}
         metadata_fields = self.metadata_fields
         if metadata_fields:
             if callable(metadata_fields):
+                # pyrefly: ignore[bad-assignment] - MetadataTransformFn returns dict[str, Any]
                 metadata = metadata_fields(doc_snapshot)
             else:
+                doc_dict = doc_snapshot.to_dict() or {}
                 for field in metadata_fields:
-                    if field in doc_snapshot:
-                        metadata[field] = doc_snapshot.get(field)
+                    if field in doc_dict:
+                        metadata[field] = doc_dict[field]
         else:
-            metadata = doc_snapshot.to_dict()
+            metadata = doc_snapshot.to_dict() or {}
             vector_field = self.vector_field
             content_field = self.content_field
             if vector_field in metadata:
@@ -148,17 +167,17 @@ class FirestoreRetriever:
         Returns:
             A RetrieverResponse Object containing retrieved documents
         """
-        query = request.query
+        query = Document.from_document_data(document_data=request.query)
         query_embedding_result = await self.ai.embed(
             embedder=self.embedder,
-            documents=[query],
+            content=query,
             options=self.embedder_options,
         )
 
-        if not query_embedding_result.embeddings or len(query_embedding_result.embeddings) == 0:
+        if not query_embedding_result:
             raise GenkitError(message='Embedder returned no embeddings')
 
-        query_embedding = query_embedding_result.embeddings[0].embedding
+        query_embedding = query_embedding_result[0].embedding
         query_vector = Vector(query_embedding)
         collection = self.firestore_client.collection(self.collection)
 

genkit_plugin_firebase-0.5.0/src/genkit/plugins/firebase/tests/telemetry_test.py

@@ -0,0 +1,113 @@
+# Copyright 2025 Google LLC
+#
+# 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.
+
+"""Tests for Firebase telemetry functionality."""
+
+from unittest.mock import MagicMock, patch
+
+from opentelemetry.sdk.trace import ReadableSpan
+
+from genkit.plugins.firebase import add_firebase_telemetry
+from genkit.plugins.google_cloud.telemetry.metrics import record_generate_metrics
+
+
+def _create_model_span(
+    model_name: str = 'gemini-pro',
+    path: str = '/{myflow,t:flow}',
+    output: str = '{"usage": {"inputTokens": 100, "outputTokens": 50}}',
+    is_ok: bool = True,
+    start_time: int = 1000000000,
+    end_time: int = 1500000000,
+) -> MagicMock:
+    """Helper function to create a model action span for testing.
+
+    Args:
+        model_name: The model name for genkit:name attribute
+        path: The genkit:path value
+        output: The genkit:output JSON string
+        is_ok: Whether the span status is ok
+        start_time: Span start time in nanoseconds
+        end_time: Span end time in nanoseconds
+
+    Returns:
+        A mocked ReadableSpan with model action attributes
+    """
+    mock_span = MagicMock(spec=ReadableSpan)
+    mock_span.attributes = {
+        'genkit:type': 'action',
+        'genkit:metadata:subtype': 'model',
+        'genkit:name': model_name,
+        'genkit:path': path,
+        'genkit:output': output,
+    }
+    mock_span.status.is_ok = is_ok
+    mock_span.start_time = start_time
+    mock_span.end_time = end_time
+    return mock_span
+
+
+@patch('genkit.plugins.firebase.add_gcp_telemetry')
+def test_firebase_telemetry_delegates_to_gcp(mock_add_gcp_telemetry: MagicMock) -> None:
+    """Test that Firebase telemetry delegates to GCP telemetry."""
+    add_firebase_telemetry()
+    mock_add_gcp_telemetry.assert_called_once_with(force_export=False)
+
+
+@patch('genkit.plugins.google_cloud.telemetry.metrics._output_tokens')
+@patch('genkit.plugins.google_cloud.telemetry.metrics._input_tokens')
+@patch('genkit.plugins.google_cloud.telemetry.metrics._latency')
+@patch('genkit.plugins.google_cloud.telemetry.metrics._failures')
+@patch('genkit.plugins.google_cloud.telemetry.metrics._requests')
+def test_record_generate_metrics_with_model_action(
+    mock_requests: MagicMock,
+    mock_failures: MagicMock,
+    mock_latency: MagicMock,
+    mock_input_tokens: MagicMock,
+    mock_output_tokens: MagicMock,
+) -> None:
+    """Test that metrics are recorded for model action spans with usage data."""
+    # Setup mocks
+    mock_request_counter = MagicMock()
+    mock_latency_histogram = MagicMock()
+    mock_input_counter = MagicMock()
+    mock_output_counter = MagicMock()
+
+    mock_requests.return_value = mock_request_counter
+    mock_failures.return_value = MagicMock()
+    mock_latency.return_value = mock_latency_histogram
+    mock_input_tokens.return_value = mock_input_counter
+    mock_output_tokens.return_value = mock_output_counter
+
+    # Create test span using helper
+    mock_span = _create_model_span(
+        model_name='gemini-pro',
+        path='/{myflow,t:flow}',
+        output='{"usage": {"inputTokens": 100, "outputTokens": 50}}',
+    )
+
+    # Execute
+    record_generate_metrics(mock_span)
+
+    # Verify dimensions
+    expected_dimensions = {'model': 'gemini-pro', 'source': 'myflow', 'error': 'none'}
+
+    # Verify requests counter
+    mock_request_counter.add.assert_called_once_with(1, expected_dimensions)
+
+    # Verify latency (500ms = 1.5s - 1.0s)
+    mock_latency_histogram.record.assert_called_once_with(500.0, expected_dimensions)
+
+    # Verify token counts
+    mock_input_counter.add.assert_called_once_with(100, expected_dimensions)
+    mock_output_counter.add.assert_called_once_with(50, expected_dimensions)

genkit_plugin_firebase-0.5.0/tests/firebase_plugin_test.py

@@ -0,0 +1,43 @@
+# Copyright 2026 Google LLC
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""Tests for Firebase plugin."""
+
+from unittest.mock import MagicMock, patch
+
+from genkit.plugins.firebase import (
+    add_firebase_telemetry,
+    define_firestore_vector_store,
+    package_name,
+)
+
+
+def test_package_name() -> None:
+    """Test package_name returns correct value."""
+    assert package_name() == 'genkit.plugins.firebase'
+
+
+@patch('genkit.plugins.firebase.add_gcp_telemetry')
+def test_add_firebase_telemetry_calls_gcp_telemetry(mock_add_gcp: MagicMock) -> None:
+    """Test add_firebase_telemetry delegates to GCP telemetry."""
+    add_firebase_telemetry()
+    mock_add_gcp.assert_called_once_with(force_export=False)
+
+
+def test_define_firestore_vector_store_exported() -> None:
+    """Test define_firestore_vector_store is exported."""
+    # Just verify the function is importable and callable
+    assert callable(define_firestore_vector_store)

genkit_plugin_firebase-0.3.2/pyproject.toml

@@ -1,36 +0,0 @@
-[project]
-authors = [{ name = "Google" }]
-classifiers = [
-  "Development Status :: 3 - Alpha",
-  "Environment :: Console",
-  "Environment :: Web Environment",
-  "Intended Audience :: Developers",
-  "Operating System :: OS Independent",
-  "License :: OSI Approved :: Apache Software License",
-  "Programming Language :: Python",
-  "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-  "Topic :: Scientific/Engineering :: Artificial Intelligence",
-  "Topic :: Software Development :: Libraries",
-]
-dependencies = [
-  "genkit",
-  "google-cloud-firestore",
-  "strenum>=0.4.15; python_version < '3.11'",
-]
-description = "Genkit Firebase Plugin"
-license = { text = "Apache-2.0" }
-name = "genkit-plugin-firebase"
-readme = "README.md"
-requires-python = ">=3.10"
-version = "0.3.2"
-
-[build-system]
-build-backend = "hatchling.build"
-requires      = ["hatchling"]
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/genkit", "src/genkit/plugins"]

genkit_plugin_firebase-0.3.2/src/genkit/plugins/firebase/__init__.py

@@ -1,30 +0,0 @@
-# Copyright 2025 Google LLC
-#
-# 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.
-#
-# SPDX-License-Identifier: Apache-2.0
-
-
-"""Firebase Plugin for Genkit."""
-
-
-def package_name() -> str:
-    """Get the package name for the Firebase plugin.
-
-    Returns:
-        The fully qualified package name as a string.
-    """
-    return 'genkit.plugins.firebase'
-
-
-__all__ = ['package_name']

genkit_plugin_firebase-0.3.2/src/genkit/plugins/firebase/firestore.py

@@ -1,112 +0,0 @@
-# Copyright 2025 Google LLC
-#
-# 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.
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from collections.abc import Callable
-from typing import Any
-
-from google.cloud.firestore_v1 import DocumentSnapshot
-from google.cloud.firestore_v1.base_vector_query import DistanceMeasure
-
-from genkit.ai import GenkitRegistry, Plugin
-from genkit.plugins.firebase.retriever import FirestoreRetriever
-
-from .constant import MetadataTransformFn
-
-
-def firestore_action_name(name: str) -> str:
-    """Create a firestore action name.
-
-    Args:
-        name: Base name for the action
-
-    Returns:
-        str: Firestore action name.
-
-    """
-    return f'firestore/{name}'
-
-
-class FirestoreVectorStore(Plugin):
-    """Firestore retriever plugin.
-    Args:
-        name: name if the retriever.
-        collection: The name of the Firestore collection to query.
-        vector_field: The name of the field containing the vector embeddings.
-        content_field: The name of the field containing the document content, you wish to return.
-        embedder: The embedder to use with this retriever.
-        embedder_options: Optional configuration to pass to the embedder.
-        distance_measure: The distance measure to use when comparing vectors. Defaults to 'COSINE'.
-        firestore_client: The Firestore database instance from which to query.
-        metadata_fields: Optional list of metadata fields to include.
-    """
-
-    name = 'firebaseFirestore'
-
-    def __init__(
-        self,
-        name: str,
-        firestore_client: Any,
-        collection: str,
-        vector_field: str,
-        content_field: str | Callable[[DocumentSnapshot], list[dict[str, str]]],
-        embedder: str,
-        embedder_options: dict[str, Any] | None = None,
-        distance_measure: DistanceMeasure = DistanceMeasure.COSINE,
-        metadata_fields: list[str] | MetadataTransformFn | None = None,
-    ):
-        """Initialize the firestore plugin.
-
-        Args:
-            params: List of firestore retriever configurations.
-        """
-        self.name = name
-        self.firestore_client = firestore_client
-        self.collection = collection
-        self.vector_field = vector_field
-        self.content_field = content_field
-        self.embedder = embedder
-        self.embedder_options = embedder_options
-        self.distance_measure = distance_measure
-        self.metadata_fields = metadata_fields
-
-    def initialize(self, ai: GenkitRegistry) -> None:
-        """Initialize firestore plugin.
-
-        Register actions with the registry making them available for use in the Genkit framework.
-
-        Args:
-            ai: The registry to register actions with.
-
-        Returns:
-            None
-        """
-        retriever = FirestoreRetriever(
-            ai=ai,
-            name=self.name,
-            firestore_client=self.firestore_client,
-            collection=self.collection,
-            vector_field=self.vector_field,
-            content_field=self.content_field,
-            embedder=self.embedder,
-            embedder_options=self.embedder_options,
-            distance_measure=self.distance_measure,
-            metadata_fields=self.metadata_fields,
-        )
-
-        return ai.define_retriever(
-            name=firestore_action_name(self.name),
-            fn=retriever.retrieve,
-        )