CreateExplainability - Amazon Forecast

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateExplainability

注意

可解释性仅适用于从中生成的预测和预测变量 AutoPredictor (CreateAutoPredictor)

创建Amazon Forecast 可解释性。

Explainability 可帮助您更好地了解数据集中的属性如何影响预测。Amazon Forecast 使用名为 “影响分数” 的指标来量化每个属性的相对影响,并确定它们是增加还是减少预测值。

要启用 Forecast Explainability,您的预测变量必须至少包含以下内容之一:相关时间序列、项目元数据或其他数据集,如假日和天气指数。

CreateExplainability 接受预测变量 ARN 或Forecast ARN。要获得数据集中所有时间序列和时间点的汇总影响分数,请提供预测器 ARN。要获得特定时间序列和时间点的影响分数,请提供Forecast ARN。

CreateExplainability 使用预测变量 ARN

注意

每个预测变量只能有一个可解释资源。如果您已启用ExplainPredictorCreateAutoPredictor,该预测变量已经有了可解释性资源。

以下参数为必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": [ { "AttributeCategory": "string", "AttributeName": "string", "AttributeType": "string" } ] }, "StartDateTime": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

请求参数

请求接受采用 JSON 格式的以下数据。

DataSource

您的数据来源,允许 Amazon Forest (IAM) 角色,允许 AAmazon Forecast Forest 访问数据,以及一个 AWS Key Management Service (KMS) 角色,以及 Amazon Forest (KMS) 角色和 AWS 密钥。

类型: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

用于定义 Explainability 的时间序列和时间点的粒度的配置设置。

类型:ExplainabilityConfig 对象

以下内容:是

ExplainabilityName

可解释的唯一名称。

类型: 字符串

长度约束:最小长度为 1。最大长度为 63。

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

以下内容:是

ResourceArn

用于创建可解释性的 Amazon ResourcForecast 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 字符。

  • 最大值长度:UTF-8 中有 256 个 Unicode 字符。

  • 可用的字符:可用 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 的更多信息,请参阅以下内容: