概要
API の使用状況は、次の 2 つの方法で確認できます。
分析 > 使用状況で、現在および過去の集計期間の API アクティビティを確認します。
API レスポンスに含まれる使用状況の情報を読み取り、個々のリクエストを確認します。
Playground は、アプリケーションと同じ API 呼び出しを使用します。そこで使われるトークンも、アカウントの API 使用量に加算され、同じ利用ルールと料金が適用されます。
ダッシュボードへのアクセス
使用状況ダッシュボードにアクセスするには、組織の所有者であるか、使用状況ダッシュボードの権限が必要です。
ダッシュボードでの使用状況の確認
API プラットフォームで分析を開き、使用状況を選択すると、現在のプロジェクトを確認できます。組織全体のレポートを確認するには、組織の分析を選択します。確認したい集計期間を選択してください。プロジェクトの分析と組織の分析を切り替えた後は、期間をもう一度確認してください。
ダッシュボードのデータは UTC で表示されます。ダッシュボードのアクティビティとアプリケーションログを比較する際は、このタイムゾーンに注意してください。
直近の使用状況がダッシュボードに表示されるまで、時間がかかる場合があります。直近のアクティビティが表示されない場合は、時間をおいて再度確認してください。
使用状況の絞り込み
プロジェクトの分析では、選択したプロジェクトの使用状況のみが対象になります。組織の分析では、プロジェクトで確認したいプロジェクトを選択します。すべてのプロジェクトには、組織内の全プロジェクトが含まれます。ただし、ほかに選択しているフィルターがある場合は、その条件が適用されます。
フィルターで、API ソース、API キー、モデル、ユーザー、処理ティアによって使用状況を絞り込めます。API ソースでは、すべての API ソース、Agents API、Direct APIを選択できます。
選択を個別に解除するか、フィルターをクリアを選択してフィルターパネルをリセットします。フィルターをクリアしても、プロジェクトの分析と組織の分析は切り替わりません。
使用状況グラフのフィルターを使うと、バッチで絞り込めます。グラフのフィルターをリセットを選択すると、そのグラフのフィルターがリセットされます。
選択したフィルターに対応していない機能では、値を表示できない場合があります。値が表示されないことは、使用量がゼロであることを意味しません。
フィルターに権限エラーが表示される場合、その選択肢へのアクセス権限がない可能性があります。これは、使用状況が記録されていないことを意味するものではありません。
個々のユーザーの使用状況の確認
確認したいプロジェクトまたは組織の分析ビューで、使用状況を開きます。API 機能の表で、Responses と Chat Completionsの表示を選択します。
フィルターでユーザーを選択し、対象のユーザーを選択します。結果はすぐに更新されます。
そのユーザーのグラフと表を確認します。
複数の機能にわたるユーザーの使用状況を確認するには、使用状況の概要でユーザーフィルターを適用します。ユーザーどうしを比較するには、そのフィルターをクリアし、表のユーザータブを選択します。
日・時間・分単位のトークン数の表示
使用状況で時間間隔を設定できる場合、1 日または1 時間を選択すると、日単位または時間単位のトークン数を表示できます。1 分を選択すると、1 分あたりのトークン数(TPM)を確認できます。自動を選択すると、集計期間に応じた時間間隔がダッシュボードで自動的に選択されます。これらの時間間隔は、請求データではなく使用状況データに適用されます。
1 分が無効になっている場合は、集計期間を短くするか、選択してズームを使ってグラフ上をドラッグし、範囲を絞り込んでください。その後、1 分を選択します。Esc を押すと、ズーム範囲の選択をキャンセルできます。別の集計期間に変更するには、分析ツールバーで現在の日付範囲を選択します。
使用状況のグラフと表の確認
指標で、同時に表示するデータ系列を 1 つ以上選択します。入力トークン、未キャッシュ入力トークン、キャッシュ済み入力トークン、キャッシュ書き込み入力トークン、入力音声トークン、出力トークン、出力音声トークンなどを選択できます。利用できる指標は機能によって異なります。各系列は凡例で確認できます。
グループ化を使うと、プロジェクト、ユーザー、モデルなど、利用可能なカテゴリー別に使用状況を整理できます。フィルターは集計対象の使用状況を指定し、グループ化はその表示方法を指定します。折れ線グラフと棒グラフを切り替えて、傾向を確認したりカテゴリーを比較したりできます。
使用状況の表のタブで、表示可能な内訳を確認します。表には、リクエスト数、入出力トークン数、機能固有の単位など、各行に対応する指標が表示されます。
API 機能で、確認したい機能の表示を選択すると、詳細なグラフと内訳が開きます。Responses と Chat Completionsには、トークンとリクエストの個別のグラフ、およびモデルリクエストの指標があります。内訳のタブには、API 機能タブを除き、概要と同じ集計軸が使われます。パンくずリストの使用状況を選択すると、概要に戻ります。
グループ化の項目を選択すると、一部のカテゴリーがグラフ上でその他にまとめられることがあります。グラフの凡例にその他が表示されている場合は、そのラベルを選択すると、含まれるカテゴリーとそれぞれの使用量を確認できます。
ダッシュボードを比較を選択すると、同じ集計期間の使用状況と別のダッシュボードを並べて表示できます。左のダッシュボードと右のダッシュボードで表示内容を選択します。選択した時間間隔が比較するダッシュボードの組み合わせで利用できない場合、表示は自動に切り替わります。比較を終了を選択すると、ダッシュボードに戻ります。
心当たりのない使用状況の調査
使用状況に、アプリケーションログ内のリクエストと照合できないアクティビティが表示される場合は、次の点を確認してください。
組織、対象プロジェクト、集計期間を確認します。ダッシュボードのタイムスタンプとアプリケーションログを比較する際は、UTC を使用します。
該当するプロジェクトのビューを開くか、組織の分析のプロジェクトでそのプロジェクトを選択します。次に、フィルターで API キーとモデルを指定して使用状況を絞り込み、集計期間を短くします。
同じ期間、プロジェクト、API キーのログとアクティビティを比較します。そのキーを使用しているすべてのアプリケーションや連携機能が、ログに含まれているか確認します。
複数のアプリケーションや連携機能で同じプロジェクトや API キーを共有している場合、合計値だけではリクエストの送信元を特定できないことがあります。UTC 基準で同じ期間にそろえ、ダッシュボードと各アプリケーションの記録を比較します。
それでも使用状況の原因を特定できない場合は、該当する期間(UTC)、組織 ID とプロジェクト ID、API キーの識別子、関連するスクリーンショットやログを添えて、OpenAI サポートにお問い合わせください。リクエスト ID がある場合は、それも含めてください。秘密の API キーは含めないでください。
使用状況データのエクスポート
使用状況をエクスポートするには、分析ツールバーの CSV をエクスポートアイコンを選択し、アクティビティデータを選択します。
API 機能と、グループ化の集計軸を 1 つ以上選択します。
API ソース、プロジェクト、ユーザー、API キー、モデルを確認します。プロジェクトと API ソースには、分析での選択内容があらかじめ設定されています。それ以外のエクスポート用フィルターは、ダイアログで選択してください。
ファイル形式、開始時刻、終了時刻、時間間隔を選択してから、ダウンロードを選択します。指定した日付は、UTC 基準でその日の全時間帯を含みます。
アクティビティデータとコストデータは、暦上の 1 年前の 00:00 UTC から今日までの分を表示・エクスポートできます。それ以前のデータについては、OpenAI サポートにお問い合わせください。日次データは、31 日単位のファイルに分けてエクスポートされます。
月次請求書との照合と明細のエクスポートについては、月次使用状況の詳細のエクスポートをご覧ください。
アクティビティのエクスポートにマイナス値の行が含まれる場合は、単位、グループ、日付が同じ行どうしを比較してください。請求金額はコストデータで確認してください。アクティビティにマイナス値の行があるだけでは、請求額から差し引かれたとは判断できません。
支出の確認
分析を開いて支出を選択すると、現在のプロジェクトの費用を確認できます。組織全体の費用を確認するには、組織の分析を選択してから支出を選択します。
費用と使用状況を比較する前に、現在の日付範囲とフィルターを確認してください。使用状況と支出では、利用できるフィルターが異なります。一方のダッシュボードで使えるフィルターが、もう一方には適用できない場合があります。
API ソース、API キー、モデル、明細項目で支出を絞り込めます。組織の分析では、プロジェクトで確認したいプロジェクトを対象に含めます。表の明細項目、API キー、ユーザー、プロジェクト、モデルの各タブで、表示可能な内訳を確認できます。
支出上限の値が表示されない場合でも、上限がゼロであることや、新しい上限が適用されたことを意味するわけではありません。アクセス権限、上限の未設定、リクエストの失敗などにより、ダッシュボードに値が表示されない場合があります。
サービスの稼働状況の確認
組織がサービスの稼働状況を利用できる場合は、分析でそのダッシュボードを開き、API のパフォーマンスを確認できます。利用条件と指標の定義については、API エラーとレイテンシのトラブルシューティングをご覧ください。
付与されたクレジットの確認
付与されたクレジットの詳細は、組織の請求ページで確認できます。
クレジットの付与情報と API 使用状況では、確認できる内容が異なります。前者には組織に紐づくクレジットが、後者には組織の API アクティビティが表示されます。
スケールティアの使用量と費用の確認
組織でスケールティアが有効になっており、必要なアクセス権がある場合は、スケールティアの使用状況ページを開いて詳細な使用状況を確認できます。
スケールティアのバンドル費用は、個々のプロジェクトではなく組織に計上されます。
使用量がゼロを超えているのにプロジェクトの支出がゼロの場合
モデルの使用量がスケールティアの割り当て枠でカバーされているか確認してください。そのモデルの使用量がすべてスケールティアの TPM 割り当て枠内に収まっている場合、プロジェクトには使用状況が表示されても、モデルの追加費用は発生しないことがあります。
スケールティアのサブスクリプション費用は、引き続き組織レベルで計上されます。個々のプロジェクトの支出だけで判断せず、組織全体の支出を確認してください。
複数の組織の確認
使用状況ダッシュボードでは、複数の組織のコストデータや使用状況データは合算されません。サブ組織を含め、各組織は個別に扱われます。
サブ組織を表示するには、組織セレクターでそのサブ組織を選択します。
集約したレポートが必要な場合は、サブ組織を分ける代わりに 1 つの組織内でプロジェクトを使うことを検討するか、Usage API を使って独自の分析を行ってください。
API レスポンスでのトークン使用量の確認
トークン使用量のフィールド名は、エンドポイントによって異なります。
| トークン数 | Chat Completions | Responses |
|---|---|---|
| 入力トークン | usage.prompt_tokens | usage.input_tokens |
| 出力トークン | usage.completion_tokens | usage.output_tokens |
| 合計トークン | usage.total_tokens | usage.total_tokens |
Chat Completions のレスポンスには、トークン使用量の情報が含まれる場合があります。以下に例を示します。
{
"usage": {
"prompt_tokens": 13,
"completion_tokens": 7,
"total_tokens": 20
}
}エンドポイントやモデルによっては、使用量の詳細にキャッシュ済み入力のトークン数や推論トークン数も含まれます。これらの情報は、表示される応答の長さだけではトークンの総使用量がわからない理由を理解するのに役立ちます。
トークンの各カテゴリについては、トークンの理解とカウント方法をご覧ください。
トークン使用量を報告する文字起こしのレスポンスでは、音声とテキストの入力トークンはすでに input_tokens に含まれています。これらの内訳を入力トークンの合計に再度加算しないでください。output_tokens は別途比較してください。
Chat Completions のストリーミングでの使用量の取得
Chat Completions のストリーミングリクエストには、次の設定を含めます。
{
"stream": true,
"stream_options": {
"include_usage": true
}
}include_usage を有効にすると、data: [DONE] の前にチャンクが追加され、リクエスト全体の使用量が含まれます。このチャンクの choices 配列は空です。他のチャンクでは、usage の値は null です。
ストリームが中断されると、使用量を含む最後のチャンクを受信できない場合があります。最後のチャンクを受信できなかったからといって、そのリクエストでトークンが使用されなかったとは限りません。
この設定は Chat Completions 専用です。詳細は、Chat Completions API リファレンスをご覧ください。
