レスポンス構造のハイライト
以下は、非ストリーミング Converse 関数と InvokeModel 関数によって返されるレスポンス構造の主要な要素を示しています。完全なレスポンス構造と、ストリーミング関数のリクエストとレスポンス構造の詳細については、API ドキュメントを参照してください。
{ "ResponseMetadata": { "RequestId":string, "HTTPStatusCode":int, "HTTPHeaders": { "date":string, "content-type": "application/json", "content-length":string, "connection": "keep-alive", "x-amzn-requestid":string}, "RetryAttempts": 0 }, "output": { "message": { "role": "assistant", "content": [ { // Optional "reasoningContent": { "reasoningText": { "text":string} } }, { // Optional "toolUse": { "toolUseId":string, "name":string, "input":object} }, { // Optional "text":string}, { // Optional "image": { "format": "png", "source": { "bytes": { "bytes":image// Binary array (Converse API) or Base64-encoded string (Invoke API) } } } } ] } }, "stopReason":string, // "end_turn" | "content_filtered" | "max_tokens" | "malformed_model_output" | "malformed_tool_use" | etc. "usage": { "inputTokens":int, "outputTokens":int, "totalTokens":int}, "metrics": { "latencyMs":int} }
以下は主要なレスポンス要素です。
-
output– (必須) モデルのレスポンスメッセージが含まれます。-
message– (必須) アシスタントのレスポンスメッセージです。-
content– (必須) 以下を含むことができる 1 つ以上のコンテンツブロックの配列です。-
reasoningContent– (オプション) 推論が有効になっている場合に返されます。推論テキストが含まれ、レスポンスでは常に[REDACTED]になります。 -
toolUse– (オプション) ツールが呼び出された場合に返されます。ツール使用 ID、名前、および入力引数が含まれます。 -
text– (オプション) モデルがテキストコンテンツで応答した場合に返されます。 -
image– (オプション、のみ) モデルが画像を生成した場合に返されます。生成される画像の形式は常に PNG になります。
-
-
-
-
stopReason– (必須) モデルが出力の生成を停止した理由を示す列挙値です。サポートされる値を次に示します。-
end_turn– ターンの論理的な終了に達しました。 -
max_tokens– 出力は、ユーザーが設定したmaxTokens制限、またはモデル独自の最大出力トークン制限に達しました。 -
content_filtered– モデルの出力が AWS の責任ある AI ポリシーに違反しました。 -
malformed_model_output– モデルが無効な出力を生成しました。 -
malformed_tool_use– モデルが無効なtoolUse出力を生成しました。 -
service_unavailable– 組み込みツールサービスの 1 つにアクセスできませんでした。 -
invalid_query– モデルが組み込みの Web Grounding ツールに送信したクエリが無効でした。 -
max_tool_invocations– 組み込みツールが呼び出されましたが、複数回再試行しても有効な結果が生成されなかったことを示します。
-
-
usage– (必須) 入力トークン、出力トークン、合計トークンを含むトークン使用状況情報です。 -
metrics– (必須) ミリ秒単位の合計推論レイテンシーを含むパフォーマンスメトリクスです。