CreateExplainability - Amazon Forecast

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

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

CreateExplainability

注意

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

创建 Amazon Forecast 可解释性。

重要

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

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

要启用预测可解释性,您的预测器必须至少包含以下其中一项:相关时间序列、项目元数据或其他数据集,例如节假日和天气指数。

注意

ARIMA(AutoRegressive 积分移动平均线)、ETS(指数平滑状态空间模型)和NPTS(非参数时间序列)模型不包含外部时间序列数据。因此,即使您包含了其他数据集,这些模型也不会创建可解释性报告。

CreateExplainability 接受 Predictor ARN 或 Forecast。ARN要接收数据集中所有时间序列和时间点的汇总影响分数,请提供 Predictor ARN。要接收特定时间序列和时间点的影响分数,请提供 Forecast ARN。

CreateExplainability 使用预测变量 ARN

注意

每个预测器只能有一个可解释性资源。如果您已在 CreateAutoPredictor 中启用 ExplainPredictor,则该预测器已经具有可解释性资源。

提供预测变量ARN时需要以下参数:

  • ExplainabilityName - 可解释性的唯一名称。

  • ResourceArn - 预测器的 Arn。

  • TimePointGranularity-必须设置为 “ALL”。

  • TimeSeriesGranularity-必须设置为 “ALL”。

以下参数不需要指定值:

  • DataSource-仅当 TimeSeriesGranularity 为 “SPECIFIC” 时有效。

  • Schema-仅当 TimeSeriesGranularity 为 “SPECIFIC” 时有效。

  • StartDateTime-仅当 TimePointGranularity 为 “SPECIFIC” 时有效。

  • EndDateTime-仅当 TimePointGranularity 为 “SPECIFIC” 时有效。

CreateExplainability with a Forecast 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

如果设置 TimePointGranularitySPECIFIC,则定义为可解释性的最后一个时间点。

使用以下时间戳格式:yyyy-mm-dd: mmTHH: 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

用于创建可解释性的预测变量或 Forecast 的 Amazon 资源名称 (ARN)。

类型:字符串

长度约束:最大长度为 256。

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

必需:是

Schema

定义数据集的字段。

类型:Schema 对象

必需:否

StartDateTime

如果设置 TimePointGranularitySPECIFIC,则定义为可解释性的第一个点。

使用以下时间戳格式:yyyy-mm-dd: mmTHH: 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 个标签的限制。仅具有 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

另请参阅

有关API在一种特定语言中使用此功能的更多信息 AWS SDKs,请参阅以下内容: