AI Gateway は、API リクエストの設定、カスタマイズ、管理を助けるさまざまなヘッダーに対応しています。このページは、対応するヘッダーの完全な一覧と短い説明です。
| 用語 | 定義 |
|---|---|
| cf-aig-backoff | リクエストの リクエストリトライ のバックオフ種類をカスタマイズするヘッダーです。 |
| cf-aig-cache-key | cf-aig-cache-key-aig-cache-key を使うと、デフォルトのキャッシュキーを上書きし、任意のリソースのキャッシュ可否を正確に設定できます。 |
| cf-aig-cache-status | リクエストがキャッシュから提供されたかを示す キャッシュのステータス表示 です。 |
| cf-aig-cache-ttl | レスポンスのキャッシュ time-to-live を指定します。 |
| cf-aig-collect-log | cf-aig-collect-log ヘッダーを使うと、ゲートウェイのデフォルトのログ設定を迂回できます。 |
| cf-aig-custom-cost | ユーザー定義パラメーターを反映するよう、リクエストコストをカスタマイズ できます。 |
| cf-aig-dlp | DLP ポリシー がリクエストまたはレスポンスに一致したときに返されるレスポンスヘッダーです。実行したアクション（Flag または Block）、一致したポリシー ID、一致したプロファイル ID、検出エントリ ID を含む JSON を持ちます。 |
| cf-aig-event-id | cf-aig-event-id はイベントの一意の識別子で、システム内の特定イベントを追跡するために使います。 |
| cf-aig-log-id | cf-aig-log-id は、フィードバックを追加したい特定のログエントリの一意の識別子です。 |
| cf-aig-max-attempts | リクエストの リクエストリトライ の最大試行回数をカスタマイズするヘッダーです。 |
| cf-aig-metadata | カスタムメタデータ を使うと、リクエストにユーザー ID などの識別子をタグ付けし、リクエストの追跡と分析を改善できます。 |
| cf-aig-no-wholesale |
|
| cf-aig-request-timeout | リクエストタイムアウト を設定するヘッダーです（ミリ秒単位）。プロバイダーがこの時間内に応答しない場合、リクエストはエラーを返します。 |
| cf-aig-retry-delay | リクエストの リクエストリトライ のリトライ遅延をカスタマイズするヘッダーです。 |
| cf-aig-skip-cache | 特定リクエストのキャッシュを迂回する ヘッダーです。 |
| cf-aig-step | Cf-aig-step レスポンスヘッダーは、リクエストフローのどのステップがリクエストの処理に成功したかを識別します。追跡とデバッグに便利です。 |
| cf-cache-ttl | 非推奨: このヘッダーは |
| cf-skip-cache | 非推奨: このヘッダーは |
AI Gateway の設定は Request と Gateway の 2 レベルで行えます。同じ設定を複数の場所で設定できるため、次の優先順位で適用される値が決まります。
- リクエストレベルのヘッダー: 個々のリクエストに含まれるヘッダーは、ゲートウェイレベルの設定より優先されます。
- ゲートウェイレベルの設定: リクエストレベルでヘッダーが設定されていない場合のデフォルトです。
この優先順位により、最も具体的な設定が優先され、一貫した動作になります。細かい制御にはリクエストレベルのヘッダーを使い、一般的なデフォルトにはゲートウェイ設定を使います。
一部の制限的な設定は加算的です。cf-aig-no-wholesale ヘッダーは、サードパーティプロバイダーのリクエストにプロバイダー認証情報を要求できます。ただし、ゲートウェイ設定の Require provider credentials がオンのときは、それをオフにはできません。