本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateExplainability
注意
可解释性仅适用于从 AutoPredictor (CreateAutoPredictor) 生成的预测和预测变量
创建 Amazon Forecast 可解释性。
可解释性可帮助您更好地了解数据集中的属性如何影响预测。Amazon Forecast 使用名为 “影响分数” 的指标来量化每个属性的相对影响,并确定它们是增加还是减少了预测值。
要启用 “Forecast 可解释性”,您的预测变量必须至少包含以下内容之一:相关时间序列、项目元数据或其他数据集,例如假期和天气指数。
CreateExplainability 接受Forecast 变量 ARN 或预测 ARN。要接收数据集中所有时间序列和时间点的汇总影响分数,请提供 Predictor ARN。要获得特定时间序列和时间点的影响分数,请提供Forecast ARN。
CreateExplainability 使用预测变量 ARN
注意
每个预测变量只能有一个可解释性资源。如果您已启用ExplainPredictor
CreateAutoPredictor,则该预测变量已经具有可解释性资源。
提供预测器 ARN 时,以下参数为必需参数:
-
ExplainabilityName
-可解释性的唯一名称。 -
ResourceArn
-预测器的 Arn。 -
TimePointGranularity
-必须设置为 “全部”。 -
TimeSeriesGranularity
-必须设置为 “全部”。
请勿为以下参数指定值:
-
DataSource
-仅在 “特定” 时 TimeSeriesGranularity 有效。 -
Schema
-仅在 “特定” 时 TimeSeriesGranularity 有效。 -
StartDateTime
-仅在 “特定” 时 TimePointGranularity 有效。 -
EndDateTime
-仅在 “特定” 时 TimePointGranularity 有效。
CreateExplainability 使用Forecast ARN
注意
您最多可以指定 50 个时间序列和 500 个时间点。
提供预测器 ARN 时,以下参数为必需参数:
-
ExplainabilityName
-可解释性的唯一名称。 -
ResourceArn
-预报的 Arn。 -
TimePointGranularity
-“全部” 或 “特定”。 -
TimeSeriesGranularity
-“全部” 或 “特定”。
如果您设置 TimeSeriesGranularity 为 “特定”,则还必须提供以下内容:
-
DataSource
-指定您的时间序列的 CSV 文件的 S3 位置。 -
Schema
-架构定义了数据源中列出的属性和属性类型。
如果您设置 TimePointGranularity 为 “特定”,则还必须提供以下内容:
-
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
-
用于创建可解释性的 Predictor 或Forecast 的 Amazon 资源名称(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。
-
最大键长度:128 个 Unicode 字符(采用 UTF-8 格式)。
-
最大值长度:256 个 Unicode 字符(采用 UTF-8 格式)。
-
可接受的字符:所有字母和数字以及可用 UTF-8 表示的字符、可用表示的所有字母、空格。_:/@。 如果您的标记模式针对其他服务和资源使用,则这些服务的字符限制也适用。
-
密钥前缀不能包含或的任何大写或小写组
aws:
合AWS:
。值可以有这个前缀。如果标签值以其前缀aws
为其前缀但键不是,Forecast 会将其视为用户标签,并将计入 50 个标签的限制。仅具有key prefix 的标签aws
不计入每个资源的标签数限制。您无法编辑或删除带此前缀的标签键。
类型:Tag 对象数组
数组成员:最少 0 项。最多 200 项。
必需:否
-
响应语法
{
"ExplainabilityArn": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- ExplainabilityArn
-
可解释性的 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 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: