GetBot - 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.

GetBot

Gibt Metadateninformationen für einen bestimmten Bot zurück. Sie müssen den Bot-Namen und die Bot-Version oder den Alias angeben.

Diese Operation erfordert Berechtigungen für die Aktion lex:GetBot.

Anforderungssyntax

GET /bots/name/versions/versionoralias HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

name

Der Name des Bots. Der Name berücksichtigt Groß- und Kleinschreibung.

Längenbeschränkungen: Mindestlänge von 2. Maximale Länge = 50 Zeichen.

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

Erforderlich: Ja

versionoralias

Die Version oder der Alias des Bots.

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "nluIntentConfidenceThreshold": number,
   "status": "string",
   "version": "string",
   "voiceId": "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.

abortStatement

Die Nachricht, die Amazon Lex zurückgibt, wenn der Benutzer beschließt, die Konversation zu beenden, ohne sie abzuschließen. Weitere Informationen finden Sie unter PutBot.

Typ: Statement Objekt

checksum

Prüfsumme des Bots, anhand derer eine bestimmte Version der Bot-Version identifiziert wurde. $LATEST

Typ: Zeichenfolge

childDirected

Für jeden Amazon Lex-Bot, der mit dem Amazon Lex Model Building Service erstellt wurde, müssen Sie angeben, ob Ihre Nutzung von Amazon Lex mit einer Website, einem Programm oder einer anderen Anwendung zusammenhängt, die sich ganz oder teilweise an Kinder unter 13 Jahren richtet oder darauf abzielt und dem Gesetz zum Schutz der Privatsphäre von Kindern im Internet (Children's Online Privacy Protection Act, COPPA) unterliegt, indem Sie true oder false im childDirected Feld angeben. Durch die Angabe true in childDirected diesem Feld bestätigen Sie, dass Ihre Nutzung von Amazon Lex mit einer Website, einem Programm oder einer anderen Anwendung zusammenhängt, die sich ganz oder teilweise an Kinder unter 13 Jahren richtet oder darauf abzielt und der COPPA unterliegt. Durch die Angabe false in childDirected diesem Feld bestätigen Sie, dass Ihre Nutzung von Amazon Lex nicht mit einer Website, einem Programm oder einer anderen Anwendung zusammenhängt, die sich ganz oder teilweise an Kinder unter 13 Jahren richtet oder darauf abzielt und der COPPA unterliegt. Sie dürfen keinen Standardwert für das childDirected Feld angeben, der nicht genau wiedergibt, ob Ihre Nutzung von Amazon Lex mit einer Website, einem Programm oder einer anderen Anwendung zusammenhängt, die sich ganz oder teilweise an Kinder unter 13 Jahren richtet oder darauf abzielt und der COPPA unterliegt.

Wenn sich Ihre Nutzung von Amazon Lex auf eine Website, ein Programm oder eine andere Anwendung bezieht, die sich ganz oder teilweise an Kinder unter 13 Jahren richtet, müssen Sie die erforderliche nachprüfbare Zustimmung der Eltern gemäß COPPA einholen. Informationen zur Verwendung von Amazon Lex in Verbindung mit Websites, Programmen oder anderen Anwendungen, die sich ganz oder teilweise an Kinder unter 13 Jahren richten oder richten, finden Sie in den häufig gestellten Fragen zu Amazon Lex.

Typ: Boolesch

clarificationPrompt

Die Nachricht, die Amazon Lex verwendet, wenn es die Anfrage des Benutzers nicht versteht. Weitere Informationen finden Sie unter PutBot.

Typ: Prompt Objekt

createdDate

Das Datum, an dem der Bot erstellt wurde.

Typ: Zeitstempel

description

Eine Beschreibung des Bots.

Typ: Zeichenfolge

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

detectSentiment

Gibt an, ob Benutzeräußerungen zur Stimmungsanalyse an Amazon Comprehend gesendet werden sollen.

Typ: Boolesch

enableModelImprovements

Gibt an, ob der Bot Genauigkeitsverbesserungen verwendet. truegibt an, dass der Bot die Verbesserungen verwendet, andernfallsfalse.

Typ: Boolesch

failureReason

Falls status jaFAILED, erklärt Amazon Lex, warum der Bot nicht erstellt werden konnte.

Typ: Zeichenfolge

idleSessionTTLInSeconds

Die maximale Zeit in Sekunden, für die Amazon Lex die in einer Konversation gesammelten Daten aufbewahrt. Weitere Informationen finden Sie unter PutBot.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 60. Maximaler Wert von 86400.

intents

Ein Array von intent-Objekten. Weitere Informationen finden Sie unter PutBot.

Typ: Array von Intent-Objekten

lastUpdatedDate

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

Typ: Zeitstempel

locale

Das Zielgebietsschema für den Bot.

Typ: Zeichenfolge

Zulässige Werte: de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR

name

Der Name des Bots.

Typ: Zeichenfolge

Längenbeschränkungen: Mindestlänge von 2. Maximale Länge = 50 Zeichen.

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

nluIntentConfidenceThreshold

Die Punktzahl, die bestimmt, wo Amazon Lex die oder beide einfügt AMAZON.FallbackIntentAMAZON.KendraSearchIntent, wenn alternative Absichten in einer PostContentPostTextOder-Antwort zurückgegeben werden. AMAZON.FallbackIntentwird eingefügt, wenn der Konfidenzwert für alle Absichten unter diesem Wert liegt. AMAZON.KendraSearchIntentwird nur eingefügt, wenn es für den Bot konfiguriert ist.

Type: Double

Gültiger Bereich: Mindestwert 0. Maximalwert von 1.

status

Der Status des Bots.

Wenn der Status lautet, BUILDING erstellt Amazon Lex den Bot zum Testen und Verwenden.

Wenn der Status des Bots lautetREADY_BASIC_TESTING, können Sie den Bot anhand der genauen Äußerungen testen, die in den Absichten des Bots angegeben sind. Wenn der Bot für vollständige Tests oder zur Ausführung bereit ist, lautet der Status. READY

Wenn beim Erstellen des Bots ein Problem aufgetreten ist, lautet der Status FAILED und das failureReason Feld erklärt, warum der Bot nicht gebaut wurde.

Wenn der Bot gespeichert, aber nicht gebaut wurde, lautet der StatusNOT_BUILT.

Typ: Zeichenfolge

Zulässige Werte: BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT

version

Die Version des Bots. Für einen neuen Bot ist die Version immer gültig$LATEST.

Typ: Zeichenfolge

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

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

voiceId

Die Amazon Polly Polly-Sprach-ID, die Amazon Lex für die Sprachinteraktion mit dem Benutzer verwendet. Weitere Informationen finden Sie unter PutBot.

Typ: Zeichenfolge

Fehler

BadRequestException

Die Anfrage ist nicht korrekt formuliert. 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: