GetIntent - Amazon Lex V1
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Wenn Sie Amazon Lex V2 verwenden, lesen Sie stattdessen das Amazon Lex V2-Handbuch.

 

Wenn Sie Amazon Lex V1 verwenden, empfehlen wir, Ihre Bots auf Amazon Lex V2 zu aktualisieren. Wir fügen V1 keine neuen Funktionen mehr hinzu und empfehlen dringend, V2 für alle neuen Bots zu verwenden.

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.

GetIntent

Gibt Informationen über eine Absicht zurück. Zusätzlich zum Namen der Absicht müssen Sie die Version der Absicht angeben.

Diese Operation erfordert zur Ausführung der lex:GetIntent-Aktion Berechtigungen.

Anforderungssyntax

GET /intents/name/versions/version HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

name

Der Name der Absicht. Der Name berücksichtigt Groß- und Kleinschreibung.

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

Pattern: ^([A-Za-z]_?)+$

Erforderlich: Ja

version

Die Version der Absicht.

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

Pattern: \$LATEST|[0-9]+

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "lastUpdatedDate": number,
   "name": "string",
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ],
   "version": "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.

checksum

Prüfsumme der Absicht.

Typ: Zeichenfolge

conclusionStatement

Nachdem die im fulfillmentActivity Element angegebene Lambda-Funktion die Absicht erfüllt hat, übermittelt Amazon Lex diese Aussage an den Benutzer.

Typ: Statement Objekt

confirmationPrompt

Falls im Bot definiert, verwendet Amazon Lex die Aufforderung, um die Absicht zu bestätigen, bevor die Anfrage des Benutzers bearbeitet wird. Weitere Informationen finden Sie unter PutIntent.

Typ: Prompt Objekt

createdDate

Das Datum, an dem die Absicht erstellt wurde.

Typ: Zeitstempel

description

Eine Beschreibung der Absicht.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Höchstlänge = 200 Zeichen.

dialogCodeHook

Falls im Bot definiert, ruft Amazon Amazon Lex diese Lambda-Funktion für jede Benutzereingabe auf. Weitere Informationen finden Sie unter PutIntent.

Typ: CodeHook Objekt

followUpPrompt

Falls im Bot definiert, verwendet Amazon Lex diese Aufforderung, um zusätzliche Benutzeraktivitäten anzufordern, nachdem die Absicht erfüllt wurde. Weitere Informationen finden Sie unter PutIntent.

Typ: FollowUpPrompt Objekt

fulfillmentActivity

Beschreibt, wie die Absicht erfüllt wird. Weitere Informationen finden Sie unter PutIntent.

Typ: FulfillmentActivity Objekt

inputContexts

Ein Array von InputContext Objekten, das die Kontexte auflistet, die aktiv sein müssen, damit Amazon Lex die Absicht in einer Konversation mit dem Benutzer auswählen kann.

Typ: Array von InputContext-Objekten

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

kendraConfiguration

Konfigurationsinformationen, falls vorhanden, um mit der AMAZON.KendraSearchIntent Absicht eine Verbindung zu Amazon Kendra Kendra-Index herzustellen.

Typ: KendraConfiguration Objekt

lastUpdatedDate

Das Datum, an dem die Absicht aktualisiert wurde. Wenn Sie eine Ressource erstellen, stimmen das Erstellungsdatum und das Datum der letzten Aktualisierung überein.

Typ: Zeitstempel

name

Der Name der Absicht.

Typ: Zeichenfolge

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

Pattern: ^([A-Za-z]_?)+$

outputContexts

Eine Reihe von OutputContext Objekten, die die Kontexte auflistet, die die Absicht aktiviert, wenn die Absicht erfüllt ist.

Typ: Array von OutputContext-Objekten

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

parentIntentSignature

Ein eindeutiger Bezeichner für eine integrierte Absicht.

Typ: Zeichenfolge

rejectionStatement

Wenn der Benutzer die in definierte Frage mit „Nein“ beantwortetconfirmationPrompt, antwortet Amazon Lex mit dieser Erklärung, um zu bestätigen, dass die Absicht storniert wurde.

Typ: Statement Objekt

sampleUtterances

Eine Reihe von Beispieläußerungen, die für die Absicht konfiguriert wurden.

Typ: Zeichenfolge-Array

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Maximale Anzahl von 1500 Elementen.

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Höchstlänge = 200 Zeichen.

slots

Eine Reihe von Intent-Slots, die für die Absicht konfiguriert sind.

Typ: Array von Slot-Objekten

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

version

Die Version der Absicht.

Typ: Zeichenfolge

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

Pattern: \$LATEST|[0-9]+

Fehler

BadRequestException

Die Anfrage ist nicht wohlformuliert. Beispielsweise ist ein Wert ungültig oder ein erforderliches Feld fehlt. Überprüfen Sie die Feldwerte und versuchen Sie es erneut.

HTTP Status Code: 400

InternalFailureException

Ein interner Amazon Lex Lex-Fehler ist aufgetreten. Versuchen Sie es erneut.

HTTP Status Code: 500

LimitExceededException

Die Anfrage hat ein Limit überschritten. Versuchen Sie es erneut.

HTTP-Statuscode: 429

NotFoundException

Die in der Anfrage angegebene Ressource wurde nicht gefunden. Überprüfen Sie die Ressource und versuchen Sie es erneut.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: