翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateExplainability
注記
Explainability は、 AutoPredictor （CreateAutoPredictor) から生成された Forecasts と Predictor でのみ使用できます。
Amazon Forecast Explainability を作成します。
Explainability は、データセットの属性が予測にどのように影響するかをよりよく理解するのに役立ちます。Amazon Forecast は、Impact スコアと呼ばれるメトリクスを使用して、各属性の相対的な影響を定量化し、それらが予測値を増加させるか減少させるかを決定します。
Forecast Explainability を有効にするには、関連する時系列、項目メタデータ、または祝祭日や Weather Index などの追加のデータセットの少なくとも 1 つを予測子に含める必要があります。
CreateExplainability は、予測子 ARN または予測 ARN のいずれかを受け入れます。データセット内のすべての時系列と時間ポイントの集計された Impact スコアを受け取るには、予測子 ARN を入力します。特定の時系列および時間ポイントの Impact スコアを受け取るには、予測 ARN を入力します。
CreateExplainability 予測子 ARN を使用する
注記
予測子ごとに持つことができる Explainability リソースは 1 つだけです。CreateAutoPredictor で ExplainPredictor を既に有効にしている場合、その予測子には既に Explainability リソースがあります。
Predictor ARN を入力する場合は、次のパラメータが必要です。
-
ExplainabilityName- Explainability の一意の名前。 -
ResourceArn- 予測子の Arn。 -
TimePointGranularity- 「ALL」に設定する必要があります。 -
TimeSeriesGranularity- 「ALL」に設定する必要があります。
次のパラメータには値を指定しないでください。
-
DataSource- TimeSeriesGranularity が「SPECIFIC」の場合にのみ有効です。 -
Schema- TimeSeriesGranularity が「SPECIFIC」の場合にのみ有効です。 -
StartDateTime- TimePointGranularity が「SPECIFIC」の場合にのみ有効です。 -
EndDateTime- TimePointGranularity が「SPECIFIC」の場合にのみ有効です。
CreateExplainability Forecast ARN を使用した
注記
最大 50 の時系列と 500 の時間ポイントを指定できます。
Predictor ARN を入力する場合は、次のパラメータが必要です。
-
ExplainabilityName- Explainability の一意の名前。 -
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 コンソール内で表示可能な Explainability ビジュアライゼーションを作成します。
型: ブール値
必須: いいえ
- EndDateTime
-
TimePointGranularityがSPECIFICに設定されている場合、Explainability の最後の時間ポイントを定義します。次のタイムスタンプ形式を使用します: yyyy-MM-ddTHH:mm:ss (例: 2015-01-01T20:00:00)
型: 文字列
長さの制限: 最大長は 19。
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$必須: いいえ
- ExplainabilityConfig
-
Explainability の時系列と時間ポイントの粒度を定義する構成設定。
型: ExplainabilityConfig オブジェクト
必須: はい
- ExplainabilityName
-
Explainability の一意の名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 63 です。
Pattern:
^[a-zA-Z][a-zA-Z0-9_]*必須：はい
- ResourceArn
-
Explainability の作成に使用される予測子または予測の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+必須：はい
- Schema
-
データセットのフィールドを定義します。
タイプ：Schema オブジェクト
必須: いいえ
- StartDateTime
-
TimePointGranularityがSPECIFICに設定されている場合、Explainability の最初のポイントを定義します。次のタイムスタンプ形式を使用します: yyyy-MM-ddTHH:mm:ss (例: 2015-01-01T20:00:00)
型: 文字列
長さの制限: 最大長は 19。
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$必須: いいえ
- Tags
-
リソースの分類と整理に役立つオプションのメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で設定されており、どちらもお客様側が定義します。タグのキーと値では、大文字と小文字が区別されます。
タグには以下の制限があります。
-
タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
-
リソースあたりのタグの最大数: 50。
-
キーの最大長 128 文字 (Unicode) (UTF-8)。
-
値の最大長: 256 文字 (Unicode) (UTF-8)。
-
使用可能な文字: すべての文字と数字、UTF-8 で表現可能なスペース、および + - = 。_ : / @。タグ付けスキーマが他のサービスやリソースで使用されている場合、それらのサービスの文字制限も適用されます。
-
キープレフィックスには、
aws:またはAWS:の大文字または小文字の組み合わせを含めることはできません。値にはこのプレフィックスを付けることができます。タグ値にはawsがプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。awsのキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。このプレフィックスが含まれるタグキーを編集したり削除することはできません。
タイプ：Tag オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: いいえ
-
レスポンスの構文
{
"ExplainabilityArn": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ExplainabilityArn
-
Explainability の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+
エラー
- InvalidInputException
-
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。
HTTP ステータスコード：400
- LimitExceededException
-
アカウントあたりのリソース数の制限を超えました。
HTTP ステータスコード：400
- ResourceAlreadyExistsException
-
この名前のリソースは既に存在します。別の名前で再試行してください。
HTTP ステータスコード：400
- ResourceInUseException
-
指定されたリソースは使用中です。
HTTP ステータスコード：400
- ResourceNotFoundException
-
その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
