View a markdown version of this page

Anfrage- und Antwortschema - Amazon Nova

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Anfrage- und Antwortschema

Das Anforderungsschema zwischen der Invoke API und der Converse API ist nahezu identisch. Der Hauptunterschied besteht darin, wie Binärdaten (Bilder, Video, Audio) codiert werden: Die Converse-API verwendet binäre Arrays, während die Invoke-API Base64-kodierte Zeichenketten verwendet.

Vollständige Anforderungsstruktur

Im Folgenden wird die vollständige Anforderungsstruktur für Amazon Nova-Modelle dargestellt. Alle Felder sind optional, sofern sie nicht als erforderlich gekennzeichnet sind:

{ "system": [ { "text": "string" } ], "messages": [ // Required { "role": "user", // Required - first turn must be user "content": [ // Required { "text": "string" }, { "image": { "format": "jpeg" | "png" | "gif" | "webp", // Required "source": { // Required "bytes": image // Binary array (Converse) or Base64 string (Invoke) } } }, { "video": { "format": "mkv" | "mov" | "mp4" | "webm" | "three_gp" | "flv" | "mpeg" | "mpg" | "wmv", "source": { // Option 1: S3 location "s3Location": { "uri": "string", // e.g., s3://my-bucket/object-key "bucketOwner": "string" // Optional, e.g., "123456789012" }, // Option 2: File bytes "bytes": video // Binary array (Converse) or Base64 string (Invoke) } } }, { "audio": { // Nova 2 Omni and Sonic only "format": "mp3" | "opus" | "wav" | "aac" | "flac" | "mp4" | "ogg" | "mkv", "source": { // Option 1: S3 location "s3Location": { "uri": "string", "bucketOwner": "string" // Optional }, // Option 2: File bytes "bytes": audio // Binary array (Converse) or Base64 string (Invoke) } } } ] }, { "role": "assistant", "content": [ { "text": "string" // For prefilling assistant response } ] } ], "inferenceConfig": { // All optional "maxTokens": int, // 1-5000, default: dynamic "temperature": float, // 0.00001-1, default: 0.7 "topP": float, // 0-1, default: 0.9 "topK": int, // 0-128, default: not used "stopSequences": ["string"], "reasoningConfig": { // Nova 2 Lite and Sonic only "type": "enabled" | "disabled", // default: "disabled" "maxReasoningEffort": "low" | "medium" | "high" } }, "toolConfig": { // Optional "tools": [ { "toolSpec": { "name": "string", // Max 64 characters "description": "string", "inputSchema": { "json": { "type": "object", "properties": { "arg1": { "type": "string", "description": "string" } }, "required": ["string"] } } } } ], "toolChoice": { // Choose one option "auto": {}, "any": {}, "tool": { "name": "string" } } } }

Wichtige Anforderungsparameter:

  • system: Systemaufforderung mit Kontext und Anweisungen

  • messages: Reihe von Gesprächsrunden mit Rolle (Benutzer oder Assistent) und Inhalt

  • inferenceConfig: Steuert das Verhalten der Modellausgabe (Temperatur, Tokens usw.)

  • toolConfig: Werkzeugspezifikationen für den Funktionsaufruf

Anmerkung

Wenn Sie die Converse-API verwenden, müssen die reasoningConfig Parameter topK und additionalModelRequestFields anstelle von inferenceConfig eingegeben werden.

Die folgenden Abschnitte enthalten detaillierte Erläuterungen zu den einzelnen Anforderungsparametern:

system – (Optional) Der System-Prompt für die Anfrage. Eine Systemaufforderung bietet Amazon Nova Kontext und Anweisungen, z. B. die Angabe eines bestimmten Ziels oder einer bestimmten Rolle.

messages— (Erforderlich) Das Eingabe-Nachrichten-Array, das Gesprächsrunden enthält.

  • role— (Erforderlich) Die Rolle der Konversationsrunde. Gültige Werte sind user und assistant. Die erste Nachricht muss immer die user Rolle verwenden.

  • content— (Erforderlich) Eine Reihe von Inhaltsblöcken. Jeder Block spezifiziert einen Inhaltstyp (textimage,video,, oderaudio):

    • text— Textinhalt für die Konversation. Wird in Kombination mit Bild oder Video als Begleittext interpretiert.

    • image— (Nicht unterstützt für Nova 2 Lite) Bildinhalt mit:

      • format— (Erforderlich) Bildformat: jpegpng,webp, oder gif

      • source.bytes— (Erforderlich) Bilddaten als binäres Array (Converse API) oder Base64-String (Invoke API)

    • video— (Nicht unterstützt für Nova 2 Lite) Videoinhalt mit:

      • format— (Erforderlich) Videoformat:mkv,mov,mp4,webm,three_gp,,flv,mpeg,mpg, oder wmv

      • source— (Erforderlich) Videoquelle über S3-URI (s3Location.uriund optionalbucketOwner) oder Dateibytes (bytes)

    • audio— (Amazon Nova Sonic und nur) Audioinhalte mit:

      • format— (Erforderlich) Audioformat:mp3,opus,wav,aac,,flac,mp4,ogg, oder mkv

      • source— (Erforderlich) Audioquelle über S3-URI oder Dateibytes

inferenceConfig— (Optional) Konfigurationsparameter, die die Generierung der Modellausgabe steuern.

  • maxTokens— (Optional) Maximale Anzahl an Tokens, die vor dem Stoppen generiert werden müssen. Amazon Nova-Modelle werden möglicherweise gestoppt, bevor dieses Limit erreicht wird. Der Höchstwert ist 5.000. Wenn nicht angegeben, wird ein dynamischer Standard verwendet, der auf dem Anforderungskontext basiert.

  • temperature— (Optional) Zufälligkeit der Antworten. Gültiger Bereich: 0,00001-1 (Standard: 0,7). Niedrigere Werte führen zu einer deterministischeren Ausgabe.

  • topP— (Optional) Schwellenwert für die Nukleus-Probenahme. Amazon Nova nimmt Stichproben von Tokens, deren kumulative Wahrscheinlichkeit erreichttopP. Gültiger Bereich: 0-1 (Standard: 0,9). Passen Sie entweder temperature odertopP, nicht beide an.

  • topK— (Optional) Nur Probe aus den Top K Tokens. Entfernt Antworten mit geringer Wahrscheinlichkeit. Gültiger Bereich: 0-128 (Standard: nicht verwendet).

    Anmerkung

    Geben Sie für die Converse API ein. topK additionalModelRequestFields

  • stopSequences— (Optional) Array von Zeichenketten, deren Generierung beendet wird, wenn sie gefunden wird.

  • reasoningConfig— (Amazon Nova Sonic und nur) Konfiguration von Reasoning:

    • type— (Optional) enabled oder disabled (Standard:disabled)

    • maxReasoningEffort— Rechenaufwand:low,medium, oderhigh. Mit low und wird das medium Argumentieren inkrementell gestreamt; high gibt die Argumentation in einem letzten Abschnitt aus.

    Anmerkung

    Geben Sie für die Converse API ein. reasoningConfig additionalModelRequestFields

toolConfig— (Optional) Konfiguration des Tools nach dem ToolConfiguration Schema.

  • tools— Reihe von Werkzeugspezifikationen mitname, description und inputSchema

  • toolChoice— (Optional) Steuert die Werkzeugauswahl:

    • auto— Das Modell entscheidet, ob und welche Tools verwendet werden

    • any— Das Modell muss mindestens ein Werkzeug verwenden

    • tool— Das Modell muss das angegebene Werkzeug namentlich verwenden

Vollständige Antwortstruktur

Im Folgenden wird die vollständige Antwortstruktur für Amazon Nova-Modelle dargestellt:

{ "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": [ { "reasoningContent": { // Optional - if reasoning enabled "reasoningText": { "text": "[REDACTED]" } } }, { "toolUse": { // Optional - if tool called "toolUseId": "string", "name": "string", "input": {} // Tool-specific arguments } }, { "text": "string" // Optional - text response }, { "image": { // Optional - Nova 2 Omni only "format": "png", "source": { "bytes": image // Binary array (Converse) or Base64 string (Invoke) } } } ] } }, "stopReason": "string", // See stop reasons below "usage": { "inputTokens": int, "outputTokens": int, "totalTokens": int }, "metrics": { "latencyMs": int } }

Gründe für den Stopp:

  • end_turn: Natürliches Ende der Antwort

  • max_tokens: Das MaxToken-Limit wurde erreicht

  • content_filtered: Gegen die Inhaltsrichtlinie verstoßen

  • malformed_model_output: Ungültige Modellausgabe

  • malformed_tool_use: Ungültige Ausgabe zur Verwendung des Werkzeugs

  • service_unavailable: Der integrierte Tool-Service ist nicht erreichbar

  • invalid_query: Ungültige Abfrage zum integrierten Tool

  • max_tool_invocations: Die Wiederholungsversuche des Tools sind erschöpft

Die folgenden Abschnitte enthalten ausführliche Erläuterungen zu den einzelnen Antwortfeldern:

output— (Erforderlich) Enthält die Antwortnachricht des Modells.

  • message— (Erforderlich) Die Antwortnachricht des Assistenten mit Rolle und Inhaltsarray.

  • content— (Erforderlich) Eine Reihe von Inhaltsblöcken, die Folgendes beinhalten können:

    • reasoningContent— (Optional) Wird zurückgegeben, wenn Argumentation aktiviert war. Enthält Argumentationstext, der immer [REDACTED] in der Antwort enthalten sein wird.

    • toolUse— (Optional) Wird zurückgegeben, wenn ein Tool aufgerufen wurde. Enthält die Verwendungs-ID, den Namen und die Eingabeargumente des Tools.

    • text— (Optional) Wird zurückgegeben, wenn das Modell mit Textinhalt geantwortet hat.

    • image— (Nur optional) Wird zurückgegeben, wenn das Modell ein Bild generiert hat. Das Format wird immer PNG sein.

stopReason— (Erforderlich) Gibt an, warum das Modell keine Ausgabe mehr generiert hat:

  • end_turn— Natürliches Ende der Antwort erreicht

  • max_tokens— Das MaxToken-Limit oder das maximale Ausgangslimit des Modells wurde erreicht

  • content_filtered— Die Ausgabe hat gegen die Richtlinie AWS für verantwortungsvolle KI verstoßen

  • malformed_model_output— Das Modell hat eine ungültige Ausgabe erzeugt

  • malformed_tool_use— Das Modell hat eine ungültige Ausgabe für die Werkzeugnutzung erzeugt

  • service_unavailable— Der integrierte Werkzeugservice konnte nicht erreicht werden

  • invalid_query— Die Abfrage an das integrierte Tool war ungültig

  • max_tool_invocations— Das integrierte Tool lieferte nach Wiederholungsversuchen kein gültiges Ergebnis

usage— (Erforderlich) Informationen zur Token-Nutzung:

  • inputTokens— Gesamtzahl der vom Modell aufgenommenen Token

  • outputTokens— Anzahl der generierten Token

  • totalTokens— Summe der Eingabe- und Ausgabetoken

metrics— (Erforderliche) Leistungskennzahlen:

  • latencyMs— Gesamtdauer für die Fertigstellung der Inferenz in Millisekunden