CreateExplainability

Anmerkung

Die Erklärbarkeit ist nur für Prognosen und Prädiktoren verfügbar, die aus einemAutoPredictor(CreateAutoPredictor)

Erzeugt eine Amazon Forecast-Erklärbarkeit.

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 Impact-Scores, um die relativen Auswirkungen jedes Attributs zu quantifizieren und zu bestimmen, ob sie die Prognosewerte erhöhen oder verringern.

Um die Prognoseerklärbarkeit zu aktivieren, muss Ihr Prädiktor mindestens eine der folgenden Optionen enthalten: verwandte Zeitreihen, Elementmetadaten oder zusätzliche Datensätze wie Feiertage und Wetterindex.

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

CreateExplainabilitymit einem Prädiktor ARN

Anmerkung

Sie können nur eine Erläuterbarkeitsressource pro Prädiktor haben. Wenn Sie bereits aktiviert habenExplainPredictorinCreateAutoPredictorhat dieser Prädiktor bereits eine Erklärbarkeitsressource.

Die folgenden Parameter sind für die Bereitstellung eines Predictor-ARN erforderlich:

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

• ResourceArn- Der Arn des Prädiktors.

• TimePointGranularity- Muss auf „ALL“ festgelegt sein.

• TimeSeriesGranularity- Muss auf „ALL“ festgelegt sein.

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

• DataSource- Nur gültig wennTimeSeriesDie Granularität ist „SPEZIFISCH“.

• Schema- Nur gültig wennTimeSeriesDie Granularität ist „SPEZIFISCH“.

• StartDateTime- Nur gültig wennTimePointDie Granularität ist „SPEZIFISCH“.

• EndDateTime- Nur gültig wennTimePointDie Granularität ist „SPEZIFISCH“.

CreateExplainabilitymit einem Prognose-ARN

Anmerkung

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

Die folgenden Parameter sind für die Bereitstellung eines Predictor-ARN erforderlich:

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

• ResourceArn- Der Arn der Prognose.

• TimePointGranularity- Entweder „ALL“ oder „SPEZIFISCH“.

• TimeSeriesGranularity- Entweder „ALL“ oder „SPEZIFISCH“.

Wenn du einstellstTimeSeriesDarüber hinaus müssen Sie die Granularität auf „SPEZIFISCH“ angeben:

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

• Schema- Das Schema definiert die in der Datenquelle aufgeführten Attribute und Attributtypen.

Wenn du einstellstTimePointDarüber hinaus müssen Sie die Granularität auf „SPEZIFISCH“ angeben:

• StartDateTime- Der erste Zeitstempel im Bereich der Zeitpunkte.

• EndDateTime- Der letzte Zeitstempel im Bereich der Zeitpunkte.

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

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DataSource

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

Typ: DataSource Objekt

Erforderlich Nein

EnableVisualization

Erstellen Sie eine Erklärbarkeitsvisualisierung, die in der AWS-Konsole sichtbar ist.

Type: Boolesch

Erforderlich Nein

EndDateTime

WennTimePointGranularitywird auf gesetztSPECIFICdefinieren Sie den letzten Zeitpunkt für die Erklärbarkeit.

Verwenden Sie das folgende Zeitstempelformat: JJJJ-MM-TTTH:mm:SS (Beispiel: 2015-01-01T 20:00:00)

Type: String (Zeichenfolge)

Längenabhängigkeiten: Maximale Länge beträgt 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.

Type: String (Zeichenfolge)

Längenabhängigkeiten: Mindestlänge 1. Maximale Länge beträgt 63 Zeichen.

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

Erforderlich Ja

ResourceArn

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

Type: String (Zeichenfolge)

Längenabhängigkeiten: Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Erforderlich Ja

Schema

Definiert die Felder eines Datensatzes.

Typ: Schema Objekt

Erforderlich Nein

StartDateTime

WennTimePointGranularitywird auf gesetztSPECIFICdefinieren Sie den ersten Punkt für die Erklärbarkeit.

Verwenden Sie das folgende Zeitstempelformat: JJJJ-MM-TTTH:mm:SS (Beispiel: 2015-01-01T 20:00:00)

Type: String (Zeichenfolge)

Längenabhängigkeiten: Maximale Länge beträgt 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ß-/Kleinschreibung beachtet werden.

Für Tags gelten die folgenden Einschränkungen:

• Jeder Tag muss für jede Ressource eindeutig sein, und jeder Tag muss einen Wert haben.

• Maximale Anzahl von Tags pro Ressource: 50.

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

• Maximale Wertlänge: 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 Charakterbeschränkungen dieser Services.

• Schlüsselpräfixe können keine Groß- oder Kleinbuchstaben-Kombination vonaws:oderAWS:aus. Werte können dieses Präfix haben. Wenn ein Tag-Wert hatawsDa das Präfix aber der Schlüssel nicht der Fall ist, betrachtet Forecast es als Benutzer-Tag und zählt auf das Limit von 50 Tags. Tags mit nur dem key prefix vonawsErzähle nicht als Ihre Tags pro Ressourcenlimit. Sie können Tag-Schlüssel mit diesem Präfix nicht bearbeiten oder löschen.

Type: Array vonTagObjekte

Array-Mitglieder: Minimale Anzahl der Elemente: 0. 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.

Type: String (Zeichenfolge)

Längenabhängigkeiten: Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Fehler

InvalidInputException

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

HTTP-Statuscode: 400

LimitExceededException

Der Limit für die Anzahl an Ressourcen pro Konto wurde überschritten.

HTTP-Statuscode: 400

ResourceAlreadyExistsException

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

HTTP-Statuscode: 400

ResourceInUseException

Die angegebene Ressource wird verwendet.

HTTP-Statuscode: 400

ResourceNotFoundException

Wir können keine Ressource mit diesem Amazon-Ressourcennamen (ARN) finden. Überprüfen Sie den ARN und versuchen Sie es erneut.

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

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

• AWS-Befehlszeilenschnittstelle

• AWS-SDK für .NET

• AWS-SDK für C++

• AWS-SDK for Go

• AWSSDK for Java V2

• AWSSDK fürJavaScript

• AWS SDK für PHP V3

• AWS SDK für Python

• AWS SDK für Ruby V3