使用 Converse API

text 字段会映射到指定提示的字符串。该text字段与同一字段中指定的其他字段一起解释ContentBlock。

下面显示了一个 M essag e 对象，其content数组仅包含文本 ContentBlock：

{
    "role": "user",
    "content": [
        {
            "text": "string"
        }
    ]
}

该image字段映射到 ImageBlock. 为 bytes 字段中的图像传递以 base64 编码的原始字节。如果您使用AWS软件开发工具包，则无需在 base64 中对字节进行编码。

如果排除 text 字段，则模型描述图像。

下面显示了一个示例 Mess ag e 对象，其content数组仅包含图像 ContentBlock：

{
    "role": "user",
    "content": [
        {
            "image": {
                "format": "png",
                "source": {
                    "bytes": "image in bytes"
                }
            }
        }
    ]
}

您也可以指定 Amazon S3 URI，而不是直接在请求正文中传递字节。下面显示了一个示例 Message 对象，其内容数组包含通过 Amazon S3 URI 传递的源。

{
    "role": "user",
    "content": [
        {
            "image": {
                "format": "png",
                "source": {
                    "s3Location": {
                        "uri": "s3://amzn-s3-demo-bucket/myImage",
                        "bucketOwner": "111122223333"
                    }
                }
            }
        }
    ]
}

该document字段映射到 DocumentBlock. 如果包含 DocumentBlock，请检查您的请求是否符合以下限制：

使用文档时，您可以启用 citations 标签，该标签将在 API 调用的响应中提供特定于文档的引文。有关更多详细信息，请参阅 DocumentBlockAPI。

下面显示了一个示例 Mess ag e 对象，其content数组仅包含文档ContentBlock和必需的随附文本ContentBlock。

{
    "role": "user",
    "content": [
        {
            "text": "string"
        },
        {
            "document": {
                "format": "pdf",
                "name": "MyDocument",
                "source": {
                    "bytes": "document in bytes"
                }
            }
        }
    ]
}

您也可以指定 Amazon S3 URI，而不是直接在请求正文中传递字节。下面显示了一个示例 Message 对象，其内容数组包含通过 Amazon S3 URI 传递的源。

{
    "role": "user",
    "content": [
        {
            "text": "string"
        },
        {
            "document": {
                "format": "pdf",
                "name": "MyDocument",
                "source": {
                    "s3Location": {
                      "uri": "s3://amzn-s3-demo-bucket/myDocument",
                      "bucketOwner": "111122223333"
                    }
                }
            }
        }
    ]
}

该video字段映射到一个VideoBlock对象。在 bytes 字段中，传递以 base64 编码的原始字节。如果您使用AWS软件开发工具包，则无需在 base64 中对字节进行编码。

如果未包含 text 字段，则模型将描述视频。

下面显示了一个示例 Mess ag e 对象，其content数组仅包含视频ContentBlock。

{
    "role": "user",
    "content": [
        {
            "video": {
                "format": "mp4",
                "source": {
                    "bytes": "video in bytes"
                }
            }
        }
    ]
}

您也可以指定 Amazon S3 URI，而不是直接在请求正文中传递字节。下面显示了一个示例 Message 对象，其内容数组包含通过 Amazon S3 URI 传递的源。

{
    "role": "user",
    "content": [
        {
            "video": {
                "format": "mp4",
                "source": {
                    "s3Location": {
                        "uri": "s3://amzn-s3-demo-bucket/myVideo",
                        "bucketOwner": "111122223333"
                    }
                }
            }
        }
    ]
}

您可以使用 cachePoint 字段来利用提示缓存，将缓存检查点作为单元，与随附的提示一起添加到消息中。提示缓存是一项功能，让您可以开始缓存对话上下文，从而节省成本和降低延迟。有关更多信息，请参阅 用于加快模型推理速度的提示缓存。

下面显示了一个示例 Mess ag e 对象，该对象包含一个包含文档ContentBlock和必需的随附文本的content数组 ContentBlock，以及一个将文档和文本内容都添加到缓存中的 CachePoint。

{
    "role": "user",
    "content": [
        {
            "text": "string"
        },
        {
            "document": {
                "format": "pdf",
                "name": "string",
                "source": {
                    "bytes": "document in bytes"
                }
            }
        },
        {
            "cachePoint": {
                "type": "default"
            }
        }
    ]
}

该guardContent字段映射到一个GuardrailConverseContentBlock对象。您可以使用此字段来定位要由 guardrailConfig 字段中定义的护栏进行评估的输入。如果您未指定此字段，则护栏将评估请求正文中的所有消息。您可以在 GuardBlock 中传递以下内容类型：

有关使用护栏的更多信息，请参阅使用 Amazon Bedrock 护栏检测和筛选掉有害内容。

该reasoningContent字段映射到 a ReasoningContentBlock. 此单元包含关于推理的内容，此推理由生成随附 ContentBlock 中的响应的模型执行。

下面显示了一个 Message 对象，其 content 数组仅包含 ReasoningContentBlock 和一个随附的文本 ContentBlock。

{
    "role": "user",
    "content": [
        {
            "text": "string"
        },
        {
            "reasoningContent": {
                "reasoningText": {
                    "text": "string",
                    "signature": "string"
                }
                "redactedContent": "base64-encoded binary data object"
            }
        }
    ]
}

ReasoningContentBlock 包含用于生成 reasoningText 字段中随附内容的推理，以及模型提供商出于信任和安全原因，在 redactedContent 字段中加密的推理中的任何内容。

在 reasoningText 字段中，text 字段描述了推理。signature 字段是对话中所有消息的哈希值，用于防止篡改模型使用的推理。您必须在后续 Converse 请求中包含签名和之前的所有消息。如果任何消息发生更改，响应就会引发错误。

包含有关模型要使用的工具的信息。有关更多信息，请参阅 使用工具完成 Amazon Bedrock 模型响应。

包含有关模型使用工具得出的结果的信息。有关更多信息，请参阅 使用工具完成 Amazon Bedrock 模型响应。