Verwenden der Converse-API

Das text Feld ist einer Zeichenfolge zugeordnet, die die Eingabeaufforderung 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 in Base64 kodierten Rohbytes für ein Bild im bytes Feld. Wenn Sie ein AWS SDK verwenden, müssen Sie die Bytes nicht in Base64 codieren.

Wenn Sie das text Feld 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 S3-URI angeben, anstatt die Bytes direkt im Anforderungstext zu übergeben. Das Folgende zeigt ein Message Beispielobjekt mit einem Inhaltsarray, das die Quelle enthält, die über einen Amazon S3 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 eine angebenDocumentBlock, überprüfen Sie, ob Ihre Anfrage den folgenden Einschränkungen entspricht:

Wenn Sie ein Dokument verwenden, können Sie das citations Tag aktivieren, das bei der Antwort auf den API-Aufruf dokumentspezifische Zitate 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 S3-URI angeben, anstatt die Bytes direkt im Anforderungstext zu übergeben. Das Folgende zeigt ein Message Beispielobjekt mit einem Inhaltsarray, das die Quelle enthält, die über einen Amazon S3 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 Rohbytes im bytes Feld, kodiert in Base64. Wenn Sie das AWS SDK verwenden, müssen Sie die Bytes nicht in Base64 codieren.

Wenn Sie das text Feld nicht angeben, beschreibt das Modell das Video.

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 S3-URI angeben, anstatt die Bytes direkt im Anforderungstext zu übergeben. Das Folgende zeigt ein Message Beispielobjekt mit einem Inhaltsarray, das die Quelle enthält, die über einen Amazon S3 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-Checkpoints als Block in einer Nachricht zusammen mit einer zugehörigen Aufforderung hinzufügen, indem Sie cachePoint Felder verwenden, um das Prompt-Caching zu nutzen. Das Zwischenspeichern von Eingabeaufforderungen ist eine Funktion, mit der Sie beginnen können, den Kontext von Konversationen zwischenzuspeichern, um Kosten und Latenz zu sparen. Weitere Informationen finden Sie unter Promptes Caching für schnellere Modellinferenz.

Im Folgenden wird ein Beispiel für ein Message-Objekt mit einem content Array gezeigt, das ein Dokument ContentBlockund den erforderlichen Begleittext enthält ContentBlock, sowie einen CachePoint, der sowohl das 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 können dieses Feld verwenden, um eine Eingabe als Ziel zu verwenden, die anhand der im Feld definierten Leitplanke ausgewertet werden soll. guardrailConfig Wenn Sie dieses Feld nicht angeben, wertet die Leitplanke alle Nachrichten im Anforderungstext aus. Sie können die folgenden Inhaltstypen in einem übergeben: GuardBlock

Weitere Hinweise zur Verwendung von Leitplanken finden Sie unter. Erkennen und filtern Sie schädliche Inhalte mithilfe von Amazon Bedrock Guardrails

Das reasoningContent Feld ist einem zugeordnet. ReasoningContentBlock Dieser Block enthält Inhalte zu den Überlegungen, die vom Modell zur Generierung der beigefügten ContentBlock Antwort verwendet wurden.

Das Folgende zeigt ein Message Objekt mit einem content Array, das nur a ReasoningContentBlock und einen zugehörigen Text ContentBlock enthält.

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

Das ReasoningContentBlock enthält die Argumentation, die zur Generierung des zugehörigen reasoningText Feldinhalts verwendet wurde, sowie alle Inhalte der Argumentation, die vom Modellanbieter aus Gründen des Vertrauens und der redactedContent Sicherheit vor Ort verschlüsselt wurden.

Innerhalb des reasoningText Feldes beschreiben die text Felder die Argumentation. Das signature Feld 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 Anfragen einbeziehen. Converse Wenn eine der Nachrichten geändert wird, gibt die Antwort einen Fehler aus.

Enthält Informationen zu einem Werkzeug, das für das Modell verwendet werden soll. Weitere Informationen finden Sie unter Ein Tool verwenden, 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 Ein Tool verwenden, um eine Amazon-Bedrock-Modellantwort zu vervollständigen.