通过 Vertex AI in Firebase SDK 开始使用 Gemini API


本指南介绍了如何开始使用适用于所选平台的 Vertex AI in Firebase SDK 直接从应用调用 Vertex AI Gemini API。

前提条件

本指南假定您熟悉如何使用 Android Studio 为 Android 开发应用。

  • 确保您的开发环境和 Android 应用满足以下要求：

    • Android Studio（最新版本）
    • 您的 Android 应用必须以 API 级别 21 或更高级别为目标平台。

  • （可选）查看示例应用。

    下载示例应用

    您可以快速试用 SDK，查看各种用例的完整实现，或者使用示例应用（如果您没有自己的 Android 应用）。如需使用示例应用，您需要将其关联到 Firebase 项目。

第 1 步：设置一个 Firebase 项目，并将您的应用关联到 Firebase

如果您已有 Firebase 项目和已与 Firebase 相关联的应用

  1. 在 Firebase 控制台中，前往使用 Gemini 构建页面。

  2. 点击 Vertex AI in Firebase 卡片可启动一个工作流，帮助您完成以下任务：

  3. 继续执行本指南中的下一步，将 SDK 添加到您的应用。

如果您还没有 Firebase 项目和与 Firebase 关联的应用


第 2 步：添加 SDK

设置好 Firebase 项目并将应用关联到 Firebase（请参阅上一步）后，您现在可以将 Vertex AI in Firebase SDK 添加到您的应用中。

Android 版 Vertex AI in Firebase SDK (firebase-vertexai) 提供对 Vertex AI Gemini API 的访问权限。

在您的模块（应用级）Gradle 文件（例如 <project>/<app-module>/build.gradle.kts）中，添加适用于 Android 的 Vertex AI in Firebase 库的依赖项。我们建议使用 Firebase Android BoM 来实现库版本控制。

Kotlin+KTX 

dependencies {
    // ... other androidx dependencies

    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependency for the Vertex AI in Firebase library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-vertexai")
}

Java

对于 Java，您需要添加两个额外的库。

dependencies {
    // ... other androidx dependencies

    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependency for the Vertex AI in Firebase library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-vertexai")

    // Required for one-shot operations (to use `ListenableFuture` from Guava Android)
    implementation("com.google.guava:guava:31.0.1-android")

    // Required for streaming operations (to use `Publisher` from Reactive Streams)
    implementation("org.reactivestreams:reactive-streams:1.0.4")
}

通过使用 Firebase Android BoM，可确保您的应用始终使用 Firebase Android 库的兼容版本。

第 3 步：初始化 Vertex AI 服务和生成式模型

您需要先初始化 Vertex AI 服务和生成式模型，然后才能进行任何 API 调用。

Kotlin+KTX

对于 Kotlin，此 SDK 中的方法是挂起函数，需要从协程作用域调用。 
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
val generativeModel = Firebase.vertexAI.generativeModel("gemini-1.5-flash")

Java

对于 Java，此 SDK 中的流式传输方法会从 Reactive Streams 库返回 Publisher 类型。 
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
GenerativeModel gm = FirebaseVertexAI.getInstance()
        .generativeModel("gemini-1.5-flash");

// Use the GenerativeModelFutures Java compatibility layer which offers
// support for ListenableFuture and Publisher APIs
GenerativeModelFutures model = GenerativeModelFutures.from(gm);

完成本入门指南后，了解如何选择适合您的应用场景和应用的 Gemini 模型和（可选）位置。

第 4 步：调用 Vertex AI Gemini API

现在，您已将应用关联到 Firebase、添加了 SDK 并初始化了 Vertex AI 服务和生成模型，接下来就可以调用 Vertex AI Gemini API 了。

您可以使用 generateContent() 根据纯文本提示请求生成文本：

Kotlin+KTX

对于 Kotlin，此 SDK 中的方法是挂起函数，需要从协程作用域调用。 
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
val generativeModel = Firebase.vertexAI.generativeModel("gemini-1.5-flash")

// Provide a prompt that contains text
val prompt = "Write a story about a magic backpack."

// To generate text output, call generateContent with the text input
val response = generativeModel.generateContent(prompt)
print(response.text)

Java

对于 Java，此 SDK 中的方法会返回 ListenableFuture。 
// Initialize the Vertex AI service and the generative model
// Specify a model that supports your use case
// Gemini 1.5 models are versatile and can be used with all API capabilities
GenerativeModel gm = FirebaseVertexAI.getInstance()
        .generativeModel("gemini-1.5-flash");
GenerativeModelFutures model = GenerativeModelFutures.from(gm);

// Provide a prompt that contains text
Content prompt = new Content.Builder()
    .addText("Write a story about a magic backpack.")
    .build();

// To generate text output, call generateContent with the text input
ListenableFuture<GenerateContentResponse> response = model.generateContent(prompt);
Futures.addCallback(response, new FutureCallback<GenerateContentResponse>() {
    @Override
    public void onSuccess(GenerateContentResponse result) {
        String resultText = result.getText();
        System.out.println(resultText);
    }

    @Override
    public void onFailure(Throwable t) {
        t.printStackTrace();
    }
}, executor);

您还可以执行以下操作

详细了解 Gemini 模型

了解适用于各种用例的模型及其配额和价格。

试用 Gemini API 的其他功能

了解如何控制内容生成

您还可以使用 Vertex AI Studio 对提示和模型配置进行实验。


就您使用 Vertex AI in Firebase 的体验提供反馈