View a markdown version of this page

CreateExplainability - Amazon Forecast
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

Amazon Forecast n'est plus disponible pour les nouveaux clients. Les clients existants d'Amazon Forecast peuvent continuer à utiliser le service normalement. En savoir plus »

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.

CreateExplainability

Note

L'explicabilité n'est disponible que pour les prévisions et les prédicteurs générés à partir d'un () AutoPredictor CreateAutoPredictor

Crée une explicabilité Amazon Forecast.

Important

Amazon Forecast n'est plus disponible pour les nouveaux clients. Les clients existants d'Amazon Forecast peuvent continuer à utiliser le service normalement. En savoir plus »

L'explicabilité vous aide à mieux comprendre l'impact des attributs de vos ensembles de données sur les prévisions. Amazon Forecast utilise une métrique appelée Impact scores pour quantifier l'impact relatif de chaque attribut et déterminer s'il augmente ou diminue les valeurs de prévision.

Pour activer l'explicabilité des prévisions, votre prédicteur doit inclure au moins l'un des éléments suivants : séries chronologiques associées, métadonnées des éléments ou ensembles de données supplémentaires tels que les jours fériés et l'indice météorologique.

Note

Les modèles ARIMA (AutoRegressive Integrated Moving Average), ETS (Exponential Smoothing State Space Model) et NPTS (Non-Parametric Time Series) n'intègrent pas de données de séries chronologiques externes. Par conséquent, ces modèles ne créent pas de rapport d'explicabilité, même si vous incluez les jeux de données supplémentaires.

CreateExplainability accepte un ARN Predictor ou un ARN Forecast. Pour recevoir des scores d'impact agrégés pour toutes les séries chronologiques et tous les points temporels de vos ensembles de données, fournissez un ARN prédicteur. Pour recevoir des scores d'impact pour des séries chronologiques et des points temporels spécifiques, fournissez un ARN de prévision.

CreateExplainability avec un ARN prédicteur

Note

Vous ne pouvez disposer que d'une seule ressource d'explicabilité par prédicteur. Si vous l'avez déjà activé ExplainPredictorCreateAutoPredictor, ce prédicteur possède déjà une ressource d'explicabilité.

Les paramètres suivants sont requis lors de la fourniture d'un ARN de prédiction :

  • ExplainabilityName- Un nom unique pour l'explicabilité.

  • ResourceArn- L'Arn du prédicteur.

  • TimePointGranularity- Doit être réglé sur « TOUT ».

  • TimeSeriesGranularity- Doit être réglé sur « TOUT ».

Ne spécifiez pas de valeur pour les paramètres suivants :

  • DataSource- Valable uniquement lorsque la TimeSeriesGranularity valeur est « SPÉCIFIQUE ».

  • Schema- Valable uniquement lorsque la TimeSeriesGranularity valeur est « SPÉCIFIQUE ».

  • StartDateTime- Valable uniquement lorsque la TimePointGranularity valeur est « SPÉCIFIQUE ».

  • EndDateTime- Valable uniquement lorsque la TimePointGranularity valeur est « SPÉCIFIQUE ».

CreateExplainability avec un ARN Forecast

Note

Vous pouvez spécifier un maximum de 50 séries chronologiques et 500 points temporels.

Les paramètres suivants sont requis lors de la fourniture d'un ARN de prédiction :

  • ExplainabilityName- Un nom unique pour l'explicabilité.

  • ResourceArn- L'Arne des prévisions.

  • TimePointGranularity- « TOUS » ou « SPÉCIFIQUE ».

  • TimeSeriesGranularity- « TOUS » ou « SPÉCIFIQUE ».

Si vous sélectionnez TimeSeriesGranularity « SPÉCIFIQUE », vous devez également fournir les informations suivantes :

  • DataSource- L'emplacement S3 du fichier CSV indiquant votre série chronologique.

  • Schema- Le schéma définit les attributs et les types d'attributs répertoriés dans la source de données.

Si vous sélectionnez TimePointGranularity « SPÉCIFIQUE », vous devez également fournir les informations suivantes :

  • StartDateTime- Le premier horodatage de la plage de points temporels.

  • EndDateTime- Le dernier horodatage de la plage de points temporels.

Syntaxe de la requête

