View a markdown version of this page

DescribePredictor - Amazon Forecast
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Amazon Forecast tidak lagi tersedia untuk pelanggan baru. Pelanggan Amazon Forecast yang ada dapat terus menggunakan layanan seperti biasa. Pelajari lebih lanjut”

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

DescribePredictor

catatan

Operasi ini hanya berlaku untuk prediktor lama yang dibuat dengan CreatePredictor. Jika Anda tidak menggunakan prediktor lama, gunakanDescribeAutoPredictor.

Menjelaskan prediktor yang dibuat menggunakan CreatePredictor operasi.

penting

Amazon Forecast tidak lagi tersedia untuk pelanggan baru. Pelanggan Amazon Forecast yang ada dapat terus menggunakan layanan seperti biasa. Pelajari lebih lanjut”

Selain mencantumkan properti yang disediakan dalam CreatePredictor permintaan, operasi ini mencantumkan properti berikut:

  • DatasetImportJobArns- Pekerjaan impor dataset yang digunakan untuk mengimpor data pelatihan.

  • AutoMLAlgorithmArns- Jika AutoML dilakukan, algoritma yang dievaluasi.

  • CreationTime

  • LastModificationTime

  • Status

  • Message- Jika terjadi kesalahan, informasi tentang kesalahan tersebut.

Sintaksis Permintaan

{
   "PredictorArn": "string"
}

Parameter Permintaan

Permintaan menerima data berikut dalam format JSON.

PredictorArn

Nama Sumber Daya Amazon (ARN) dari prediktor yang ingin Anda informasikan.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):forecast:.*:.*:.+

Diperlukan: Ya

Sintaksis Respons

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

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

AlgorithmArn

Nama Sumber Daya Amazon (ARN) dari algoritma yang digunakan untuk pelatihan model.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):forecast:.*:.*:.+

AutoMLAlgorithmArns

Ketika PerformAutoML ditentukan, ARN dari algoritma yang dipilih.

Tipe: Array string

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):forecast:.*:.*:.+

AutoMLOverrideStrategy
catatan

Strategi LatencyOptimized penggantian AutoML hanya tersedia dalam versi beta pribadi. Hubun AWS gi Dukungan atau manajer akun Anda untuk mempelajari lebih lanjut tentang hak akses.

Strategi AutoML digunakan untuk melatih prediktor. Kecu LatencyOptimized ali ditentukan, strategi AutoML mengoptimalkan akurasi prediktor.

Parameter ini hanya berlaku untuk prediktor yang dilatih menggunakan AutoML.

Tipe: String

Nilai yang Valid: LatencyOptimized | AccuracyOptimized

CreationTime

Ketika tugas pelatihan model dibuat.

Tipe: Timestamp

DatasetImportJobArns

Array ARN dari pekerjaan impor dataset yang digunakan untuk mengimpor data pelatihan untuk prediktor.

Tipe: Array string

Batasan Panjang: Panjang maksimum 256.

Pola: arn:([a-z\d-]+):forecast:.*:.*:.+

EncryptionConfig

K AWS Key Management Service unci (KMS) dan peran AWS Identity and Access Management (IAM) yang dapat diasumsikan oleh Amazon Forecast untuk mengakses kunci.

Tipe: Objek EncryptionConfig

EstimatedTimeRemainingInMinutes

Perkiraan waktu yang tersisa dalam menit untuk menyelesaikan pekerjaan pelatihan prediktor.

Tipe: Long

EvaluationParameters

Digunakan untuk mengganti parameter evaluasi default dari algoritma yang ditentukan. Amazon Forecast mengevaluasi prediktor dengan membagi dataset menjadi data pelatihan dan data pengujian. Parameter evaluasi menentukan bagaimana melakukan pemisahan dan jumlah iterasi.

Tipe: Objek EvaluationParameters

FeaturizationConfig

Konfigurasi fiturisasi.

