Gemini API を使用して構造化された出力（JSON など）を生成する
コレクションでコンテンツを整理必要に応じて、コンテンツの保存と分類を行います。

Gemini API はデフォルトで非構造化テキストとしてレスポンスを返します。ただし、JSON などの構造化テキストが必要なユースケースもあります。たとえば、確立されたデータスキーマを必要とする他のダウンストリームタスクでレスポンスを使用している場合があります。

モデルの生成済み出力が常に特定のスキーマに準拠するようにするには、レスポンススキーマを定義します。これは、モデルのレスポンスのブループリントのように機能します。その後、後処理を減らしてモデルの出力からデータを直接抽出できます。

次に例を示します。

モデルのレスポンスが有効な JSON を生成し、指定されたスキーマに準拠していることを確認します。
たとえば、このモデルは、レシピ名、材料のリスト、手順が常に含まれるレシピの構造化エントリを生成できます。これにより、この情報をより簡単に解析し、アプリの UI に表示できます。
分類タスク中にモデルが応答できる方法を制限する。
たとえば、モデルが生成したラベル（good、positive、negative、bad など、ある程度のばらつきがある可能性がある）ではなく、特定のラベルセット（positive や negative などの特定の列挙型セットなど）でテキストにアノテーションを付けるようにモデルに指示できます。

このガイドでは、generateContent の呼び出しで responseSchema を指定して JSON 出力を生成する方法について説明します。テキストのみの入力に重点を置いていますが、Gemini は、画像、動画、音声を入力として含むマルチモーダルリクエストに対して構造化レスポンスを生成することもできます。

このページの下部には、列挙型の値を出力として生成する方法など、その他の例があります。構造化出力を生成する方法の追加例については、Google Cloud ドキュメントのスキーマとモデルレスポンスの例のリストをご覧ください。

Gemini API を操作するためのその他のオプション

必要に応じて、Gemini API の代替の「Google AI」バージョンをテストします。
Google AI Studio と Google AI クライアント SDK を使用して、（上限内で、利用可能な場合）無料アクセスを取得します。これらの SDK は、モバイルアプリとウェブアプリのプロトタイピングのみに使用してください。

Gemini API の仕組みに慣れたら、Vertex AI in Firebase SDK に移行（このドキュメント）します。Vertex AI in Firebase SDK には、Firebase App Check を使用した API の不正使用からの保護や、リクエスト内の大規模なメディアファイルのサポートなど、モバイルアプリとウェブアプリに重要な多くの追加機能が用意されています。

必要に応じて、Vertex AI Gemini API サーバーサイドを呼び出す（Python、Node.js、Go など）
サーバーサイド Vertex AI SDK、Firebase Genkit、または Firebase Extensions Gemini API を使用します。

始める前に

まだ行っていない場合は、スタートガイドを完了してください。Firebase プロジェクトの設定、アプリの Firebase への接続、SDK の追加、Vertex AI サービスの初期化、GenerativeModel インスタンスの作成方法が記載されています。

ステップ 1: レスポンススキーマを定義する

レスポンススキーマを定義して、モデルの出力の構造、フィールド名、各フィールドの想定されるデータ型を指定します。

モデルがレスポンスを生成するときは、プロンプトからフィールド名とコンテキストを使用します。意図が明確になるように、明確な構造、曖昧さのないフィールド名、必要に応じて説明を使用することをおすすめします。

レスポンススキーマに関する考慮事項

レスポンススキーマを作成する際は、次の点に注意してください。

レスポンススキーマのサイズは、入力トークン制限にカウントされます。
レスポンススキーマ機能は、次のレスポンス MIME タイプをサポートしています。
- application/json: レスポンススキーマで定義されている JSON を出力します（構造化出力要件に役立ちます）。
- text/x.enum: レスポンススキーマで定義されている列挙型の値を出力します（分類タスクに役立ちます）。
レスポンススキーマ機能は、次のスキーマフィールドをサポートしています。

enum
items
maxItems
nullable
properties
required

サポートされていないフィールドを使用した場合でも、モデルはリクエストを処理できますが、そのフィールドは無視されます。上記のリストは、OpenAPI 3.0 スキーマオブジェクトのサブセットです（Vertex AI スキーマリファレンスをご覧ください）。
デフォルトでは、Vertex AI in Firebase SDK では、optionalProperties 配列で省略可能として指定しない限り、すべてのフィールドが必須と見なされます。これらの省略可能なフィールドの場合、モデルはフィールドにデータを入力することも、フィールドをスキップすることもできます。

