開発ガイド

API の疎通を確認できたら、やりたいことに合わせて該当するガイドをご覧ください。各ガイドには実行可能なサンプルを掲載しています。対応するプロトコルは各ページの記載を参照してください。

基本機能

モデルの「応答の仕方」を制御します。逐次出力、関数の呼び出し、固定フォーマットでの返却、画像の理解などです。

やりたいこと	ガイド	ポイント
生成完了を待たずに応答を逐次表示したい	ストリーミング	SSE によるプッシュ。切断時の再接続やストリーミング中の関数呼び出しも解説
モデルに自分の関数や外部 API を呼び出させたい	ファンクションコーリング	`tools` を定義。並列呼び出しと `tool_choice` に対応
出力を JSON に固定したい	構造化出力	JSON Mode と JSON Schema による制約
モデルに画像を読み取らせたい	ビジョン	画像の URL または Base64。複数画像の比較も可能

同じリクエストをより低コストで実行し、障害時にも処理を止めないための機能です。

やりたいこと	ガイド	ポイント
長いプロンプトを繰り返し送信するので、コストを下げたい	プロンプトキャッシュ	繰り返し使うプレフィックスをキャッシュし、トークン費用とレイテンシを削減
Gemini で大量のコンテキストを複数のリクエストで再利用したい	Gemini 明示的キャッシュ	cachedContents を明示的に作成・参照し、確実にヒットさせる
リクエストを処理するプロバイダーを指定したい	プロバイダールーティング	デフォルトは自動ルーティング。必要に応じて `provider.type` で指定
メインモデルでエラーが起きたら代替モデルに自動で切り替えたい	フォールバック	`provider.fallback` で最大 3 つの代替モデルを指定

リクエストが失敗した、レート制限にかかった、またはブロックされた場合は、まずこちらをご確認ください。

状況	ガイド	ポイント
エラーの対処方法やリトライの要否を知りたい	エラーハンドリング	ステータスコード、エラー形式、指数バックオフとタイムアウト設定
429 Too Many Requests	レート制限	デフォルトは 100 RPM でチーム単位の合算。レスポンスヘッダーから待機時間を判断
リクエストがコンテンツセーフティによりブロック・一時停止された	コンテンツセーフティ	発動条件、停止期間、復旧方法

既存の SDK やフレームワークでコードから接続します。変更するのは API アドレスと Key だけです。