Skip to main content

Genkit Google GenAI Plugin

Project description

Google GenAI Plugin

This Genkit plugin provides a unified interface for Google AI (Gemini) and Vertex AI models, embedding, and other services.

Setup environment

uv venv
source .venv/bin/activate
pip install genkit-plugins-google-genai

Configuration

Google AI (AI Studio)

To use Google AI models, obtain an API key from Google AI Studio and set it in your environment:

export GEMINI_API_KEY='<your-api-key>'

Vertex AI (Google Cloud)

To use Vertex AI models, ensure you have a Google Cloud project and Application Default Credentials (ADC) set up:

gcloud auth application-default login

Features

Dynamic Models

The plugin automatically discovers available models from the API upon initialization. You can use any model name supported by the API (e.g., googleai/gemini-2.0-flash-exp, vertexai/gemini-1.5-pro).

Dynamic Configuration

New or experimental parameters can be passed flexibly using model_validate to bypass strict schema checks:

from genkit.plugins.google_genai import GeminiConfigSchema

config = GeminiConfigSchema.model_validate({
    'temperature': 1.0,
    'response_modalities': ['TEXT', 'IMAGE'],
})

Vertex AI Rerankers

The VertexAI plugin provides semantic rerankers for improving RAG quality by re-scoring documents based on relevance:

from genkit import Genkit
from genkit.plugins.google_genai import VertexAI

ai = Genkit(plugins=[VertexAI(project='my-project')])

# Rerank documents after retrieval
ranked_docs = await ai.rerank(
    reranker='vertexai/semantic-ranker-default@latest',
    query='What is machine learning?',
    documents=retrieved_docs,
    options={'top_n': 5},
)

Supported Models:

Model Description
semantic-ranker-default@latest Latest default semantic ranker
semantic-ranker-default-004 Semantic ranker version 004
semantic-ranker-fast-004 Fast variant (lower latency)

Vertex AI Evaluators

Built-in evaluators for assessing model output quality. Evaluators are automatically registered when using the VertexAI plugin and are accessed via ai.evaluate():

from genkit import Genkit
from genkit.core.typing import BaseDataPoint
from genkit.plugins.google_genai import VertexAI

ai = Genkit(plugins=[VertexAI(project='my-project')])

# Prepare test dataset
dataset = [
    BaseDataPoint(
        input='Write about AI.',
        output='AI is transforming industries through intelligent automation.',
    ),
]

# Evaluate fluency (scores 1-5)
results = await ai.evaluate(
    evaluator='vertexai/fluency',
    dataset=dataset,
)

for result in results.root:
    print(f'Score: {result.evaluation.score}')

Supported Metrics:

Metric Description
BLEU Translation quality (compare to reference)
ROUGE Summarization quality
FLUENCY Language mastery and readability
SAFETY Harmful/inappropriate content detection
GROUNDEDNESS Hallucination detection
SUMMARIZATION_QUALITY Overall summarization ability

Examples

For comprehensive usage examples, see:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

genkit_plugin_google_genai-0.5.1.tar.gz (69.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

genkit_plugin_google_genai-0.5.1-py3-none-any.whl (69.4 kB view details)

Uploaded Python 3

File details

Details for the file genkit_plugin_google_genai-0.5.1.tar.gz.

File metadata

File hashes

Hashes for genkit_plugin_google_genai-0.5.1.tar.gz
Algorithm Hash digest
SHA256 61cc19c7aa111171358934fde866306eb6a3c86357372898a05777ae7184308a
MD5 1984c7cba3d2064c01d4982f1a0a92b2
BLAKE2b-256 b13ae30a83d7022964fb88c54e77b201593821404a54908dcd77750cf7237171

See more details on using hashes here.

Provenance

The following attestation bundles were made for genkit_plugin_google_genai-0.5.1.tar.gz:

Publisher: publish_python.yml on firebase/genkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file genkit_plugin_google_genai-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for genkit_plugin_google_genai-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ad31da28d9ab86f512d0869ddb92ac340b04cb681795ccea4a9b063422572a7
MD5 f7b1b383672bf9a0fc2a685d8f857116
BLAKE2b-256 4f800dff88103bd6f31f42514a1c7b0140db8c79e174c80794f13d136c1beb10

See more details on using hashes here.

Provenance

The following attestation bundles were made for genkit_plugin_google_genai-0.5.1-py3-none-any.whl:

Publisher: publish_python.yml on firebase/genkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page