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 explication Amazon Forecast.

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 score d'impact pour quantifier l'impact relatif de chaque attribut et déterminer s'il augmente ou diminue les valeurs de prévision.

Pour activer Forecast Explainability, votre prédicteur doit inclure au moins l'un des éléments suivants : des séries chronologiques associées, des métadonnées d'éléments ou des ensembles de données supplémentaires tels que Holidays et l'indice météo.

CreateExplainability accepte soit un Predictor ARN, soit un Forecast ARN. 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édictif. Pour recevoir les scores d'impact pour des séries chronologiques et des points temporels spécifiques, fournissez un Forecast ARN.

CreateExplainability avec un ARN prédictif

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 dispose déjà d'une ressource d'explicabilité.

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

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

• ResourceArn- L'Arn du prédicteur.

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

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

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 Forecast ARN

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 prédicteur :

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

• ResourceArn- L'Arn des prévisions.

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

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

Si vous réglez TimeSeriesGranularity sur « SPÉCIFIQUE », vous devez également fournir les informations suivantes :

• DataSource- L'emplacement S3 du fichier CSV spécifiant 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 réglez TimePointGranularity sur « 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 AWS Identity and Access Management (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 de l'explicabilité consultable dans la console. AWS

Type : booléen

Obligatoire : non

EndDateTime

Si la 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 : 2015-01-01T 20: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'explicabilité.

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

L'Amazon Resource Name (ARN) du Predictor ou Forecast utilisé pour créer l'Explainability.

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 la TimePointGranularity valeur est définie surSPECIFIC, définissez le premier point de l'explicabilité.

Utilisez le format d'horodatage suivant : YYYY-MM-DDTHH:MM:SS (exemple : 2015-01-01T 20: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 valeurs de balise sont sensibles à la casse.

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 maximale de la clé : 128 caractères Unicode en UTF-8.

• Longueur maximale de la valeur : 256 caractères Unicode en UTF-8.

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

• Les préfixes clés ne peuvent inclure aucune combinaison majuscules ou minuscules 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 compte dans la limite de 50 balises. Les balises dont le seul préfixe est « ne sont pas prises en compte dans aws le calcul de vos balises par limite de ressources ». Vous ne pouvez pas modifier ou supprimer les clés de balise 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

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• AWS SDK pour C++

• AWS SDK pour Go v2

• AWS SDK pour Java V2

• AWS SDK pour V3 JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• AWS SDK pour Ruby V3