Tipe: Objek FeaturizationConfig

ForecastHorizon

Jumlah langkah waktu dari perkiraan. Cakrawala perkiraan juga disebut panjang prediksi.

Jenis: Integer

ForecastTypes

Jenis prakiraan yang digunakan selama pelatihan prediktor. Nilai default adalah ["0.1","0.5","0.9"]

Tipe: Array string

Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 20 item.

Batasan Panjang: Panjang minimum 2. Panjang maksimum 4.

Pola: (^0?\.\d\d?$|^mean$)

HPOConfig

Hyperparameter mengganti nilai-nilai untuk algoritma.

Tipe: Objek HyperParameterTuningJobConfig

InputDataConfig

Menjelaskan grup dataset yang berisi data yang akan digunakan untuk melatih prediktor.

Tipe: Objek InputDataConfig

IsAutoPredictor

Apakah prediktor dibuat denganCreateAutoPredictor.

Jenis: Boolean

LastModificationTime

Terakhir kali sumber daya dimodifikasi. Stempel waktu tergantung pada status pekerjaan:

  • CREATE_PENDING- ItuCreationTime.

  • CREATE_IN_PROGRESS- Stempel waktu saat ini.

  • CREATE_STOPPING- Stempel waktu saat ini.

  • CREATE_STOPPED- Saat pekerjaan berhenti.

  • ACTIVEatau CREATE_FAILED - Ketika pekerjaan selesai atau gagal.

Tipe: Timestamp

Message

Jika terjadi kesalahan, pesan informasi tentang kesalahan tersebut.

Tipe: String

OptimizationMetric

Metrik akurasi yang digunakan untuk mengoptimalkan prediktor.

Tipe: String

Nilai yang Valid: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PerformAutoML

Apakah prediktor diatur untuk melakukan AutoML.

Jenis: Boolean

PerformHPO

Apakah prediktor diatur untuk melakukan optimasi hyperparameter (HPO).

Jenis: Boolean

PredictorArn

ARN dari prediktor.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.

Pola: ^[a-zA-Z][a-zA-Z0-9_]*

PredictorExecutionDetails

Rincian tentang status dan hasil backtest yang dilakukan untuk mengevaluasi keakuratan prediktor. Anda menentukan jumlah backtest yang akan dilakukan saat Anda memanggil CreatePredictor operasi.

Tipe: Objek PredictorExecutionDetails

PredictorName

Nama prediktor.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.

Pola: ^[a-zA-Z][a-zA-Z0-9_]*

Status

Status prediktor. Negara-negara meliputi:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

catatan

P Status rediktor harus ada ACTIVE sebelum Anda dapat menggunakan prediktor untuk membuat perkiraan.

Tipe: String

Batasan Panjang: Panjang maksimum 256.

TrainingParameters

Parameter pelatihan default atau penggantian yang dipilih selama pelatihan model. Saat menjalankan AutoML atau memilih HPO dengan CNN-QR atau DeePar+, nilai yang dioptimalkan untuk hyperparameter yang dipilih dikembalikan. Untuk informasi selengkapnya, lihat Algoritma Amazon Forecast.

Tipe: Peta string ke string

Entri Peta: Jumlah minimum 0 item. Jumlah maksimum 100 item.

Batasan Panjang Kunci: Panjang maksimum 256.

Pola Kunci: ^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

Batasan Panjang Nilai: Panjang maksimum 256.

Pola nilai: ^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

Kesalahan

InvalidInputException

Kami tidak dapat memproses permintaan karena menyertakan nilai yang tidak valid atau nilai yang melebihi rentang yang valid.

Kode Status HTTP: 400

ResourceNotFoundException

Kami tidak dapat menemukan sumber daya dengan Nama Sumber Daya Amazon (ARN) itu. Periksa ARN dan coba lagi.

Kode Status HTTP: 400

Lihat Juga

Untuk informasi selengkapnya tentang menggunakan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: