Beta: Firebase Genkit is in Beta, which means that it is not subject to any SLA or deprecation policy and could change in backwards-incompatible ways. Throughout the Beta period, Firebase Genkit and its documentation will be updated and improved.

此页面由 Cloud Translation API 翻译。

将 Genkit 与 Firebase Cloud Functions 搭配使用

Firebase Genkit 包含一个插件，可帮助您将流部署到 Firebase Cloud Functions。本页面示例将引导您完成将默认示例流部署到 Firebase 的过程。

将流部署为 Cloud Functions 函数

安装所需的工具：
1. 确保您使用的是 Node.js 20 或更高版本（运行 node --version 进行检查）。
2. 安装 Firebase CLI。
使用 Firebase 控制台创建一个新的 Firebase 项目，或者选择一个现有的项目。

将项目升级到部署 Cloud Functions 所需的 Blaze 方案。

使用 Firebase CLI 登录：

firebase login
firebase login --reauth # alternative, if necessary
firebase login --no-localhost # if running in a remote shell

创建新的项目目录：

export PROJECT_ROOT=~/tmp/genkit-firebase-project1
mkdir -p $PROJECT_ROOT

使用文件夹中的 Genkit 初始化 Firebase 项目：
```
cd $PROJECT_ROOT
firebase init genkit
```
- 选择您之前创建的项目。
- 选择要使用的模型提供商。
接受其余提示的默认值。genkit 工具将创建一些示例源文件，以帮助您开始开发自己的 AI 流程。不过，对于本教程的其余部分，您只需部署示例流程即可。
将 API 凭据提供给您的 Cloud Functions 函数。根据您选择的模型提供程序，执行以下某项操作：
Gemini (Google AI)
1. 确保 Google AI 在您所在的地区可用。
2. 使用 Google AI Studio 为 Gemini API 生成 API 密钥。
3. 将 GOOGLE_GENAI_API_KEY 环境变量设置为您的密钥：
```
export GOOGLE_GENAI_API_KEY=<your API key>
```
4. 修改 src/index.ts，并在现有导入代码后添加以下代码：
```
import {defineSecret} from "firebase-functions/params";
defineSecret("GOOGLE_GENAI_API_KEY");
```
现在，当您部署此函数时，您的 API 密钥将存储在 Cloud Secret Manager 中，并可通过 Cloud Functions 环境获取。
Gemini (Vertex AI)
1. 在 Cloud 控制台中，为您的 Firebase 项目启用 Vertex AI API。
2. 在 IAM 页面上，确保已向默认计算服务帐号授予 Vertex AI User 角色。
3. 可选：如果要在本地运行流（如下一步所示），请设置一些额外的环境变量，并使用 gcloud 工具设置应用默认凭据：
```
export GCLOUD_PROJECT=<your project ID>
export GCLOUD_LOCATION=us-central1
gcloud auth application-default login
```
您需要为本教程设置的唯一密钥是为模型提供程序设置，但一般而言，您必须为流使用的每项服务执行类似的操作。
如果您要从 Web 应用访问流（您将在下一部分中执行此操作），请在 httpsOptions 参数中设置 CORS 政策：
```
export const menuSuggestionFlow = onFlow(
  {
    name: "menuSuggestionFlow",
    // ...
    httpsOptions: {cors: true}, // Add this line.
  },
  async (subject) => {
    // ...
  }
);
```
您可能需要针对正式版应用制定更为严格的政策，但本教程中将会如此。
可选：在开发者界面中尝试按照您的流程操作：
1. 启动界面：
```
cd $PROJECT_ROOT/functions
genkit start
```
2. 在开发者界面 (http://localhost:4000/) 中，运行流程：
  1. 点击 menuSuggestionFlow。
  2. 在输入 JSON 标签页上，为模型提供主题：
```
"AI app developers"
```
  3. 在 Auth JSON 标签页上，提供一个模拟的 auth 对象：
```
{
  "uid": 0,
  "email_verified": true
}
```
  4. 点击运行。
如果到目前为止一切正常，您就可以部署该数据流：
```
cd $PROJECT_ROOT
firebase deploy --only functions
```

现在，您已将该流部署为 Cloud Functions 函数！但是，由于该流的授权政策，您将无法使用 curl 或类似方法访问已部署的端点。继续阅读下一部分，了解如何安全地访问该流程。

尝试部署的流程

您部署的每个流程都必须设置授权政策，这一点至关重要。如果没有 Google Cloud 服务，任何人都可以调用可能昂贵的生成式 AI 流程。

默认示例流程的授权政策如下所示：

firebaseAuth((user) => {
  if (!user.email_verified) {
    throw new Error('Verified email required to run flow');
  }
});

此政策使用 firebaseAuth() 帮助程序，仅允许您的应用中已注册电子邮件地址的用户进行访问。在客户端，您需要将 Authorization: Bearer 标头设置为符合政策的 Firebase ID 令牌。Cloud Functions 客户端 SDK 提供了 Callable 函数来自动执行此操作。

如需试用您的流端点，您可以部署以下极简示例 Web 应用：

在 Firebase 控制台的项目设置部分中，添加新的 Web 应用，并选择同时设置 Hosting 的选项。
在 Firebase 控制台的 Authentication 部分中，启用 Google 提供方，本例中将使用该提供方。
在项目目录中，设置 Firebase Hosting 以部署示例应用：
```
cd $PROJECT_ROOT
firebase init hosting
```
接受所有提示的默认值。

将 public/index.html 替换为以下内容：

<!doctype html>
<html>
  <head>
    <title>Genkit demo</title>
  </head>
  <body>
    <div id="signin" hidden>
      <button id="signinBtn">Sign in with Google</button>
    </div>
    <div id="callGenkit" hidden>
      Subject: <input type="text" id="subject" />
      <button id="suggestMenuItem">Suggest a menu theme</button>
      <p id="menuItem"></p>
    </div>
    <script type="module">
      import { initializeApp } from 'https://www.gstatic.com/firebasejs/10.10.0/firebase-app.js';
      import {
        getAuth,
        onAuthStateChanged,
        GoogleAuthProvider,
        signInWithPopup,
      } from 'https://www.gstatic.com/firebasejs/10.10.0/firebase-auth.js';
      import {
        getFunctions,
        httpsCallable,
      } from 'https://www.gstatic.com/firebasejs/10.10.0/firebase-functions.js';

      const firebaseConfig = await fetch('/__/firebase/init.json');
      initializeApp(await firebaseConfig.json());

      async function generateMenuItem() {
        const menuSuggestionFlow = httpsCallable(
          getFunctions(),
          'menuSuggestionFlow'
        );
        const subject = document.querySelector('#subject').value;
        const response = await menuSuggestionFlow(subject);
        document.querySelector('#menuItem').innerText = response.data;
      }

      function signIn() {
        signInWithPopup(getAuth(), new GoogleAuthProvider());
      }

      document
        .querySelector('#signinBtn')
        .addEventListener('click', signIn);
      document
        .querySelector('#suggestMenuItem')
        .addEventListener('click', generateMenuItem);

      const signinEl = document.querySelector('#signin');
      const genkitEl = document.querySelector('#callGenkit');

      onAuthStateChanged(getAuth(), (user) => {
        if (!user) {
          signinEl.hidden = false;
          genkitEl.hidden = true;
        } else {
          signinEl.hidden = true;
          genkitEl.hidden = false;
        }
      });
    </script>
  </body>
</html>

部署 Web 应用和 Cloud Functions 函数：
```
cd $PROJECT_ROOT
firebase deploy
```

通过访问 deploy 命令输出的网址打开 Web 应用。该应用要求您使用 Google 帐号登录，然后您才能发起端点请求。

使用 Firebase Local Emulator Suite 进行开发

Firebase 提供了一套用于本地开发的模拟器，您可以将其与 Genkit 搭配使用。

如需将 Genkit 与 Firebase Emulator Suite 搭配使用，请按如下方式启动 Firebase 模拟器：

GENKIT_ENV=dev firebase emulators:start --inspect-functions

这将在模拟器中运行您的代码，并在开发模式下运行 Genkit 框架，这将启动和公开 Genkit 反射 API（而不是开发界面）。

然后，使用 --attach 选项启动 Genkit Dev UI，将其连接到在 Firebase 模拟器中运行的代码：

genkit start --attach http://localhost:3100 --port 4001

如需在开发界面中查看来自 Firestore 的跟踪记录，您可以导航到“检查”标签页，然后切换“开发/生产”开关。切换为“prod”时，它将从 Firestore 加载轨迹。

将 Genkit 与 Firebase Cloud Functions 搭配使用

将流部署为 Cloud Functions 函数

Gemini (Google AI)

Gemini (Vertex AI)

尝试部署的流程

使用 Firebase Local Emulator Suite 进行开发