DescribePredictor - Amazon Forecast
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte Também

O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. Saiba mais

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DescribePredictor

nota

Essa operação só é válida para preditores legados criados com CreatePredictor. Se você não estiver usando um preditor antigo, use DescribeAutoPredictor.

Descreve um preditor criado por meio da operação CreatePredictor.

Importante

O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. Saiba mais

Além de listar as propriedades fornecidas na solicitação CreatePredictor, essa operação inclui as seguintes propriedades:

  • DatasetImportJobArns: os trabalhos de importação do conjunto de dados usados para importar dados de treinamento.

  • AutoMLAlgorithmArns: se o AutoML for executado, os algoritmos avaliados.

  • CreationTime

  • LastModificationTime

  • Status

  • Message: se ocorreu um erro, as informações sobre o erro.

Sintaxe da Solicitação

{
   "PredictorArn": "string"
}

Parâmetros da solicitação

A solicitação aceita os dados a seguir no formato JSON.

PredictorArn

O nome do recurso da Amazon (ARN) do preditor a sobre o qual você deseja obter informações.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

Exigido: Sim

Sintaxe da Resposta

{
   "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" 
   }
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

AlgorithmArn

O nome do recurso da Amazon (ARN) do algoritmo usado no treinamento do modelo.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

AutoMLAlgorithmArns

Quando PerformAutoML é especificado, o ARN do algoritmo selecionado.

Tipo: matriz de strings

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

AutoMLOverrideStrategy
nota

A estratégia de substituição LatencyOptimized do AutoML só está disponível na versão beta privada. Entre em contato com o AWS Support ou com seu gerente de conta para saber mais sobre os privilégios de acesso.

A estratégia do AutoML usada para treinar o preditor. A menos que LatencyOptimized seja especificada, a estratégia do AutoML otimiza a precisão do preditor.

Esse parâmetro só é válido para preditores treinados por meio do AutoML.

Tipo: string

Valores Válidos: LatencyOptimized | AccuracyOptimized

CreationTime

Quando a tarefa de treinamento do modelo foi criada.

Tipo: carimbo de data/hora

DatasetImportJobArns

Uma matriz dos trabalhos ARNs de importação do conjunto de dados usados para importar dados de treinamento para o preditor.

Tipo: matriz de strings

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

EncryptionConfig

Uma chave AWS Key Management Service (KMS) e a função AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.

Tipo: objeto EncryptionConfig

EstimatedTimeRemainingInMinutes

O tempo estimado restante em minutos para a conclusão do trabalho de treinamento do preditor.

Tipo: longo

EvaluationParameters

Usado para substituir os parâmetros de avaliação padrão do algoritmo especificado. O Amazon Forecast avalia um preditor dividindo um conjunto de dados em dados de treinamento e dados de teste. Os parâmetros de avaliação definem como realizar a divisão e o número de iterações.

Tipo: objeto EvaluationParameters

FeaturizationConfig

A configuração de caracterização.

Tipo: objeto FeaturizationConfig

ForecastHorizon

O número de etapas temporais da previsão. O horizonte de predição também é chamado de comprimento da predição.

Tipo: inteiro

ForecastTypes

Os tipos de previsão usados durante o treinamento do preditor. O valor padrão é ["0.1","0.5","0.9"].

Tipo: matriz de strings

Membros da matriz: número mínimo de 1 item. Número máximo de 20 itens.

Restrições de tamanho: o tamanho mínimo é 2. O tamanho máximo é 4.

Padrão: (^0?\.\d\d?$|^mean$)

HPOConfig

Os valores de substituição de hiperparâmetros do algoritmo.

Tipo: objeto HyperParameterTuningJobConfig

InputDataConfig

Descreve o grupo de conjuntos de dados que contém os dados a serem usados para treinar o preditor.

Tipo: objeto InputDataConfig

IsAutoPredictor

Se o preditor foi ou não criado com CreateAutoPredictor.

Tipo: booliano

LastModificationTime

A última vez que o recurso foi modificado. O carimbo de data e hora depende do status do trabalho:

  • CREATE_PENDING: o CreationTime.

  • CREATE_IN_PROGRESS: o carimbo de data e hora atual.

  • CREATE_STOPPING: o carimbo de data e hora atual.

  • CREATE_STOPPED: quando o trabalho parou.

  • ACTIVE ou CREATE_FAILED: quando o trabalho foi concluído ou falhou.

Tipo: Timestamp

Message

Se ocorreu um erro, uma mensagem informativa sobre o erro.

Tipo: string

OptimizationMetric

A métrica de precisão usada para otimizar o preditor.

Tipo: string

Valores Válidos: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PerformAutoML

Se o preditor está configurado para executar o AutoML.

Tipo: booliano

PerformHPO

Se o preditor estiver definido para realizar a otimização de hiperparâmetros (HPO).

Tipo: booliano

PredictorArn

O ARN do preditor.

Tipo: string

Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.

Padrão: ^[a-zA-Z][a-zA-Z0-9_]*

PredictorExecutionDetails

Detalhes sobre o status e os resultados dos backtests realizados para avaliar a precisão do preditor. Você vai especificar o número de backtests a serem executados ao chamar a operação CreatePredictor.

Tipo: objeto PredictorExecutionDetails

PredictorName

O nome do preditor.

Tipo: string

Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.

Padrão: ^[a-zA-Z][a-zA-Z0-9_]*

Status

O status do preditor. Os estados são:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

nota

O Status do preditor deve ser ACTIVE para que seja possível usar o preditor na criação de uma previsão.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

TrainingParameters

Os parâmetros ou as substituições de treinamento padrão selecionados durante o treinamento do modelo. Ao executar o AutoML ou escolher o HPO com CNN-QR ou DeepAR+, os valores otimizados para os hiperparâmetros selecionados são exibidos. Para obter mais informações, consulte Algoritmos do Amazon Forecast.

Tipo: mapa de string para string

Entradas do mapa: número mínimo de 0 itens. Número máximo de 100 itens.

Restrições de tamanho de chave: o tamanho máximo é 256.

Padrão da chave: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

Restrições de tamanho de valor: o tamanho máximo é 256.

Padrão de valor: ^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

Erros

InvalidInputException

Não podemos processar a solicitação porque ela inclui um valor inválido ou um valor que excede o intervalo válido.

Código de status HTTP: 400

ResourceNotFoundException

Não conseguimos encontrar um recurso com esse nome do recurso da Amazon (ARN). Verifique o ARN e tente novamente.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: