响应结构要点 - Amazon Nova

响应结构要点

下面显示了非流式处理的 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：（必需）由一个或多个内容块组成的数组，其中可能包括：

        • reasoningContent：（可选）启用推理时返回的内容。包含推理文本，该文本将在响应中始终 [REDACTED]。

        • toolUse：（可选）调用工具时返回的内容。包含工具使用 ID、名称和输入参数。

        • text：（可选）模型使用文本内容响应时返回的内容。

        • image：（可选，仅限）模型生成图像时返回的内容。由 生成的图像将始终采用 PNG 格式。

  • stopReason：（必需）表示模型停止生成输出原因的枚举值。支持的值包括：

    • end_turn：已达到这一轮的逻辑终点。

    • max_tokens：输出已达用户设置的 maxTokens 限制或模型自己的最大输出词元限制。

    • content_filtered：模型的输出违反 AWS 负责任的人工智能政策。

    • malformed_model_output：模型生成了无效输出。

    • malformed_tool_use：模型生成了无效的 toolUse 输出。

    • service_unavailable：无法访问其中一项内置工具服务。

    • invalid_query：模型发送至内置 Web Grounding 工具的查询无效。

    • max_tool_invocations：表示已调用内置工具，但未产生有效的结果，即使多次重试后仍是如此。

  • usage：（必需）词元使用信息，包括输入词元、输出词元和总词元。

  • metrics：（必需）性能指标，包括以毫秒为单位的总推理延迟。