これは、Vertex AI Gemini API のデフォルトの動作とは逆です。

ステップ 2: レスポンススキーマを含むプロンプトを送信して JSON を生成する

次の例は、構造化 JSON 出力を生成する方法を示しています。

構造化出力を生成するには、モデルの初期化時に適切な responseMimeType（この例では application/json）と、モデルで使用する responseSchema を指定する必要があります。

responseSchema の使用は、すべての Gemini モデル（Gemini 1.0 モデルを除く）でサポートされています。

import FirebaseVertexAI

// Provide a JSON schema object using a standard format.
// Later, pass this schema object into `responseSchema` in the generation config.
let jsonSchema = Schema.object(
  properties: [
    "characters": Schema.array(
      items: .object(
        properties: [
          "name": .string(),
          "age": .integer(),
          "species": .string(),
          "accessory": .enumeration(values: ["hat", "belt", "shoes"]),
        ],
        optionalProperties: ["accessory"]
      )
    ),
  ]
)

// Initialize the Vertex AI service and the generative model.
let model = VertexAI.vertexAI().generativeModel(
  modelName: "gemini-2.0-flash",
  // In the generation config, set the `responseMimeType` to `application/json`
  // and pass the JSON schema object into `responseSchema`.
  generationConfig: GenerationConfig(
    responseMIMEType: "application/json",
    responseSchema: jsonSchema
  )
)

let prompt = "For use in a children's card game, generate 10 animal-based characters."

let response = try await model.generateContent(prompt)
print(response.text ?? "No text in response.")

ユースケースとアプリに適したモデルと、必要に応じてロケーションを選択する方法を学びます。

その他の例

構造化出力の使用方法と生成方法のその他の例については、Google Cloud ドキュメントのスキーマとモデルレスポンスの例をご覧ください。

列挙型の値を出力として生成する

次の例は、分類タスクにレスポンススキーマを使用する方法を示しています。モデルは、説明に基づいて映画のジャンルを特定するように求められます。出力は、指定されたレスポンススキーマで定義された値のリストからモデルが選択した書式なしテキストの列挙型値です。

この構造化分類タスクを実行するには、モデルの初期化時に適切な responseMimeType（この例では text/x.enum）と、モデルで使用する responseSchema を指定する必要があります。

import FirebaseVertexAI

// Provide an enum schema object using a standard format.
// Later, pass this schema object into `responseSchema` in the generation config.
let enumSchema = Schema.enumeration(values: ["drama", "comedy", "documentary"])

// Initialize the Vertex AI service and the generative model.
let model = VertexAI.vertexAI().generativeModel(
  modelName: "gemini-2.0-flash",
  // In the generation config, set the `responseMimeType` to `text/x.enum`
  // and pass the enum schema object into `responseSchema`.
  generationConfig: GenerationConfig(
    responseMIMEType: "text/x.enum",
    responseSchema: enumSchema
  )
)

let prompt = """
The film aims to educate and inform viewers about real-life subjects, events, or people.
It offers a factual record of a particular topic by combining interviews, historical footage,
and narration. The primary purpose of a film is to present information and provide insights
into various aspects of reality.
"""

let response = try await model.generateContent(prompt)
print(response.text ?? "No text in response.")

ユースケースとアプリに適したモデルと、必要に応じてロケーションを選択する方法を学びます。

コンテンツ生成を制御するためのその他のオプション

プロンプトの設計について学び、ニーズに固有の出力を生成するようにモデルに影響を与えましょう。
モデルパラメータを構成して、モデルがレスポンスを生成する方法を制御します。Gemini モデルの場合、これらのパラメータには、最大出力トークン、温度、topK、topP が含まれます。Imagen モデルの場合、アスペクト比、人物の生成、ウォーターマークなどがあります。
安全性設定を使用して、ヘイトスピーチや露骨な性的描写を含むコンテンツなど、有害と見なされる可能性のあるレスポンスを受け取る頻度を調整します。
システム指示を設定して、モデルの動作を制御します。この機能は、エンドユーザーからの詳細な手順を示すためにモデルが公開される前に追加する「プリアンブル」のようなものです。

Vertex AI in Firebase の使用感に関するフィードバックを送信する

Gemini API を使用して構造化された出力（JSON など）を生成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。