{
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Paramètres de demande

Cette demande accepte les données suivantes au format JSON.

DataSource

La source de vos données, un rôle Gestion des identités et des accès AWS (IAM) qui permet à Amazon Forecast d'accéder aux données et, éventuellement, une clé AWS Key Management Service (KMS).

Type : objet DataSource

Obligatoire : non

EnableVisualization

Créez une visualisation d'explicabilité visible dans la console. AWS

Type : booléen

Obligatoire : non

EndDateTime

Si cette TimePointGranularity valeur est définie surSPECIFIC, définissez le dernier point temporel de l'explicabilité.

Utilisez le format d'horodatage suivant : yyyy- MM-ddTHH:mm:ss (exemple : 01/01/2015) T20:00:00

Type : Chaîne

Contraintes de longueur : longueur maximale de 19.

Modèle : ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Obligatoire : non

ExplainabilityConfig

Les paramètres de configuration qui définissent la granularité des séries chronologiques et des points temporels pour l'explicabilité.

Type : objet ExplainabilityConfig

Obligatoire : oui

ExplainabilityName

Un nom unique pour l'Explainability.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.

Modèle : ^[a-zA-Z][a-zA-Z0-9_]*

Obligatoire : oui

ResourceArn

Le nom de ressource Amazon (ARN) du prédicteur ou de la prévision utilisé pour créer l'explicabilité.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):forecast:.*:.*:.+

Obligatoire : oui

Schema

Définit les champs d'un jeu de données.

Type : objet Schema

Obligatoire : non

StartDateTime

Si TimePointGranularity cette valeur est définie surSPECIFIC, définissez le premier point pour l'explicabilité.

Utilisez le format d'horodatage suivant : yyyy- MM-ddTHH:mm:ss (exemple : 01/01/2015) T20:00:00

Type : Chaîne

Contraintes de longueur : longueur maximale de 19.

Modèle : ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Obligatoire : non

Tags

Des métadonnées facultatives pour vous aider à classer et à organiser vos ressources. Chaque balise est constituée d’une clé et d’une valeur facultative que vous définissez. Les clés et les valeurs des balises font la distinction entre majuscules et minuscules.

Les restrictions suivantes s’appliquent aux balises :

  • Pour chaque ressource, chaque clé de balise doit être unique et chaque clé de balise doit avoir une valeur.

  • Nombre maximum de balises par ressource : 50.

  • Longueur de clé maximale : 128 caractères Unicode. UTF-8

  • Longueur de valeur maximale : 256 caractères Unicode au UTF-8 format.

  • Caractères acceptés : toutes les lettres et tous les chiffres, les espaces peuvent être représentés et + - =. UTF-8 _ :/@. Si votre schéma de balisage est utilisé dans d'autres services et ressources, les restrictions de caractères de ces services s'appliquent également.

  • Les préfixes clés ne peuvent inclure aucune combinaison majuscule ou minuscule de ou. aws: AWS: Les valeurs peuvent avoir ce préfixe. Si une valeur de balise a aws pour préfixe mais pas la clé, Forecast considère qu'il s'agit d'une balise utilisateur et sera prise en compte dans la limite de 50 balises. Les balises dont le seul préfixe clé est ne sont aws pas prises en compte dans vos balises par limite de ressource. Vous ne pouvez ni modifier ni supprimer les clés de tag avec ce préfixe.

Type : tableau d’objets Tag

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 200 éléments.

Obligatoire : non

Syntaxe de la réponse

{
   "ExplainabilityArn": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

ExplainabilityArn

Le nom de ressource Amazon (ARN) de l'explicabilité.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):forecast:.*:.*:.+

Erreurs

InvalidInputException

Nous ne pouvons pas traiter la demande car elle contient une valeur non valide ou une valeur qui dépasse la plage valide.

Code d’état HTTP : 400

LimitExceededException

La limite du nombre de ressources par compte a été dépassée.

Code d’état HTTP : 400

ResourceAlreadyExistsException

Il existe déjà une ressource portant ce nom. Réessayez avec un autre nom.

Code d’état HTTP : 400

ResourceInUseException

La ressource spécifiée est en cours d'utilisation.

Code d’état HTTP : 400

ResourceNotFoundException

Nous ne trouvons aucune ressource portant ce nom de ressource Amazon (ARN). Vérifiez l'ARN et réessayez.

Code d’état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :