From 98707ac03d4a4e2526b54730b935448c6b65aa22 Mon Sep 17 00:00:00 2001 From: Abraham Lazaro Martinez Date: Tue, 6 May 2025 16:32:06 +0000 Subject: [PATCH 1/2] feat(py): add vertex-ai vector search with firestore sample --- .../vertex-ai-vector-search-firestore/LICENSE | 201 ++++++++++++++++++ .../README.md | 27 +++ .../pyproject.toml | 39 ++++ .../src/sample.py | 135 ++++++++++++ py/uv.lock | 24 +++ 5 files changed, 426 insertions(+) create mode 100644 py/samples/vertex-ai-vector-search-firestore/LICENSE create mode 100644 py/samples/vertex-ai-vector-search-firestore/README.md create mode 100644 py/samples/vertex-ai-vector-search-firestore/pyproject.toml create mode 100644 py/samples/vertex-ai-vector-search-firestore/src/sample.py diff --git a/py/samples/vertex-ai-vector-search-firestore/LICENSE b/py/samples/vertex-ai-vector-search-firestore/LICENSE new file mode 100644 index 0000000000..2205396735 --- /dev/null +++ b/py/samples/vertex-ai-vector-search-firestore/LICENSE @@ -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 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. diff --git a/py/samples/vertex-ai-vector-search-firestore/README.md b/py/samples/vertex-ai-vector-search-firestore/README.md new file mode 100644 index 0000000000..591c705d9a --- /dev/null +++ b/py/samples/vertex-ai-vector-search-firestore/README.md @@ -0,0 +1,27 @@ +# Vertex AI - Vector Search Firestore + +An example demonstrating the use Vector Search API with Firestore retriever for Vertex AI + +## Setup environment + +1. Install [GCP CLI](https://cloud.google.com/sdk/docs/install). +2. Run the following code to connect to VertexAI. +```bash +gcloud auth application-default login +``` +3. Set the following env vars to run the sample +``` +export LOCATION='' +export PROJECT_ID='' +export FIRESTORE_COLLECTION='' +export VECTOR_SEARCH_DEPLOYED_INDEX_ID='' +export VECTOR_SEARCH_INDEX_ENDPOINT_PATH='' +export VECTOR_SEARCH_API_ENDPOINT='' +``` +4. Run the sample. + +## Run the sample + +```bash +genkit start -- uv run src/sample.py +``` diff --git a/py/samples/vertex-ai-vector-search-firestore/pyproject.toml b/py/samples/vertex-ai-vector-search-firestore/pyproject.toml new file mode 100644 index 0000000000..3413399903 --- /dev/null +++ b/py/samples/vertex-ai-vector-search-firestore/pyproject.toml @@ -0,0 +1,39 @@ +[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", + "genkit-plugin-vertex-ai", + "pydantic>=2.10.5", + "structlog>=25.2.0", + "google-cloud-firestore", + "strenum>=0.4.15; python_version < '3.11'", +] +description = "An example demonstrating the use Vector Search API with Firestore retriever for Vertex AI" +license = { text = "Apache-2.0" } +name = "vertex-ai-vector-search-firestore" +readme = "README.md" +requires-python = ">=3.10" +version = "0.1.0" + +[build-system] +build-backend = "hatchling.build" +requires = ["hatchling"] + +[tool.hatch.build.targets.wheel] +packages = ["src/sample"] diff --git a/py/samples/vertex-ai-vector-search-firestore/src/sample.py b/py/samples/vertex-ai-vector-search-firestore/src/sample.py new file mode 100644 index 0000000000..a8bd67f563 --- /dev/null +++ b/py/samples/vertex-ai-vector-search-firestore/src/sample.py @@ -0,0 +1,135 @@ +# 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 + +import os +import time + +import structlog +from google.cloud import aiplatform, firestore +from pydantic import BaseModel + +from genkit.ai import Genkit +from genkit.blocks.document import Document +from genkit.plugins.vertex_ai import ( + EmbeddingModels, + VertexAI, + VertexAIVectorSearch, + vertexai_name, +) +from genkit.plugins.vertex_ai.models.retriever import FirestoreRetriever + +LOCATION = os.getenv('LOCATION') +PROJECT_ID = os.getenv('PROJECT_ID') +EMBEDDING_MODEL = EmbeddingModels.TEXT_EMBEDDING_004_ENG + +FIRESTORE_COLLECTION = os.getenv('FIRESTORE_COLLECTION') + +VECTOR_SEARCH_DEPLOYED_INDEX_ID = os.getenv('VECTOR_SEARCH_DEPLOYED_INDEX_ID') +VECTOR_SEARCH_INDEX_ENDPOINT_PATH = os.getenv('VECVECTOR_SEARCH_INDEX_ENDPOINT_PATHTOR_SEARCH_INDEX_ENDPOINT_ID') +VECTOR_SEARCH_API_ENDPOINT = os.getenv('VECTOR_SEARCH_API_ENDPOINT') + +firestore_client = firestore.Client(project=PROJECT_ID) +aiplatform.init(project=PROJECT_ID, location=LOCATION) + +logger = structlog.get_logger(__name__) + +ai = Genkit( + plugins=[ + VertexAI(), + VertexAIVectorSearch( + retriever=FirestoreRetriever, + retriever_extra_args={ + 'firestore_client': firestore_client, + 'collection_name': FIRESTORE_COLLECTION, + }, + embedder=vertexai_name(EMBEDDING_MODEL), + embedder_options={ + 'task': 'RETRIEVAL_DOCUMENT', + 'output_dimensionality': 128, + }, + ), + ] +) + + +class QueryFlowInputSchema(BaseModel): + """Input schema.""" + query: str + k: int + + +class QueryFlowOutputSchema(BaseModel): + """Output schema.""" + result: list[dict] + length: int + time: int + + +@ai.flow(name='queryFlow') +async def query_flow(_input: QueryFlowInputSchema) -> QueryFlowOutputSchema: + """Executes a vector search with VertexAI Vector Search.""" + start_time = time.time() + + query_document = Document.from_text(text=_input.query) + query_document.metadata = { + 'api_endpoint': VECTOR_SEARCH_API_ENDPOINT, + 'index_endpoint_path': VECTOR_SEARCH_INDEX_ENDPOINT_PATH, + 'deployed_index_id': VECTOR_SEARCH_DEPLOYED_INDEX_ID, + } + + options = { + 'limit': 10, + } + + result: list[Document] = await ai.retrieve( + retriever=vertexai_name('vertexAIVectorSearch'), + query=query_document, + options=options, + ) + + end_time = time.time() + + duration = int(end_time - start_time) + + result_data = [] + for doc in result.documents: + result_data.append({ + 'id': doc.metadata.get('id'), + 'text': doc.content[0].root.text, + 'distance': doc.metadata.get('distance'), + }) + + result_data = sorted(result_data, key=lambda x: x['distance']) + + return QueryFlowOutputSchema( + result=result_data, + length=len(result_data), + time=duration, + ) + + +async def main() -> None: + """Main function.""" + query_input = QueryFlowInputSchema( + query="Content for doc", + k=3, + ) + + await logger.ainfo(await query_flow(query_input)) + + +if __name__ == '__main__': + ai.run_main(main()) diff --git a/py/uv.lock b/py/uv.lock index 8df376b809..7a8d892dca 100644 --- a/py/uv.lock +++ b/py/uv.lock @@ -36,6 +36,7 @@ members = [ "ollama-simple-embed", "short-n-long", "tool-interrupts", + "vertex-ai-vector-search-firestore", ] [[package]] @@ -4623,6 +4624,29 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/63/9a/0962b05b308494e3202d3f794a6e85abe471fe3cafdbcf95c2e8c713aabd/uvloop-0.21.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a5c39f217ab3c663dc699c04cbd50c13813e31d917642d459fdcec07555cc553", size = 4660018 }, ] +[[package]] +name = "vertex-ai-vector-search-firestore" +version = "0.1.0" +source = { editable = "samples/vertex-ai-vector-search-firestore" } +dependencies = [ + { name = "genkit" }, + { name = "genkit-plugin-vertex-ai" }, + { name = "google-cloud-firestore" }, + { name = "pydantic" }, + { name = "strenum", marker = "python_full_version < '3.11'" }, + { name = "structlog" }, +] + +[package.metadata] +requires-dist = [ + { name = "genkit", editable = "packages/genkit" }, + { name = "genkit-plugin-vertex-ai", editable = "plugins/vertex-ai" }, + { name = "google-cloud-firestore" }, + { name = "pydantic", specifier = ">=2.10.5" }, + { name = "strenum", marker = "python_full_version < '3.11'", specifier = ">=0.4.15" }, + { name = "structlog", specifier = ">=25.2.0" }, +] + [[package]] name = "virtualenv" version = "20.30.0" From 646e5b13f18ad94078662d22b5fb1a28dd301458 Mon Sep 17 00:00:00 2001 From: Abraham Lazaro Martinez Date: Thu, 8 May 2025 14:39:28 +0000 Subject: [PATCH 2/2] add table definitions --- py/samples/vertex-ai-vector-search-firestore/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/py/samples/vertex-ai-vector-search-firestore/README.md b/py/samples/vertex-ai-vector-search-firestore/README.md index 591c705d9a..0d66b437f7 100644 --- a/py/samples/vertex-ai-vector-search-firestore/README.md +++ b/py/samples/vertex-ai-vector-search-firestore/README.md @@ -20,6 +20,16 @@ export VECTOR_SEARCH_API_ENDPOINT='' ``` 4. Run the sample. +## Env vars definition +| Variable | Definition | +| ----------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `LOCATION` | The Google Cloud region or multi-region where your resources (e.g., Vertex AI Index, Firestore database) are located. Example: `us-central1`. | +| `PROJECT_ID` | The name or unique identifier for your Google Cloud Project. | +| `FIRESTORE_COLLECTION` | The name of the Firestore collection used, for example, to store metadata associated with your vectors or the source documents. | +| `VECTOR_SEARCH_DEPLOYED_INDEX_ID` | The ID of your deployed Vertex AI Vector Search index that you want to query. | +| `VECTOR_SEARCH_INDEX_ENDPOINT_PATH` | The full storage path of the Vertex AI Vector Search Index Endpoint. Example: `projects/YOUR_PROJECT_ID/locations/YOUR_LOCATION/indexEndpoints/YOUR_INDEX_ENDPOINT_ID`. | +| `VECTOR_SEARCH_API_ENDPOINT` | The regional API endpoint for making calls to the Vertex AI Vector Search service. Example: `YOUR_LOCATION-aiplatform.googleapis.com`. | + ## Run the sample ```bash