Skip to content

chore: clean up references to Genkit #2445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Run e2e tests](https://github.com/firebase/genkit/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/firebase/genkit/actions/workflows/e2e-tests.yml)

![Firebase Genkit logo](docs/resources/genkit-logo-dark.png#gh-dark-mode-only 'Firebase Genkit')
![Firebase Genkit logo](docs/resources/genkit-logo.png#gh-light-mode-only 'Firebase Genkit')
![Genkit logo](docs/resources/genkit-logo-dark.png#gh-dark-mode-only 'Genkit')
![Genkit logo](docs/resources/genkit-logo.png#gh-light-mode-only 'Genkit')

Genkit is a framework for building AI-powered applications. It provides open source libraries for Node.js and Go, along with tools to help you debug and iterate quickly.

Expand Down
4 changes: 2 additions & 2 deletions docs-go/cloud-run.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Firebase Genkit with Cloud Run
# Genkit with Cloud Run

You can deploy Firebase Genkit flows as web services using Cloud Run. This page,
You can deploy Genkit flows as web services using Cloud Run. This page,
as an example, walks you through the process of deploying the default sample
flow.

Expand Down
2 changes: 1 addition & 1 deletion docs-go/deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploy flows to any app hosting platform

You can deploy Firebase Genkit flows as web services using any service that can
You can deploy Genkit flows as web services using any service that can
host a Go binary.
This page, as an example, walks you through the general process of deploying the
default sample flow, and points out where you must take provider-specific
Expand Down
2 changes: 1 addition & 1 deletion docs-go/dotprompt.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Managing prompts with Dotprompt

Firebase Genkit provides the Dotprompt plugin and text format to help you write
Genkit provides the Dotprompt plugin and text format to help you write
and organize your generative AI prompts.

Dotprompt is designed around the premise that _prompts are code_. You write and
Expand Down
2 changes: 1 addition & 1 deletion docs-go/flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Flows are wrapped functions with some additional characteristics over direct
calls: they are strongly typed, streamable, locally and remotely callable, and
fully observable.
Firebase Genkit provides CLI and developer UI tooling for running and debugging flows.
Genkit provides CLI and developer UI tooling for running and debugging flows.

## Defining flows

Expand Down
2 changes: 1 addition & 1 deletion docs-go/get-started-go.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Get started with Genkit using Go (alpha)

The Firebase Genkit libraries for Go are now available for preview! Because the
The Genkit libraries for Go are now available for preview! Because the
Go libraries are currently in Alpha, you might see API and functional changes as
development progresses. We recommend using it only for prototyping and
exploration.
Expand Down
4 changes: 2 additions & 2 deletions docs-go/models.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Generating content

Firebase Genkit provides an easy interface for generating content with LLMs.
Genkit provides an easy interface for generating content with LLMs.

## Models

Models in Firebase Genkit are libraries and abstractions that provide access to
Models in Genkit are libraries and abstractions that provide access to
various Google and non-Google LLMs.

Models are fully instrumented for observability and come with tooling
Expand Down
2 changes: 1 addition & 1 deletion docs-go/monitoring.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Monitoring

Firebase Genkit provides two complementary monitoring features: OpenTelemetry
Genkit provides two complementary monitoring features: OpenTelemetry
export and trace inspection using the developer UI.

## OpenTelemetry export
Expand Down
2 changes: 1 addition & 1 deletion docs-go/plugin-authoring-telemetry.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Writing a Genkit telemetry plugin

The Firebase Genkit libraries are instrumented with [OpenTelemetry](http://opentelemetry.io)
The Genkit libraries are instrumented with [OpenTelemetry](http://opentelemetry.io)
to support collecting traces, metrics, and logs. Genkit users can export this
telemetry data to monitoring and visualization tools by installing a plugin that
configures the [OpenTelemetry Go SDK](https://opentelemetry.io/docs/languages/go/getting-started/)
Expand Down
2 changes: 1 addition & 1 deletion docs-go/plugin-authoring.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Writing Genkit plugins

Firebase Genkit's capabilities are designed to be extended by plugins. Genkit
Genkit's capabilities are designed to be extended by plugins. Genkit
plugins are configurable modules that can provide models, retrievers, indexers,
trace stores, and more. You've already seen plugins in action just by using
Genkit:
Expand Down
2 changes: 1 addition & 1 deletion docs-go/plugins/google-cloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Google Cloud telemetry and logging plugin

The Google Cloud plugin exports Firebase Genkit's telemetry and logging data to
The Google Cloud plugin exports Genkit's telemetry and logging data to
[Google Cloud's operation suite](https://cloud.google.com/products/operations).

Note: Logging is facilitated by the `slog` package
Expand Down
2 changes: 1 addition & 1 deletion docs-go/rag.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Retrieval-augmented generation (RAG)

Firebase Genkit provides abstractions that help you build retrieval-augmented generation
Genkit provides abstractions that help you build retrieval-augmented generation
(RAG) flows, as well as plugins that provide integrations with related tools.

## What is RAG?
Expand Down
2 changes: 1 addition & 1 deletion docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ necessary to ensure that the model is only accessing data it should, tool calls
are properly scoped to the user invoking the LLM, and the flow is being invoked
only by verified client applications.

Firebase Genkit provides mechanisms for managing authorization policies and
Genkit provides mechanisms for managing authorization policies and
contexts. Flows running on Firebase can use an auth policy callback (or helper).
Alternatively, Firebase also provides auth context into the flow where it can
do its own checks. For non-Functions flows, auth can be managed and set
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ and cloud-run links to, which links to express, next, and maybe cloud functions
-->
# Deploy flows to any Node.js platform

Firebase Genkit has built-in integrations that help you deploy your flows to
Genkit has built-in integrations that help you deploy your flows to
Cloud Functions for Firebase and Google Cloud Run, but you can also deploy your
flows to any platform that can serve an Express.js app, whether it’s a cloud
service or self-hosted.
Expand Down
4 changes: 2 additions & 2 deletions docs/devtools.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Firebase Genkit Developer Tools
# Genkit Developer Tools

Firebase Genkit provides two key developer tools:
Genkit provides two key developer tools:

- A Node.js CLI for command-line operations
- An optional local web app, called the Developer UI, that interfaces with your
Expand Down
2 changes: 1 addition & 1 deletion docs/evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Evaluation is a form of testing that helps you validate your LLM's responses and
ensure they meet your quality bar.

Firebase Genkit supports third-party evaluation tools through plugins, paired
Genkit supports third-party evaluation tools through plugins, paired
with powerful observability features that provide insight into the runtime state
of your LLM-powered applications. Genkit tooling helps you automatically extract
data including inputs, outputs, and information from intermediate steps to
Expand Down
8 changes: 4 additions & 4 deletions docs/observability/advanced-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ enableFirebaseTelemetry({

## Disable telemetry {: #disable-telemetry }

Firebase Genkit Monitoring leverages a combination of logging, tracing, and
Genkit Monitoring leverages a combination of logging, tracing, and
metrics to capture a holistic view of your Genkit interactions, however, you can
also disable each of these elements independently if needed.

Expand All @@ -106,7 +106,7 @@ enableFirebaseTelemetry({
```

With this option set, input and output attributes will be redacted
in the Firebase Genkit Monitoring trace viewer and will be missing
in the Genkit Monitoring trace viewer and will be missing
from Google Cloud logging.

### Disable metrics {: #disable-metrics }
Expand All @@ -122,7 +122,7 @@ enableFirebaseTelemetry({
```

With this option set, you will no longer see stability metrics in the
Firebase Genkit Monitoring dashboard and will be missing from Google Cloud
Genkit Monitoring dashboard and will be missing from Google Cloud
Metrics.

### Disable traces {: #disable-traces }
Expand All @@ -137,6 +137,6 @@ enableFirebaseTelemetry({
});
```

With this option set, you will no longer see traces in the Firebase Genkit
With this option set, you will no longer see traces in the Genkit
Monitoring feature page, have access to the trace viewer, or see traces
present in Google Cloud Tracing.
2 changes: 1 addition & 1 deletion docs/observability/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Click to learn more about how to [enable and disable APIs](https://support.googl

## User Authentication {: #user-authentication }

To export telemetry from your local development environment to Firebase Genkit
To export telemetry from your local development environment to Genkit
Monitoring, you will need to authenticate yourself with Google Cloud.

The easiest way to authenticate as yourself is using the gcloud CLI, which will
Expand Down
6 changes: 3 additions & 3 deletions docs/observability/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Get started with Genkit Monitoring {: #get-started }

This quickstart guide describes how to set up Firebase Genkit Monitoring for
This quickstart guide describes how to set up Genkit Monitoring for
your deployed Genkit features, so that you can collect and view real-time
telemetry data. With Firebase Genkit Monitoring, you get visibility into how
telemetry data. With Genkit Monitoring, you get visibility into how
your Genkit features are performing in production.

Key capabilities of Firebase Genkit Monitoring include:
Key capabilities of Genkit Monitoring include:

* Viewing quantitative metrics like Genkit feature latency, errors, and
token usage.
Expand Down
4 changes: 2 additions & 2 deletions docs/observability/telemetry-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Each generate metric contains the following dimensions:

All Genkit actions are automatically instrumented to provide detailed traces for
your AI features. Locally, traces are visible in the Developer UI. For deployed
apps enable Firebase Genkit Monitoring to get the same level of visibility.
apps enable Genkit Monitoring to get the same level of visibility.

The following sections describe what trace attributes you can expect based on
the Genkit action type for a particular span in the trace.
Expand Down Expand Up @@ -177,7 +177,7 @@ the whole trace versus an individual span.

## Logs {: #logs }

For deployed apps with Firebase Genkit Monitoring, logs are used to capture
For deployed apps with Genkit Monitoring, logs are used to capture
input, output, and configuration metadata that provides rich detail about
each step in your AI feature.

Expand Down
4 changes: 2 additions & 2 deletions docs/observability/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Genkit Monitoring: Troubleshooting {: #troubleshooting }

The following sections detail solutions to common issues that developers run
into when using Firebase Genkit Monitoring.
into when using Genkit Monitoring.

## I can't see traces or metrics in Firebase Genkit Monitoring {: #missing-metrics }
## I can't see traces or metrics in Genkit Monitoring {: #missing-metrics }

1. Ensure that the following APIs are enabled for your underlying Google Cloud
project:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugin-authoring-evaluator.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Writing a Genkit Evaluator

You can extend Firebase Genkit to support custom evaluation, using either
You can extend Genkit to support custom evaluation, using either
an LLM as a judge, or by programmatic (heuristic) evaluation.

## Evaluator definition
Expand Down
2 changes: 1 addition & 1 deletion docs/plugin-authoring.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Writing Genkit plugins

Firebase Genkit's capabilities are designed to be extended by plugins. Genkit plugins are configurable modules
Genkit's capabilities are designed to be extended by plugins. Genkit plugins are configurable modules
that can provide models, retrievers, indexers, trace stores, and more. You've already seen plugins in
action just by using Genkit:

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/firebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build intelligent and scalable AI applications. Key features include:
with vector embeddings.
- **Telemetry**: Export telemetry to
[Google's Cloud operations suite](https://cloud.google.com/products/operations)
that powers the Firebase Genkit Monitoring console.
that powers the Genkit Monitoring console.

## Installation

Expand Down Expand Up @@ -86,7 +86,7 @@ Application Default Credentials. To specify your credentials:
### Telemetry

The Firebase plugin provides a telemetry implementation for sending metrics,
traces, and logs to Firebase Genkit Monitoring.
traces, and logs to Genkit Monitoring.

To get started, visit the [Getting started guide](../observability/getting-started.md)
for installation and configuration instructions.
Expand Down
2 changes: 1 addition & 1 deletion docs/rag.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Retrieval-augmented generation (RAG)

Firebase Genkit provides abstractions that help you build retrieval-augmented
Genkit provides abstractions that help you build retrieval-augmented
generation (RAG) flows, as well as plugins that provide integrations with
related tools.

Expand Down
4 changes: 2 additions & 2 deletions genkit-tools/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Firebase Genkit CLI
# Genkit CLI

The package contains the CLI for Firebase Genkit, an open source framework with rich local tooling to help app developers build, test, deploy, and monitor AI-powered features for their apps with confidence. Genkit is built by Firebase, Google's app development platform that is trusted by millions of businesses around the world.
The package contains the CLI for Genkit, an open source framework with rich local tooling to help app developers build, test, deploy, and monitor AI-powered features for their apps with confidence. Genkit is built by Firebase, Google's app development platform that is trusted by millions of businesses around the world.

Review the [documentation](https://firebase.google.com/docs/genkit) for details and samples.

Expand Down
2 changes: 1 addition & 1 deletion genkit-tools/cli/src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const commands: Command[] = [
export async function startCLI(): Promise<void> {
program
.name('genkit')
.description('Firebase Genkit CLI')
.description('Genkit CLI')
.version(version)
.hook('preAction', async (_, actionCommand) => {
await notifyAnalyticsIfFirstRun();
Expand Down
4 changes: 2 additions & 2 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Firebase Genkit
# Genkit

This package is the Go version of Firebase Genkit, a framework for building
This package is the Go version of Genkit, a framework for building
AI-powered apps. See: https://firebase.google.com/docs/genkit-go
2 changes: 1 addition & 1 deletion js/plugins/firebase/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface FirebaseTelemetryOptions extends GcpTelemetryConfigOptions {
}

/**
* Enables telemetry export to Firebase Genkit Monitoring, backed by the
* Enables telemetry export to Genkit Monitoring, backed by the
* Google Cloud Observability suite.
*
* @param options configuration options
Expand Down
2 changes: 1 addition & 1 deletion js/plugins/google-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Google Cloud plugin is a utility plugin to export telemetry and logs to Cloud Observability. This functionality is exposed through the Firebase plugin for customer use.

Visit the [Getting started](https://firebase.google.com/docs/genkit/observability/getting-started) docs to set up Firebase Genkit Monitoring.
Visit the [Getting started](https://firebase.google.com/docs/genkit/observability/getting-started) docs to set up Genkit Monitoring.

The sources for this package are in the main [Genkit](https://github.com/firebase/genkit) repo. Please file issues and pull requests against that repo.

Expand Down
2 changes: 1 addition & 1 deletion js/testapps/evals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Please see the `src/eval-in-code.ts` file for an example on running evaluations

## Reference

For more details on using Genkit evaluations, please refer to the official [Firebase Genkit documentation](https://firebase.google.com/docs/genkit/evaluation).
For more details on using Genkit evaluations, please refer to the official [Genkit documentation](https://firebase.google.com/docs/genkit/evaluation).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-reranker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using the Vertex AI plugin with Genkit for reranking documents based on a query. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Firebase Genkit documentation](https://firebase.google.com/docs/genkit).
For more information, please refer to the official [Genkit documentation](https://firebase.google.com/docs/genkit).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-vector-search-bigquery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using Vertex AI plugins with Genkit for document indexing and retrieval. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Firebase Genkit documentation](https://firebase.google.com/docs/genkit).
For more information, please refer to the official [Genkit documentation](https://firebase.google.com/docs/genkit).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-vector-search-custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using Vertex AI plugins with Genkit for document indexing and retrieval. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Firebase Genkit documentation](https://firebase.google.com/docs/genkit).
For more information, please refer to the official [Genkit documentation](https://firebase.google.com/docs/genkit).
2 changes: 1 addition & 1 deletion js/testapps/vertexai-vector-search-firestore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ This project is licensed under the Apache License, Version 2.0. See the [LICENSE

This sample provides a basic demonstration of using Vertex AI plugins with Genkit for document indexing and retrieval. It can be extended and adapted to suit more complex use cases and integrations with other data sources and services.

For more information, please refer to the official [Firebase Genkit documentation](https://firebase.google.com/docs/genkit).
For more information, please refer to the official [Genkit documentation](https://firebase.google.com/docs/genkit).
2 changes: 1 addition & 1 deletion py/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Firebase Genkit Python SDK
# Genkit Python SDK

## Setup Instructions

Expand Down
4 changes: 2 additions & 2 deletions py/engdoc/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

!!! note

If you're a user of Firebase Genkit and landed here,
If you're a user of Genkit and landed here,
this is engineering documentation that someone contributing
to Genkit would use, not necessarily only use it.

For more information about how to get started with using
Firebase Genkit, please see: [User Guide](.)
Genkit, please see: [User Guide](.)

## Preparing your account

Expand Down
6 changes: 3 additions & 3 deletions py/engdoc/extending/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

!!! note

If you're a user of Firebase Genkit and landed here,
If you're a user of Genkit and landed here,
this is engineering documentation that someone contributing
to Genkit would use, not necessarily only use it.

For more information about how to get started with using
Firebase Genkit, please see: [User Guide](.)
Genkit, please see: [User Guide](.)

Firebase Genkit models a generative AI framework allowing application developers
Genkit models a generative AI framework allowing application developers
to work with abstractions to allow the use of pluggable implementations of the
various elements of generative AI. It has SDKs for JavaScript, Go, and Python.

Expand Down
4 changes: 2 additions & 2 deletions py/engdoc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

!!! note

If you're a user of Firebase Genkit and landed here,
If you're a user of Genkit and landed here,
this is engineering documentation that someone contributing
to Genkit would use, not necessarily only use it.

For more information about how to get started with using
Firebase Genkit, please see: [User Guide](.)
Genkit, please see: [User Guide](.)

## What is Genkit?

Expand Down
Loading
Loading