View a markdown version of this page

DescribePredictor - 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.

DescribePredictor

Note

Cette opération n'est valide que pour les anciens prédicteurs créés avec CreatePredictor. Si vous n'utilisez pas d'ancien prédicteur, utilisezDescribeAutoPredictor.

Décrit un prédicteur créé à l'aide de cette CreatePredictor opération.

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 »

Outre la liste des propriétés fournies dans la CreatePredictor demande, cette opération répertorie les propriétés suivantes :

  • DatasetImportJobArns- Les tâches d'importation de l'ensemble de données utilisées pour importer les données de formation.

  • AutoMLAlgorithmArns- Si AutoML est exécuté, les algorithmes qui ont été évalués.

  • CreationTime

  • LastModificationTime

  • Status

  • Message- Si une erreur s'est produite, informations sur l'erreur.

Syntaxe de la requête

{
   "PredictorArn": "string"
}

Paramètres de demande

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

PredictorArn

Le nom de ressource Amazon (ARN) du prédicteur sur lequel vous souhaitez obtenir des informations.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "AlgorithmArn": "string",
   "AutoMLAlgorithmArns": [ "string" ],
   "AutoMLOverrideStrategy": "string",
   "CreationTime": number,
   "DatasetImportJobArns": [ "string" ],
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EstimatedTimeRemainingInMinutes": number,
   "EvaluationParameters": { 
      "BackTestWindowOffset": number,
      "NumberOfBacktestWindows": number
   },
   "FeaturizationConfig": { 
      "Featurizations": [ 
         { 
            "AttributeName": "string",
            "FeaturizationPipeline": [ 
               { 
                  "FeaturizationMethodName": "string",
                  "FeaturizationMethodParameters": { 
                     "string" : "string" 
                  }
               }
            ]
         }
      ],
      "ForecastDimensions": [ "string" ],
      "ForecastFrequency": "string"
   },
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "HPOConfig": { 
      "ParameterRanges": { 
         "CategoricalParameterRanges": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ],
         "ContinuousParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ],
         "IntegerParameterRanges": [ 
            { 
               "MaxValue": number,
               "MinValue": number,
               "Name": "string",
               "ScalingType": "string"
            }
         ]
      }
   },
   "InputDataConfig": { 
      "DatasetGroupArn": "string",
      "SupplementaryFeatures": [ 
         { 
            "Name": "string",
            "Value": "string"
         }
      ]
   },
   "IsAutoPredictor": boolean,
   "LastModificationTime": number,
   "Message": "string",
   "OptimizationMetric": "string",
   "PerformAutoML": boolean,
   "PerformHPO": boolean,
   "PredictorArn": "string",
   "PredictorExecutionDetails": { 
      "PredictorExecutions": [ 
         { 
            "AlgorithmArn": "string",
            "TestWindows": [ 
               { 
                  "Message": "string",
                  "Status": "string",
                  "TestWindowEnd": number,
                  "TestWindowStart": number
               }
            ]
         }
      ]
   },
   "PredictorName": "string",
   "Status": "string",
   "TrainingParameters": { 
      "string" : "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.

AlgorithmArn

Le nom de ressource Amazon (ARN) de l'algorithme utilisé pour la formation des modèles.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

AutoMLAlgorithmArns

Quand PerformAutoML est spécifié, l'ARN de l'algorithme choisi.

Type : tableau de chaînes

Contraintes de longueur : longueur maximale de 256.

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

AutoMLOverrideStrategy
Note

La stratégie de LatencyOptimized remplacement AutoML n'est disponible qu'en version bêta privée. Contactez AWS le support ou votre responsable de compte pour en savoir plus sur les privilèges d'accès.

La stratégie AutoML utilisée pour entraîner le prédicteur. Sauf indication contraireLatencyOptimized, la stratégie AutoML optimise la précision des prédicteurs.

Ce paramètre n'est valide que pour les prédicteurs entraînés à l'aide d'AutoML.

Type : Chaîne

Valeurs valides : LatencyOptimized | AccuracyOptimized

CreationTime

Quand la tâche d'entraînement modèle a été créée.

Type : Timestamp

DatasetImportJobArns

Tableau des ARN des tâches d'importation de l'ensemble de données utilisées pour importer des données d'entraînement pour le prédicteur.

Type : tableau de chaînes

Contraintes de longueur : longueur maximale de 256.

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

EncryptionConfig

Une clé AWS Key Management Service (KMS) et le rôle Gestion des identités et des accès AWS (IAM) qu'Amazon Forecast peut assumer pour accéder à la clé.

Type : objet EncryptionConfig

EstimatedTimeRemainingInMinutes

Temps estimé restant en minutes pour terminer la tâche de formation des prédicteurs.

Type : Long

EvaluationParameters

Utilisé pour remplacer les paramètres d'évaluation par défaut de l'algorithme spécifié. Amazon Forecast évalue un prédicteur en divisant un ensemble de données en données d'entraînement et en données de test. Les paramètres d'évaluation définissent comment effectuer le fractionnement et le nombre d'itérations.

Type : objet EvaluationParameters

FeaturizationConfig

Configuration de la fonctionnalité.

Type : objet FeaturizationConfig

ForecastHorizon

Le nombre de pas temporels de la prévision. L’horizon de prévision est également appelé longueur de prédiction.

Type : Integer

ForecastTypes

Les types de prévisions utilisés lors de l'entraînement des prédicteurs. La valeur par défaut est ["0.1","0.5","0.9"]

Type : tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 20 éléments.

Contraintes de longueur : longueur minimale de 2. Longueur maximale de 4.

Modèle : (^0?\.\d\d?$|^mean$)

HPOConfig

L'hyperparamètre remplace les valeurs de l'algorithme.

Type : objet HyperParameterTuningJobConfig

InputDataConfig

Décrit le groupe de jeux de données qui contient les données à utiliser pour entraîner le prédicteur.

Type : objet InputDataConfig

IsAutoPredictor

Si le prédicteur a été créé avecCreateAutoPredictor.

Type : Boolean

LastModificationTime

Dernière modification de la ressource. L'horodatage dépend du statut de la tâche :

  • CREATE_PENDING- LeCreationTime.

  • CREATE_IN_PROGRESS- L'horodatage actuel.

  • CREATE_STOPPING- L'horodatage actuel.

  • CREATE_STOPPED- Quand le travail s'est arrêté.

  • ACTIVEou CREATE_FAILED : lorsque la tâche s'est terminée ou a échoué.

Type : Timestamp

Message

Si une erreur s'est produite, un message d'information concernant l'erreur.

Type : Chaîne

OptimizationMetric

La métrique de précision utilisée pour optimiser le prédicteur.

Type : Chaîne

Valeurs valides : WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PerformAutoML

Si le prédicteur est configuré pour exécuter AutoML.

Type : Boolean

PerformHPO

Si le prédicteur est configuré pour effectuer une optimisation des hyperparamètres (HPO).

Type : Boolean

PredictorArn

L'ARN du prédicteur.

Type : Chaîne

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

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

PredictorExecutionDetails

Détails sur l'état et les résultats des tests rétroactifs effectués pour évaluer la précision du prédicteur. Vous spécifiez le nombre de backtests à effectuer lorsque vous appelez l'CreatePredictoropération.

Type : objet PredictorExecutionDetails

PredictorName

Le nom du prédicteur.

Type : Chaîne

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

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

Status

État du prédicteur. Les États incluent :

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

Note

Vous devez avoir obtenu la valeur Status du prédicteur ACTIVE avant de pouvoir utiliser le prédicteur pour créer une prévision.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

TrainingParameters

Les paramètres d'entraînement par défaut ou les remplacements sélectionnés lors de l'entraînement du modèle. Lorsque vous exécutez AutoML ou que vous choisissez HPO avec CNN-QR ou DeepAr+, les valeurs optimisées pour les hyperparamètres choisis sont renvoyées. Pour de plus amples informations, veuillez consulter Algorithmes d'Amazon Forecast.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre minimum de 0 éléments. Nombre maximal de 100 éléments.

Contraintes relatives à la longueur des touches : longueur maximale de 256.

Modèle de clé :^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

Contraintes de longueur des valeurs : longueur maximale de 256.

Modèle de valeur : ^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

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

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 :