支援終止通知:在 2025 年 9 月 15 日, AWS 將停止對 Amazon Lex V1 的支援。2025 年 9 月 15 日之後,您將無法再存取 Amazon Lex V1 主控台或 Amazon Lex V1 資源。如果您使用的是 Amazon Lex V2,請改參閱 Amazon Lex V2 指南。
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
傳回特定機器人的中繼資料資訊。您必須提供機器人名稱和機器人版本或別名。
這項操作需要 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 Model Building Service 建立的每個 Amazon Lex 機器人,您必須指定您對 Amazon Lex 的使用是否與網站、程式或其他應用程式相關,而該網站、程式或其他應用程式全部或部分導向或針對 13 歲以下的孩童,並在
childDirected
false
欄位中指定true
或 以遵守兒童線上隱私權保護法 (COPPA)。透過true
在childDirected
欄位中指定 ,您確認 Amazon Lex 的使用與網站、程式或其他應用程式相關,而該網站、程式或其他應用程式全部或部分以 13 歲以下的孩童為目標,並受到 COPPA 的約束。透過false
在childDirected
欄位中指定 ,您確認 Amazon Lex 的使用與網站、程式或其他應用程式無關,該網站、程式或其他應用程式全部或部分針對 13 歲以下的孩童,並受 COPPA 約束。您無法為childDirected
欄位指定預設值,該值無法準確反映您對 Amazon Lex 的使用是否與網站、程式或其他應用程式相關,而該網站、程式或其他應用程式全部或部分針對或鎖定未滿 13 歲且受 COPPA 約束的 13 歲兒童。如果您使用 Amazon Lex 與全部或部分導向至 13 歲以下兒童的網站、程式或其他應用程式相關,您必須根據 COPPA 取得任何必要的可驗證父母同意。如需有關使用 Amazon Lex 與網站、程式或其他應用程式相關的資訊,這些應用程式全部或部分針對 13 歲以下的孩童,請參閱 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
-
在 PostContent 或 PostText 回應中傳回替代意圖時
AMAZON.KendraSearchIntent
,決定 Amazon Lex 插入AMAZON.FallbackIntent
、 或兩者位置的分數。如果所有意圖的可信度分數都低於此值,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
-
Amazon Lex 用來與使用者進行語音互動的 Amazon Polly 語音 ID。 Amazon Lex 如需詳細資訊,請參閱PutBot。
類型:字串
錯誤
- BadRequestException
-
請求格式不正確。例如,值無效或缺少必要欄位。請檢查欄位值,然後再試一次。
HTTP 狀態碼:400
- InternalFailureException
-
發生內部 Amazon Lex 錯誤。請再次嘗試您的請求。
HTTP 狀態碼:500
- LimitExceededException
-
請求超過限制。請再次嘗試您的請求。
HTTP 狀態碼:429
- NotFoundException
-
找不到請求中指定的資源。請檢查資源,然後再試一次。
HTTP 狀態碼:404
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: