CreateExplainability - Amazon Forecast

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateExplainability

nota

La explicabilidad solo está disponible para las previsiones y los predictores generados a partir de un () AutoPredictor CreateAutoPredictor

Crea una explicabilidad de Amazon Forecast

La explicabilidad le ayuda a comprender mejor cómo afectan los atributos de sus conjuntos de datos a la previsión. Amazon Forecast utiliza una métrica llamada puntuaciones de impacto para cuantificar el impacto relativo de cada atributo y determinar si aumentan o disminuyen los valores de previsión.

Para habilitar la explicabilidad de previsión, su predictor debe incluir al menos uno de los siguientes elementos: series temporales relacionadas, metadatos de artículos o conjuntos de datos adicionales, como Días festivos e Índice meteorológico.

CreateExplainability acepta un ARN de Predictor o un ARN de pronóstico. Para recibir puntuaciones de impacto agregadas para todas las series temporales y puntos de tiempo de sus conjuntos de datos, proporcione un ARN de predictor. Para recibir las puntuaciones de impacto de series temporales y puntos de tiempo específicos, proporcione un ARN de previsión.

CreateExplainability con un ARN predictor

nota

Solo puede tener un recurso de Explicabilidad por predictor. Si ya lo ha habilitado ExplainPredictor en CreateAutoPredictor, ese predictor ya tiene un recurso de Explicabilidad.

Se requieren los siguientes parámetros al proporcionar un ARN de predictor:

  • ExplainabilityName: un nombre único para la Explicabilidad.

  • ResourceArn: el ARN del predictor.

  • TimePointGranularity: debe estar configurado en “ALL”.

  • TimeSeriesGranularity: debe estar configurado en “ALL”.

No especifique un valor para los siguientes parámetros:

  • DataSource- Solo es válido cuando TimeSeriesGranularity es «ESPECÍFICO».

  • Schema- Solo es válido cuando TimeSeriesGranularity es «ESPECÍFICO».

  • StartDateTime- Solo es válido cuando TimePointGranularity es «ESPECÍFICO».

  • EndDateTime- Solo es válido cuando TimePointGranularity es «ESPECÍFICO».

CreateExplainability con un ARN de Forecast

nota

Puede especificar un máximo de 50 series temporales y 500 puntos de tiempo.

Se requieren los siguientes parámetros al proporcionar un ARN de predictor:

  • ExplainabilityName: un nombre único para la Explicabilidad.

  • ResourceArn: el ARN de la previsión.

  • TimePointGranularity: “ALL” o “SPECIFIC”.

  • TimeSeriesGranularity: “ALL” o “SPECIFIC”.

Si se establece TimeSeriesGranularity en «ESPECÍFICO», también debe proporcionar lo siguiente:

  • DataSource: la ubicación de S3 del archivo CSV que especifica la serie temporal.

  • Schema: el esquema define los atributos y los tipos de atributos que figuran en el origen de datos.

Si se establece TimePointGranularity en «ESPECÍFICO», también debe proporcionar lo siguiente:

  • StartDateTime: la primera marca temporal del rango de puntos de tiempo.

  • EndDateTime: la última marca temporal del rango de puntos de tiempo.

Sintaxis de la solicitud

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

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

DataSource

La fuente de los datos, una función AWS Identity and Access Management (IAM) que permite a Amazon Forecast acceder a los datos y, opcionalmente, una clave AWS Key Management Service (KMS).

Tipo: objeto DataSource

Obligatorio: no

EnableVisualization

Cree una visualización de explicabilidad que se pueda ver en la consola. AWS

Tipo: Booleano

Obligatorio: no

EndDateTime

Si TimePointGranularity está establecido en SPECIFIC, defina el último punto de tiempo para la Explicabilidad.

Utilice el siguiente formato de marca temporal: aaaa-MM-ddThh:mm:ss (ejemplo: 2015-01-01T20:00:00)

Tipo: cadena

Limitaciones de longitud: longitud máxima de 19 caracteres.

Patrón: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Obligatorio: no

ExplainabilityConfig

Los ajustes de configuración que definen la granularidad de las series temporales y los puntos de tiempo para la Explicabilidad.

Tipo: objeto ExplainabilityConfig

Obligatorio: sí

ExplainabilityName

Un nombre único para la Explicabilidad.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.

Patrón: ^[a-zA-Z][a-zA-Z0-9_]*

Obligatorio: sí

ResourceArn

El nombre de recurso de Amazon (ARN) del predictor o la previsión utilizado para crear la Explicabilidad.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

Obligatorio: sí

Schema

Define los campos de un conjunto de datos.

Tipo: objeto Schema

Obligatorio: no

StartDateTime

Si TimePointGranularity está establecido en SPECIFIC, defina el primer punto de tiempo para la Explicabilidad.

Utilice el siguiente formato de marca temporal: aaaa-MM-ddThh:mm:ss (ejemplo: 2015-01-01T20:00:00)

Tipo: cadena

Limitaciones de longitud: longitud máxima de 19 caracteres.

Patrón: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Obligatorio: no

Tags

Los metadatos opcionales le ayudan a categorizar y organizar sus recursos. Cada etiqueta está formada por una clave y un valor opcional, ambos definidos por el usuario. Las claves y los valores de las etiquetas distinguen entre mayúsculas y minúsculas.

Se aplican las siguientes restricciones a las etiquetas:

  • Para cada recurso, cada clave de etiqueta debe ser única y solo debe tener un valor.

  • Número máximo de etiquetas por recurso: 50

  • Longitud máxima de la clave: 128 caracteres Unicode en UTF-8

  • Longitud máxima del valor: 256 caracteres Unicode en UTF-8

  • Los caracteres aceptados son letras y números, espacios representables en UTF-8 y + - = . _ : / @. Si se utiliza el esquema de etiquetado en otros servicios y recursos, también se aplican las limitaciones de caracteres de dichos servicios.

  • Los prefijos clave no pueden incluir ninguna combinación en mayúsculas o minúsculas de aws: o AWS:. Los valores pueden tener este prefijo. Si el valor de una etiqueta tiene aws como prefijo pero la clave no, Forecast la considera una etiqueta de usuario y se contabilizará en el límite de 50 etiquetas. Las etiquetas que tengan solo el prefijo de clave de aws no cuentan para el límite de etiquetas por recurso. Las claves de etiquetas que tienen este prefijo no se pueden editar ni eliminar.

Tipo: matriz de objetos Tag

Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.

Obligatorio: no

Sintaxis de la respuesta

{ "ExplainabilityArn": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

ExplainabilityArn

El Nombre de recurso de Amazon (ARN) de la Explicabilidad.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

Errores

InvalidInputException

No podemos procesar la solicitud porque incluye un valor no válido o un valor que supera el rango válido.

Código de estado HTTP: 400

LimitExceededException

Se ha superado el límite en el número de recursos por cuenta.

Código de estado HTTP: 400

ResourceAlreadyExistsException

Ya existe un recurso con este nombre. Inténtelo de nuevo con un nombre diferente.

Código de estado HTTP: 400

ResourceInUseException

El recurso especificado está en uso.

Código de estado HTTP: 400

ResourceNotFoundException

No podemos encontrar un recurso con ese nombre de recurso de Amazon (ARN). Compruebe el ARN e inténtelo de nuevo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: