CreateExplainability - Amazon Forecast
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CreateExplainability

Anmerkung

Erklärbarkeit ist nur für Prognosen und Prädiktoren verfügbar, die aus einer AutoPredictor (CreateAutoPredictor) generiert wurden

Erstellt eine Erklärbarkeit von Amazon Forecast.

Die Erklärbarkeit hilft Ihnen besser zu verstehen, wie sich die Attribute in Ihren Datensätzen auf die Prognose auswirken. Amazon Forecast verwendet eine Metrik namens Auswirkungswerte, um die relativen Auswirkungen jedes Attributs zu quantifizieren und zu bestimmen, ob sie die Prognosewerte erhöhen oder verringern.

Um die Erklärbarkeit von Prognosen zu aktivieren, muss Ihr Prädiktor mindestens eine der folgenden Optionen enthalten: verwandte Zeitreihen, Elementmetadaten oder zusätzliche Datensätze wie Feiertage und den Bol Index.

CreateExplainability akzeptiert entweder einen Prädiktor-ARN oder einen Prognose-ARN. Um aggregierte Auswirkungswerte für alle Zeitreihen und Zeitpunkte in Ihren Datensätzen zu erhalten, geben Sie einen Prädiktor-ARN an. Um Auswirkungswerte für bestimmte Zeitreihen und Zeitpunkte zu erhalten, geben Sie einen Prognose-ARN an.

CreateExplainability mit einem Predictor-ARN

Anmerkung

Sie können nur eine Erklärbarkeitsressource pro Prädiktor haben. Wenn Sie bereits ExplainPredictor in aktiviert habenCreateAutoPredictor, verfügt dieser Prädiktor bereits über eine Erklärbarkeitsressource.

Die folgenden Parameter sind erforderlich, wenn Sie einen Predictor-ARN angeben:

  • ExplainabilityName – Ein eindeutiger Name für die Erklärbarkeit.

  • ResourceArn – Der Arn des Prädiktors.

  • TimePointGranularity – Muss auf „ALL“ gesetzt sein.

  • TimeSeriesGranularity – Muss auf „ALL“ gesetzt sein.

Geben Sie keinen Wert für die folgenden Parameter an:

  • DataSource – Nur gültig, wenn „SPECIFIC“ TimeSeriesGranularity ist.

  • Schema – Nur gültig, wenn „SPECIFIC“ TimeSeriesGranularity ist.

  • StartDateTime – Nur gültig, wenn „SPECIFIC“ TimePointGranularity ist.

  • EndDateTime – Nur gültig, wenn „SPECIFIC“ TimePointGranularity ist.

CreateExplainability mit einem Prognose-ARN

Anmerkung

Sie können maximal 50 Zeitreihen und 500 Zeitpunkte angeben.

Die folgenden Parameter sind erforderlich, wenn Sie einen Predictor-ARN angeben:

  • ExplainabilityName – Ein eindeutiger Name für die Erklärbarkeit.

  • ResourceArn – Der Arn der Prognose.

  • TimePointGranularity – Entweder „ALL“ oder „SPECIFIC“.

  • TimeSeriesGranularity – Entweder „ALL“ oder „SPECIFIC“.

Wenn Sie TimeSeriesGranularity auf „SPECIFIC“ setzen, müssen Sie auch Folgendes angeben:

  • DataSource – Der S3-Speicherort der CSV-Datei, die Ihre Zeitreihe angibt.

  • Schema – Das Schema definiert die Attribute und Attributtypen, die in der Datenquelle aufgeführt sind.

Wenn Sie TimePointGranularity auf „SPECIFIC“ setzen, müssen Sie auch Folgendes angeben:

  • StartDateTime – Der erste Zeitstempel im Zeitbereich.

  • EndDateTime – Der letzte Zeitstempel im Zeitbereich.

Anforderungssyntax

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

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DataSource

Die Quelle Ihrer Daten, eine AWS Identity and Access Management (IAM)-Rolle, die es Amazon Forecast ermöglicht, auf die Daten zuzugreifen, und optional ein AWS Key Management Service (KMS)-Schlüssel.

Typ: DataSource Objekt

Erforderlich: Nein

EnableVisualization

Erstellen Sie eine Erklärbarkeitsvisualisierung, die in der AWS Konsole angezeigt werden kann.

Typ: Boolesch

Erforderlich: Nein

EndDateTime

Wenn auf gesetzt TimePointGranularity istSPECIFIC, definieren Sie den letzten Zeitpunkt für die Erklärbarkeit.

Verwenden Sie das folgende Zeitstempelformat: yyyy-MM-ddTHH :mm:ss (Beispiel: 2015-01-01T20:00:00)

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 19.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Erforderlich: Nein

ExplainabilityConfig

Die Konfigurationseinstellungen, die die Granularität von Zeitreihen und Zeitpunkten für die Erklärbarkeit definieren.

Typ: ExplainabilityConfig Objekt

Erforderlich: Ja

ExplainabilityName

Ein eindeutiger Name für die Erklärbarkeit.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 63 Zeichen.

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

Erforderlich: Ja

ResourceArn

Der Amazon-Ressourcenname (ARN) des Prädiktors oder der Prognose, der zum Erstellen der Erklärbarkeit verwendet wurde.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

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

Erforderlich: Ja

Schema

Definiert die Felder eines Datensatzes.

Typ: Schema Objekt

Erforderlich: Nein

StartDateTime

Wenn auf gesetzt TimePointGranularity istSPECIFIC, definieren Sie den ersten Punkt für die Erklärbarkeit.

Verwenden Sie das folgende Zeitstempelformat: yyyy-MM-ddTHH :mm:ss (Beispiel: 2015-01-01T20:00:00)

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 19.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Erforderlich: Nein

Tags

Optionale Metadaten, die Ihnen bei der Kategorisierung und Organisation Ihrer -Ressourcen helfen. Jeder Tag (Markierung) besteht aus einem Schlüssel und einem optionalen Wert, beides können Sie bestimmen. Bei Tag-Schlüsseln und -Werten muss die Groß- und Kleinschreibung beachtet werden.

Für Tags gelten die folgenden Einschränkungen:

  • Für jede Ressource muss jeder Tag-Schlüssel eindeutig sein und jeder Tag-Schlüssel muss einen Wert haben.

  • Maximale Anzahl von Tags pro Ressource: 50.

  • Maximale Schlüssellänge: 128 Unicode-Zeichen in UTF-8.

  • Maximale Länge des Wertes: 256 Unicode-Zeichen in UTF-8.

  • Akzeptierte Zeichen: alle Buchstaben und Zahlen, Leerzeichen, die in UTF-8 darstellbar sind, und + - = . _ : / @. Wenn Ihr Markierungsschema für andere Services und Ressourcen verwendet wird, gelten auch die Zeichenbeschränkungen dieser Services.

  • Schlüsselpräfixe dürfen keine Kombination aus Groß- und Kleinbuchstaben von aws: oder enthaltenAWS:. Werte können dieses Präfix haben. Wenn ein Tag-Wert aws als Präfix hat, der Schlüssel jedoch nicht, betrachtet Forecast ihn als Benutzer-Tag und wird auf das Limit von 50 Tags angerechnet. Tags mit nur dem Schlüsselpräfix aws werden nicht auf Ihre Tags pro Ressourcenlimit angerechnet. Sie können Tag-Schlüssel mit diesem Präfix nicht bearbeiten oder löschen.

Typ: Array von Tag-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 200 Elemente.

Erforderlich: Nein

Antwortsyntax

{
   "ExplainabilityArn": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

ExplainabilityArn

Der Amazon-Ressourcenname (ARN) der Erklärbarkeit.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

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

Fehler

InvalidInputException

Wir können die Anforderung nicht verarbeiten, da sie einen ungültigen Wert oder einen Wert enthält, der den gültigen Bereich überschreitet.

HTTP Status Code: 400

LimitExceededException

Das Limit für die Anzahl der Ressourcen pro Konto wurde überschritten.

HTTP Status Code: 400

ResourceAlreadyExistsException

Es gibt bereits eine Ressource mit diesem Namen. Versuchen Sie es erneut mit einem anderen Namen.

HTTP Status Code: 400

ResourceInUseException

Die angegebene Ressource wird verwendet.

HTTP Status Code: 400

ResourceNotFoundException

Es ist nicht möglich, eine Ressource mit diesem Amazon-Ressourcennamen (ARN) zu finden. Überprüfen Sie den ARN und versuchen Sie es erneut.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: