1.はじめに
プレビュー機能では、送信前のリクエスト内容を入力フォーム表示 と JSON表示 の2つの形式で確認できます。APIリクエスト内容の確認や、開発時の動作検証にご活用いただけます。
2.送信内容
・エージェント画面の「プレビュー」タブから、プレビュー画面を表示できます。
・初期画面では、「送信内容(Request)」の入力エリアが表示されます。
・「送信内容(Request)」エリアでは、「表示」と「JSON」を切り替えることができます。
(1)バージョン切り替え
「バージョン管理」画面から、プレビュー中のバージョンを選んで切り替えられます。バージョンを切り替えると、そのバージョンに紐づく仕様書・プロンプト・API仕様・ソースコード・プレビュー画面の内容が、まとめて表示に反映されます。公開中のバージョンは変わりません。公開中のバージョンに影響を与えずに、各バージョンの仕様やプレビュー画面を確認したい場合にご利用ください。
「バージョン管理」画面を開きます。プレビューできるバージョンを選択できます。
「切り替え」ボタンをクリックすると、バージョンの切り替えができます。
「切り替える」ボタンをクリックすると、選択したバージョンの切り替えができます。
(2)推論レベル
(3)フォーム表示
フォーム形式でエージェントAPIのパラメータを入力し、「送信」ボタンをクリックすることでリクエストを送信できます。
(4)JSON
JSON形式のデータを直接編集し、「送信」ボタンをクリックすることでリクエストを送信できます。
(5)その他
作成したエージェントの設定内容によっては、「表示」や「JSON」が非活性(選択不可)となる場合があります。
(6)エラーが表示された場合の対処方法
- 「エージェントを修正」ボタンをクリックします。
- エージェントを自動的に再生成します。
- 再度プレビューを実行します。
3.結果
送信後、APIのレスポンス結果が画面に表示されます。
また、推論結果をOffice文書形式でAPIレスポンスとして取得できます。
対応しているファイル形式は以下のとおりです。
- Word
- Excel
- PowerPoint
出力されたファイルは、プレビュー画面からダウンロードできます。
プレビュー結果からトークン使用量を確認できます。
4.注意事項
- JSONを直接編集した場合、フォーマットエラーがあると送信できない可能性があります。
- プレビューの実行は利用量としてカウントされ、料金が発生します。