GetBot - Amazon Lex V1
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

如果您使用的是 Amazon Lex V2，請參閱 Amazon Lex V2 指南。

 

如果您使用的是 Amazon Lex V1，我們建議您將機器人升級到 Amazon Lex V2。我們不再向 V1 添加新功能，強烈建議所有新機器人使用 V2。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

GetBot

傳回特定機器人的中繼資料資訊。您必須提供機器人名稱以及機器人版本或別名。

這項操作需要 lex:GetBot 動作的許可。

請求語法

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

URI 請求參數

請求會使用下列 URI 參數。

name

機器人的名稱。名稱區分大小寫。

長度約束：最小長度為 2。長度上限為 50。

模式：^([A-Za-z]_?)+$

必要：是

versionoralias

機器人的版本或別名。

必要：是

請求主體

請求沒有請求主體。

回應語法

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

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

abortStatement

當使用者選擇結束對話而不完成對話時，Amazon Lex 傳回的訊息。如需詳細資訊，請參閱 PutBot。

類型：Statement 物件

checksum

用於識別機器人版本的特定修訂$LATEST版本的機器人的總和檢查碼。

類型：字串

childDirected

對於使用 Amazon Lex 模型建置服務建立的每個 Amazon Lex 機器人，您必須在childDirected欄位中指定或全部或部分針對 13 歲以下兒童並遵守《兒童線上隱私保護法》(COPPA) 的網站、程式或其他應用程式是否與全部或部分導向或鎖定目標的網站、程式true或其他應用程false式相關。透過true在childDirected欄位中指定，即表示您確認您對 Amazon Lex 的使用與針對 13 歲以下兒童且受 COPPA 規範的全部或部分針對網站、程式或其他應用程式有關。在childDirected欄位false中指定，即表示您確認您對 Amazon Lex 的使用與針對 13 歲以下兒童且受 COPPA 規範的全部或部分針對網站、程式或其他應用程式無關。您不得為欄位指定預設值，該childDirected欄位無法準確反映您對 Amazon Lex 的使用情況是否與針對 13 歲以下兒童的網站、程式或其他應用程式全部或部分針對 13 歲以下且受 COPPA 規限的網站、程式或其他應用程式有關。

如果您對 Amazon Lex 的使用涉及全部或部分針對 13 歲以下兒童的網站、程式或其他應用程式，您必須根據 COPPA 取得任何必要的可驗證父母同意。如需針對全部或部分針對 13 歲以下兒童的網站、程式或其他應用程式使用 Amazon Lex 的相關資訊，請參閱 Amazon Lex 常見問題集。

類型：布林值

clarificationPrompt

Amazon Lex 在不了解使用者要求時所使用的訊息。如需詳細資訊，請參閱 PutBot。

類型：Prompt 物件

createdDate

建立機器人的日期。

類型：Timestamp

description

機器人的描述。

類型：字串

長度限制：長度下限為 0。長度上限為 200。

detectSentiment

指出是否應將使用者語音傳送至 Amazon Comprehend 進行情緒分析。

類型：布林值

enableModelImprovements

指出機器人是否使用精確度改進。 true表示機器人正在使用改進，否則，false。

類型：布林值

failureReason

如果status是的話FAILED，Amazon Lex 會解釋為什麼無法建置機器人。

類型：字串

idleSessionTTLInSeconds

Amazon Lex 保留交談中收集之資料的時間上限 (以秒為單位)。如需詳細資訊，請參閱 PutBot。

類型：整數

有效範圍：最小值為 60。最大值為 86400。

intents

intent 物件的陣列。如需詳細資訊，請參閱 PutBot。

類型：Intent 物件陣列

lastUpdatedDate

機器人更新的日期。建立資源時，建立日期和上次更新日期相同。

類型：Timestamp

locale

機器人的目標地區設定。

類型：字串

有效值: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

機器人的名稱。

類型：字串

長度約束：最小長度為 2。長度上限為 50。

模式：^([A-Za-z]_?)+$

nluIntentConfidenceThreshold

決定 Amazon Lex 在或回PostText應中傳回替代意圖時插入AMAZON.FallbackIntentAMAZON.KendraSearchIntent、或兩者的位置的PostContent分數。 AMAZON.FallbackIntent如果所有意圖的可信度分數低於此值，則會插入。 AMAZON.KendraSearchIntent只有在為機器人配置時才會插入。

類型：Double

有效範圍：最小值為 0。最大值為 1。

status

機器人的狀態。

當狀態為 BUILDING Amazon Lex 正在建置機器人以供測試和使用時。

如果機器人的狀態是READY_BASIC_TESTING，您可以使用機器人意圖中指定的確切話語來測試機器人。當機器人已準備好進行完整測試或執行時，狀態為READY。

如果構建機器人時出現問題，則狀態為，FAILED並且該failureReason字段解釋了機器人未構建的原因。

如果機器人已儲存但未建置，則狀態為NOT_BUILT。

類型：字串

有效值:BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT

version

機器人的版本。對於新的機器人，版本始終是$LATEST。

類型：字串

長度限制：長度下限為 1。長度上限為 64。

模式：\$LATEST|[0-9]+

voiceId

亞馬遜 Lex 用於與用戶進行語音交互的 Amazon Polly 語音 ID。如需詳細資訊，請參閱 PutBot。

類型：字串

錯誤

BadRequestException

請求的格式不正確。例如，值無效或缺少必填欄位。請檢查欄位值，然後再試一次。

HTTP 狀態碼：400

InternalFailureException

發生內部 Amazon Lex 錯誤。請再次嘗試您的請求。

HTTP 狀態碼：500

LimitExceededException

請求超過限制。請再次嘗試您的請求。

HTTP 狀態碼：429

NotFoundException

找不到要求中指定的資源。請檢查資源，然後再試一次。

HTTP 狀態碼：404

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：