CreateExplainability - Amazon Forecast

Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。進一步了解」

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

CreateExplainability

注意

可解釋性僅適用於從 AutoPredictor 產生的預測和預測器 (CreateAutoPredictor)

建立 Amazon Forecast 可解釋性。

重要

Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。進一步了解」

可解釋性可協助您更加了解資料集中的屬性如何影響預測。Amazon Forecast 使用稱為影響分數的指標來量化每個屬性的相對影響,並判斷它們是否增加或減少預測值。

若要啟用預測可解釋性,您的預測器必須至少包含下列其中一項:相關時間序列、項目中繼資料或假日和天氣索引等其他資料集。

注意

ARIMA (AutoRegressive Integrated Moving Average)、ETS (指數平滑狀態空間模型) 和 NPTS (非參數時間序列) 模型不包含外部時間序列資料。因此,即使您包含其他資料集,這些模型也不會建立可解釋性報告。

CreateExplainability 接受預測器 ARN 或預測 ARN。若要接收資料集中所有時間序列和時間點的彙總影響分數,請提供預測器 ARN。若要接收特定時間序列和時間點的影響分數,請提供預測 ARN。

使用預測器 ARN 建立CreateExplainability

注意

每個預測器只能有一個可解釋性資源。如果您已ExplainPredictor在 中啟用 CreateAutoPredictor,則該預測器已有可解釋性資源。

提供預測器 ARN 時,需要下列參數:

  • ExplainabilityName - 可解釋性的唯一名稱。

  • ResourceArn - 預測器的 Arn。

  • TimePointGranularity - 必須設定為「ALL」。

  • TimeSeriesGranularity - 必須設定為「ALL」。

請勿為下列參數指定值:

  • DataSource - 僅在 TimeSeriesGranularity 為「SPECIFIC」時才有效。

  • Schema - 僅在 TimeSeriesGranularity 為「SPECIFIC」時才有效。

  • StartDateTime - 只有在 TimePointGranularity 為「SPECIFIC」時才有效。

  • EndDateTime - 只有在 TimePointGranularity 為「SPECIFIC」時才有效。

CreateExplainability 與預測 ARN

注意

您最多可以指定 50 個時間序列和 500 個時間點。

提供預測器 ARN 時,需要下列參數:

  • ExplainabilityName - 可解釋性的唯一名稱。

  • ResourceArn - 預測的 Arn。

  • TimePointGranularity - “ALL” 或 “SPECIFIC”。

  • TimeSeriesGranularity - “ALL” 或 “SPECIFIC”。

如果您將 TimeSeriesGranularity 設定為「SPECIFIC」,您還必須提供下列項目:

  • DataSource - CSV 檔案的 S3 位置,指定您的時間序列。

  • Schema - 結構描述定義資料來源中列出的屬性和屬性類型。

如果您將 TimePointGranularity 設定為「SPECIFIC」,您還必須提供下列項目:

  • StartDateTime - 時間點範圍內的第一個時間戳記。

  • EndDateTime - 時間點範圍內的最後一個時間戳記。

請求語法

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

請求參數

請求接受採用 JSON 格式的下列資料。

DataSource

資料來源,允許 Amazon Forecast 存取資料的 AWS Identity and Access Management (IAM) 角色,以及選擇性的 AWS Key Management Service (KMS) 金鑰。

類型:DataSource 物件

必要:否

EnableVisualization

建立可在 AWS 主控台中檢視的可解釋性視覺化。

類型:布林值

必要:否

EndDateTime

如果 TimePointGranularity 設定為 SPECIFIC,請定義可解釋性的最後時間點。

使用以下時間戳記格式:yyyy-MM-ddTHH:mm:ss (範例:2015-01-01T20:00:00)

類型:字串

長度限制:長度上限為 19。

模式:^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

必要:否

ExplainabilityConfig

定義可解釋性時間序列和時間點精細性的組態設定。

類型:ExplainabilityConfig 物件

必要:是

ExplainabilityName

可解釋性的唯一名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 63。

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

必要:是

ResourceArn

用於建立可解釋性的預測器或預測的 Amazon Resource Name (ARN)。

類型:字串

長度限制:長度上限為 256。

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

必要:是

Schema

定義資料集的欄位。

類型:Schema 物件

必要:否

StartDateTime

如果 TimePointGranularity 設定為 SPECIFIC,請定義可解釋性的第一個點。

使用以下時間戳記格式:yyyy-MM-ddTHH:mm:ss (範例:2015-01-01T20:00:00)

類型:字串

長度限制:長度上限為 19。

模式:^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

必要:否

Tags

選用中繼資料可協助您分類和組織資源。每個標籤皆包含由您定義的一個金鑰與一個選用值。標籤鍵與值皆區分大小寫。

以下限制適用於標籤:

  • 對於每個資源,每個標籤索引鍵必須是唯一的,且每個標籤索引鍵必須有一個值。

  • 每個資源的標籤數量上限:50。

  • 金鑰長度上限:UTF-8 128 個 Unicode 字元。

  • 最大值長度:256 個 UTF-8 Unicode 字元。

  • 接受的字元:所有字母和數字、以 UTF-8 表示的空格,以及 + - = 。_ :/ @。 如果您的標記結構描述用於其他 服務和資源,則這些服務的角色限制也適用。

  • 金鑰字首不能包含 或 的任何大寫aws:或小寫組合AWS:。值可以具有此字首。如果標籤值有 aws做為其字首,但金鑰沒有,預測會將其視為使用者標籤,並計入 50 個標籤的限制。僅具有 金鑰字首的標籤aws不會計入每個資源限制的標籤。您無法編輯或刪除具有此字首的標籤索引鍵。

類型:Tag 物件陣列

陣列成員:項目數下限為 0。項目數上限為 200。

必要:否

回應語法

{ "ExplainabilityArn": "string" }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

ExplainabilityArn

可解釋性的 Amazon Resource Name (ARN)。

類型:字串

長度限制:長度上限為 256。

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

錯誤

InvalidInputException

我們無法處理請求,因為它包含無效值或超過有效範圍的值。

HTTP 狀態碼:400

LimitExceededException

已超過每個帳戶的資源數量限制。

HTTP 狀態碼:400

ResourceAlreadyExistsException

已有具有此名稱的資源。請用不同的名稱再試一次。

HTTP 狀態碼:400

ResourceInUseException

指定的資源正在使用中。

HTTP 狀態碼:400

ResourceNotFoundException

我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN,然後再試一次。

HTTP 狀態碼:400

另請參閱

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: