透過 Vertex AI for Firebase SDK 開始使用 Gemini API


本指南將說明如何使用 Vertex AI for 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 控制台中,前往「Build with Gemini」(使用 Gemini 建構) 頁面,然後按一下第二張資訊卡,啟動工作流程,協助您執行下列工作。如果您在控制台中看到 Vertex AI 的分頁,代表這些工作已完成。

  2. 繼續本指南的下一個步驟,將 SDK 新增至應用程式。

如果您尚未有 Firebase 專案和連結至 Firebase 的應用程式


步驟 2:新增 SDK

設定 Firebase 專案並將應用程式連結至 Firebase (請參閱上一步) 後,即可將 Vertex AI for Firebase SDK 新增至應用程式。

Android 版 Vertex AI for Firebase SDK (firebase-vertexai) 提供 Vertex AI Gemini API 的存取權。

模組 (應用程式層級) Gradle 設定檔 (例如 <project>/<app-module>/build.gradle.kts) 中,新增 Vertex AI for Firebase SDK for Android 的依附元件:

Kotlin+KTX

dependencies {
  // ... other androidx dependencies

  // add the dependency for the Vertex AI for Firebase SDK for Android
  implementation("com.google.firebase:firebase-vertexai:16.0.0-beta01")
}

Java

如果是 Java,您需要新增兩個程式庫。

dependencies {
  // ... other androidx dependencies

  // add the dependency for the Vertex AI for Firebase SDK for Android
  implementation("com.google.firebase:firebase-vertexai:16.0.0-beta01")

  // 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")
}

步驟 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-preview-0514")

Java

若為 Java,此 SDK 中的串流方法會從回應式串流程式庫傳回 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-preview-0514");

// 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-preview-0514")

// 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-preview-0514");
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 for Firebase 使用體驗提供意見回饋