Verwenden der Converse-API

Das Feld text ist einer Zeichenfolge zugeordnet, die den Prompt angibt. Das text Feld wird zusammen mit anderen Feldern interpretiert, die in demselben Feld angegeben sind ContentBlock.

Das Folgende zeigt ein Message-Objekt mit einem content Array, das nur einen Text enthält ContentBlock:

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

Das image Feld ist einem zugeordnet ImageBlock. Übergeben Sie die base64-codierten Rohbytes für ein Bild im Feld bytes. Wenn Sie ein AWS SDK verwenden, müssen Sie die Bytes nicht in Base64 codieren.

Wenn Sie das Feld text ausschließen, beschreibt das Modell das Bild.

Im Folgenden wird ein Beispiel für ein Message-Objekt mit einem content Array gezeigt, das nur ein Bild enthält: ContentBlock

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

Sie können auch eine Amazon-S3-URI angeben, anstatt die Bytes direkt im Anforderungstext zu übergeben. Im Folgenden wird ein Message-Beispielobjekt mit einem Inhaltsarray gezeigt, das die Quelle enthält, die über einen Amazon-S3-URI übergeben wurde.

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

Das document Feld ist einem zugeordnet DocumentBlock. Wenn Sie einen DocumentBlock angeben, überprüfen Sie, ob Ihre Anfrage den folgenden Einschränkungen unterliegt:

Wenn Sie ein Dokument verwenden, können Sie das Tag citations aktivieren, das bei der Antwort auf den API-Aufruf dokumentspezifische Quellenangaben bereitstellt. Weitere Informationen finden Sie in der DocumentBlockAPI.

Im Folgenden wird ein Beispiel für ein Message-Objekt mit einem content Array gezeigt, das nur ein Dokument ContentBlockund den erforderlichen Begleittext enthält ContentBlock.

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

Sie können auch eine Amazon-S3-URI angeben, anstatt die Bytes direkt im Anforderungstext zu übergeben. Im Folgenden wird ein Message-Beispielobjekt mit einem Inhaltsarray gezeigt, das die Quelle enthält, die über einen Amazon-S3-URI übergeben wurde.

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

Das video Feld ist einem VideoBlockObjekt zugeordnet. Übergeben Sie die base64-codierten Rohbytes im Feld bytes. Wenn Sie das AWS SDK verwenden, müssen Sie die Bytes nicht in Base64 codieren.

Wenn Sie das Feld text nicht angeben, wird das Video durch das Modell beschrieben.

Im Folgenden wird ein Beispiel für ein Message-Objekt mit einem content Array gezeigt, das nur ein Video enthält. ContentBlock

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

Sie können auch eine Amazon-S3-URI angeben, anstatt die Bytes direkt im Anforderungstext zu übergeben. Im Folgenden wird ein Message-Beispielobjekt mit einem Inhaltsarray gezeigt, das die Quelle enthält, die über einen Amazon-S3-URI übergeben wurde.

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

Sie können Cache-Prüfpunkte als Block in einer Nachricht zusammen mit einem zugehörigen Prompt hinzufügen, indem Sie cachePoint-Felder verwenden, um das Prompt-Caching zu nutzen. Das Prompt-Caching ist ein Feature, mit dem Sie beginnen können, den Kontext von Konversationen zwischenzuspeichern, um Kosten und Latenz zu sparen. Weitere Informationen finden Sie unter Prompt-Caching für schnellere Modellinferenz.

Im Folgenden wird ein Beispiel für ein Message-Objekt mit einem content Array gezeigt, das ein Dokument ContentBlockund einen erforderlichen Begleittext enthält ContentBlock, sowie einen CachePoint, der sowohl den Dokument- als auch den Textinhalt zum Cache hinzufügt.

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

Das guardContent Feld ist einem GuardrailConverseContentBlockObjekt zugeordnet. Sie mit diesem Feld eine Eingabe als Ziel verwenden, die anhand des im Feld guardrailConfig definierten Integritätsschutzes ausgewertet werden soll. Wenn Sie dieses Feld nicht angeben, wertet der Integritätsschutz alle Nachrichten im Anforderungstext aus. Sie können die folgenden Inhaltstypen an einen GuardBlock übergeben:

Weitere Informationen zum Integritätsschutz finden Sie unter So erkennen und filtern Sie schädliche Inhalte mithilfe vom Integritätsschutz für Amazon Bedrock.

Das reasoningContent Feld ist einem zugeordnet ReasoningContentBlock. Dieser Block enthält Inhalte zu den Argumenten, die vom Modell zur Generierung der Antwort im zugehörigen ContentBlock verwendet wurden.

Im Folgenden wird ein Message-Objekt mit einem content-Array dargestellt, das nur einen ReasoningContentBlock und einen zugehörigen ContentBlock im Textformat enthält.

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

Der ReasoningContentBlock enthält die Argumentation, die zur Generierung des zugehörigen Inhalts im Feld reasoningText verwendet wurde, sowie alle Inhalte der Argumentation, die vom Modellanbieter aus Gründen der Vertraulichkeit und der Sicherheit im Feld redactedContent verschlüsselt wurden.

Innerhalb des Feldes reasoningText beschreiben die text-Felder die Argumentation. Das Feld signature ist ein Hash aller Nachrichten in der Konversation und schützt vor Manipulation der im Modell verwendeten Argumentation. Sie müssen die Signatur und alle vorherigen Nachrichten in nachfolgende Converse-Anfragen einbeziehen. Wenn eine der Nachrichten geändert wird, gibt die Antwort einen Fehler aus.

Enthält Informationen zu einem Tool, das für das Modell verwendet werden soll. Weitere Informationen finden Sie unter Verwenden eines Tools, um eine Amazon-Bedrock-Modellantwort zu vervollständigen.

Enthält Informationen über das Ergebnis, das mit dem Modell unter Verwendung eines Werkzeugs erzielt wurde. Weitere Informationen finden Sie unter Verwenden eines Tools, um eine Amazon-Bedrock-Modellantwort zu vervollständigen.