Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Schéma de demande et de réponse
Le schéma de demande est presque identique entre l'API Invoke et l'API Converse. La principale différence réside dans la manière dont les données binaires (images, vidéo, audio) sont codées : l'API Converse utilise des tableaux binaires tandis que l'API Invoke utilise des chaînes codées en Base64.
Structure de demande complète
Vous trouverez ci-dessous la structure complète des demandes pour les modèles Amazon Nova. Tous les champs sont facultatifs sauf s'ils sont marqués comme obligatoires :
{ "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" } } } }
Principaux paramètres de demande :
-
system: invite du système fournissant le contexte et les instructions -
messages: éventail de tournants de conversation avec le rôle (utilisateur ou assistant) et le contenu -
inferenceConfig: contrôle le comportement de sortie du modèle (température, jetons, etc.) -
toolConfig: Spécifications de l'outil pour l'appel de fonctions
Note
Lorsque vous utilisez l'API Converse, les reasoningConfig paramètres topK et doivent être placés dedans additionalModelRequestFields au lieu deinferenceConfig.
Les sections suivantes fournissent des explications détaillées sur chaque paramètre de demande :
system : (facultatif) invite du système pour la demande. Une invite système fournit le contexte et les instructions à Amazon Nova, telles que la spécification d'un objectif ou d'un rôle particulier.
messages— (Obligatoire) Le tableau de messages d'entrée contenant les tournants de conversation.
-
role— (Obligatoire) Le rôle du tour de conversation. Les valeurs valides sontuseretassistant. Le premier message doit toujours utiliser leuserrôle. -
content— (Obligatoire) Un tableau de blocs de contenu. Chaque bloc spécifie un type de contenu (textimage,video, ouaudio) :-
text— Contenu textuel correspondant au tour de la conversation. S'il est combiné avec une image ou une vidéo, interprété comme un texte d'accompagnement. -
image— (Non compatible avec Nova 2 Lite) Contenu de l'image avec :-
format— (Obligatoire) Format d'image :jpegpng,webp, ougif -
source.bytes— (Obligatoire) Données d'image sous forme de tableau binaire (API Converse) ou de chaîne Base64 (API Invoke)
-
-
video— (Non compatible avec Nova 2 Lite) Contenu vidéo avec :-
format— (Obligatoire) Format vidéo :mkvmovmp4,webm,three_gp,flv,mpeg,mpg, ouwmv -
source— (Obligatoire) Source vidéo via l'URI S3 (s3Location.uriet facultatifbucketOwner) ou les octets de fichier (bytes)
-
-
audio— (Amazon Nova Sonic et uniquement) Contenu audio avec :-
format— (Obligatoire) Format audio :mp3opus,wav,aac,flac,mp4,ogg, oumkv -
source— (Obligatoire) Source audio via l'URI S3 ou des octets de fichier
-
-
inferenceConfig— (Facultatif) Paramètres de configuration contrôlant la génération de sortie du modèle.
-
maxTokens— (Facultatif) Nombre maximum de jetons à générer avant l'arrêt. Les modèles Amazon Nova peuvent s'arrêter avant d'atteindre cette limite. La valeur maximale est de 5 000. Si ce n'est pas spécifié, utilise une valeur par défaut dynamique basée sur le contexte de la demande. -
temperature— (Facultatif) Aléatoire dans les réponses. Plage valide : 0,00001-1 (valeur par défaut : 0,7). Des valeurs faibles produisent des résultats plus déterministes. -
topP— (Facultatif) Seuil d'échantillonnage du noyau. Amazon Nova prélève des échantillons à partir de jetons dont la probabilité cumulée atteinttopP. Plage valide : 0-1 (par défaut : 0,9). Ajustez l'temperatureun outopPl'autre, mais pas les deux. -
topK— (Facultatif) Échantillon uniquement à partir des K meilleurs jetons. Supprime les réponses à faible probabilité. Plage valide : 0 à 128 (valeur par défaut : non utilisée).Note
Pour l'API Converse, transmettez-le
topK.additionalModelRequestFields -
stopSequences— (Facultatif) Tableau de chaînes qui arrête la génération lorsqu'il est rencontré. -
reasoningConfig— (Amazon Nova Sonic et uniquement) Configuration de raisonnement :-
type— (Facultatif)enabledoudisabled(par défaut :disabled) -
maxReasoningEffort— Effort informatique :low,medium, ouhigh. Aveclowetmedium, le raisonnement se déroule de manière incrémentielle ;highproduit le raisonnement dans un dernier bloc.
Note
Pour l'API Converse, transmettez-le
reasoningConfig.additionalModelRequestFields -
toolConfig— (Facultatif) Configuration de l'outil selon ToolConfiguration le schéma.
-
tools— Gamme de spécifications d'outils avecname,descriptionetinputSchema -
toolChoice— (Facultatif) Contrôle la sélection de l'outil :-
auto— Le modèle décide si et quels outils utiliser -
any— Le modèle doit utiliser au moins un outil -
tool— Le modèle doit utiliser l'outil spécifié par son nom
-
Structure de réponse complète
Voici la structure de réponse complète pour les modèles Amazon Nova :
{ "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 } }
Raisons de l'arrêt :
-
end_turn: Fin naturelle de la réponse -
max_tokens: limite de MaxTokens atteinte -
content_filtered: Politique relative au contenu enfreint -
malformed_model_output: sortie de modèle non valide -
malformed_tool_use: sortie d'utilisation de l'outil non valide -
service_unavailable: Le service d'outils intégré n'est pas accessible -
invalid_query: requête non valide envoyée à l'outil intégré -
max_tool_invocations: Les nouvelles tentatives de l'outil ont échoué
Les sections suivantes fournissent des explications détaillées sur chaque champ de réponse :
output— (Obligatoire) Contient le message de réponse du modèle.
-
message— (Obligatoire) Le message de réponse de l'assistant avec le rôle et le tableau de contenu. -
content— (Obligatoire) Tableau de blocs de contenu pouvant inclure :-
reasoningContent— (Facultatif) Retourné si le raisonnement était activé. Contient un texte de raisonnement, qui figurera toujours[REDACTED]dans la réponse. -
toolUse— (Facultatif) Renvoie si un outil a été appelé. Contient l'ID d'utilisation de l'outil, le nom et les arguments d'entrée. -
text— (Facultatif) Renvoyé si le modèle a répondu avec un contenu textuel. -
image— (Facultatif, uniquement) Renvoyé si le modèle a généré une image. Le format sera toujours PNG.
-
stopReason— (Obligatoire) Indique pourquoi le modèle a cessé de générer une sortie :
-
end_turn— Fin de réponse naturelle atteinte -
max_tokens— La limite de MaxTokens ou la limite de sortie maximale du modèle a été atteinte -
content_filtered— La sortie a enfreint AWS la politique d'IA responsable -
malformed_model_output— Le modèle a produit une sortie non valide -
malformed_tool_use— Le modèle produit une sortie d'utilisation de l'outil non valide -
service_unavailable— Le service d'outils intégré n'a pas pu être atteint -
invalid_query— La requête vers l'outil intégré n'était pas valide -
max_tool_invocations— L'outil intégré n'a pas produit de résultat valide après de nouvelles tentatives
usage— Informations sur l'utilisation du jeton (obligatoire) :
-
inputTokens— Nombre total de jetons ingérés par le modèle -
outputTokens— Nombre de jetons générés -
totalTokens— Somme des jetons d'entrée et de sortie
metrics— Indicateurs de performance (obligatoires) :
-
latencyMs— Temps total de réalisation de l'inférence en millisecondes